]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/transaction_utils.rs
Expose ReadOnlyNetworkGraph::get_addresses to C by cloning result
[rust-lightning] / lightning / src / util / transaction_utils.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 use bitcoin::blockdata::transaction::{Transaction, TxOut};
11 use bitcoin::blockdata::script::Script;
12 use bitcoin::consensus::Encodable;
13 use bitcoin::consensus::encode::VarInt;
14
15 use ln::msgs::MAX_VALUE_MSAT;
16
17 use prelude::*;
18 use io_extras::sink;
19 use core::cmp::Ordering;
20
21 pub fn sort_outputs<T, C : Fn(&T, &T) -> Ordering>(outputs: &mut Vec<(TxOut, T)>, tie_breaker: C) {
22         outputs.sort_unstable_by(|a, b| {
23                 a.0.value.cmp(&b.0.value).then_with(|| {
24                         a.0.script_pubkey[..].cmp(&b.0.script_pubkey[..]).then_with(|| {
25                                 tie_breaker(&a.1, &b.1)
26                         })
27                 })
28         });
29 }
30
31 fn get_dust_value(output_script: &Script) -> u64 {
32         //TODO: This belongs in rust-bitcoin (https://github.com/rust-bitcoin/rust-bitcoin/pull/566)
33         if output_script.is_op_return() {
34                 0
35         } else if output_script.is_witness_program() {
36                 294
37         } else {
38                 546
39         }
40 }
41
42 /// Possibly adds a change output to the given transaction, always doing so if there are excess
43 /// funds available beyond the requested feerate.
44 /// Assumes at least one input will have a witness (ie spends a segwit output).
45 /// Returns an Err(()) if the requested feerate cannot be met.
46 pub(crate) fn maybe_add_change_output(tx: &mut Transaction, input_value: u64, witness_max_weight: usize, feerate_sat_per_1000_weight: u32, change_destination_script: Script) -> Result<(), ()> {
47         if input_value > MAX_VALUE_MSAT / 1000 { return Err(()); }
48
49         let mut output_value = 0;
50         for output in tx.output.iter() {
51                 output_value += output.value;
52                 if output_value >= input_value { return Err(()); }
53         }
54
55         let dust_value = get_dust_value(&change_destination_script);
56         let mut change_output = TxOut {
57                 script_pubkey: change_destination_script,
58                 value: 0,
59         };
60         let change_len = change_output.consensus_encode(&mut sink()).unwrap();
61         let mut weight_with_change: i64 = tx.get_weight() as i64 + 2 + witness_max_weight as i64 + change_len as i64 * 4;
62         // Include any extra bytes required to push an extra output.
63         weight_with_change += (VarInt(tx.output.len() as u64 + 1).len() - VarInt(tx.output.len() as u64).len()) as i64 * 4;
64         // When calculating weight, add two for the flag bytes
65         let change_value: i64 = (input_value - output_value) as i64 - weight_with_change * feerate_sat_per_1000_weight as i64 / 1000;
66         if change_value >= dust_value as i64 {
67                 change_output.value = change_value as u64;
68                 tx.output.push(change_output);
69         } else if (input_value - output_value) as i64 - (tx.get_weight() as i64 + 2 + witness_max_weight as i64) * feerate_sat_per_1000_weight as i64 / 1000 < 0 {
70                 return Err(());
71         }
72
73         Ok(())
74 }
75
76 #[cfg(test)]
77 mod tests {
78         use super::*;
79
80         use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, OutPoint};
81         use bitcoin::blockdata::script::{Script, Builder};
82         use bitcoin::hash_types::Txid;
83
84         use bitcoin::hashes::sha256d::Hash as Sha256dHash;
85
86         use hex::decode;
87
88         use alloc::vec;
89
90         #[test]
91         fn sort_output_by_value() {
92                 let txout1 = TxOut {
93                         value:  100,
94                         script_pubkey: Builder::new().push_int(0).into_script()
95                 };
96                 let txout1_ = txout1.clone();
97
98                 let txout2 = TxOut {
99                         value: 99,
100                         script_pubkey: Builder::new().push_int(0).into_script()
101                 };
102                 let txout2_ = txout2.clone();
103
104                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
105                 sort_outputs(&mut outputs, |_, _| { unreachable!(); });
106
107                 assert_eq!(
108                         &outputs,
109                         &vec![(txout2_, "ignore"), (txout1_, "ignore")]
110                         );
111         }
112
113         #[test]
114         fn sort_output_by_script_pubkey() {
115                 let txout1 = TxOut {
116                         value:  100,
117                         script_pubkey: Builder::new().push_int(3).into_script(),
118                 };
119                 let txout1_ = txout1.clone();
120
121                 let txout2 = TxOut {
122                         value: 100,
123                         script_pubkey: Builder::new().push_int(1).push_int(2).into_script()
124                 };
125                 let txout2_ = txout2.clone();
126
127                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
128                 sort_outputs(&mut outputs, |_, _| { unreachable!(); });
129
130                 assert_eq!(
131                         &outputs,
132                         &vec![(txout2_, "ignore"), (txout1_, "ignore")]
133                         );
134         }
135
136         #[test]
137         fn sort_output_by_bip_test() {
138                 let txout1 = TxOut {
139                         value: 100000000,
140                         script_pubkey: script_from_hex("41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac")
141                 };
142                 let txout1_ = txout1.clone();
143
144                 // doesn't deserialize cleanly:
145                 let txout2 = TxOut {
146                         value: 2400000000,
147                         script_pubkey: script_from_hex("41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac")
148                 };
149                 let txout2_ = txout2.clone();
150
151                 let mut outputs = vec![(txout1, "ignore"), (txout2, "ignore")];
152                 sort_outputs(&mut outputs, |_, _| { unreachable!(); });
153
154                 assert_eq!(&outputs, &vec![(txout1_, "ignore"), (txout2_, "ignore")]);
155         }
156
157         #[test]
158         fn sort_output_tie_breaker_test() {
159                 let txout1 = TxOut {
160                         value:  100,
161                         script_pubkey: Builder::new().push_int(1).push_int(2).into_script()
162                 };
163                 let txout1_ = txout1.clone();
164
165                 let txout2 = txout1.clone();
166                 let txout2_ = txout1.clone();
167
168                 let mut outputs = vec![(txout1, 420), (txout2, 69)];
169                 sort_outputs(&mut outputs, |a, b| { a.cmp(b) });
170
171                 assert_eq!(
172                         &outputs,
173                         &vec![(txout2_, 69), (txout1_, 420)]
174                 );
175         }
176
177         fn script_from_hex(hex_str: &str) -> Script {
178                 Script::from(decode(hex_str).unwrap())
179         }
180
181         macro_rules! bip_txout_tests {
182                 ($($name:ident: $value:expr,)*) => {
183                         $(
184                                 #[test]
185                                 fn $name() {
186                                         let expected_raw: Vec<(u64, &str)> = $value;
187                                         let expected: Vec<(TxOut, &str)> = expected_raw.iter()
188                                                 .map(|txout_raw| TxOut {
189                                                         value: txout_raw.0,
190                                                         script_pubkey: script_from_hex(txout_raw.1)
191                                                 }).map(|txout| (txout, "ignore"))
192                                         .collect();
193
194                                         let mut outputs = expected.clone();
195                                         outputs.reverse(); // prep it
196
197                                         // actually do the work!
198                                         sort_outputs(&mut outputs, |_, _| { unreachable!(); });
199
200                                         assert_eq!(outputs, expected);
201                                 }
202                         )*
203                 }
204         }
205
206         const TXOUT1: [(u64, &str); 2] = [
207                 (400057456, "76a9144a5fba237213a062f6f57978f796390bdcf8d01588ac"),
208                 (40000000000, "76a9145be32612930b8323add2212a4ec03c1562084f8488ac"),
209         ];
210         const TXOUT2: [(u64, &str); 2] = [
211                 (100000000, "41046a0765b5865641ce08dd39690aade26dfbf5511430ca428a3089261361cef170e3929a68aee3d8d4848b0c5111b0a37b82b86ad559fd2a745b44d8e8d9dfdc0cac"),
212                 (2400000000, "41044a656f065871a353f216ca26cef8dde2f03e8c16202d2e8ad769f02032cb86a5eb5e56842e92e19141d60a01928f8dd2c875a390f67c1f6c94cfc617c0ea45afac"),
213         ];
214         bip_txout_tests! {
215                 bip69_txout_test_1: TXOUT1.to_vec(),
216                 bip69_txout_test_2: TXOUT2.to_vec(),
217         }
218
219         #[test]
220         fn test_tx_value_overrun() {
221                 // If we have a bogus input amount or outputs valued more than inputs, we should fail
222                 let mut tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
223                         script_pubkey: Script::new(), value: 1000
224                 }] };
225                 assert!(maybe_add_change_output(&mut tx, 21_000_000_0000_0001, 0, 253, Script::new()).is_err());
226                 assert!(maybe_add_change_output(&mut tx, 400, 0, 253, Script::new()).is_err());
227                 assert!(maybe_add_change_output(&mut tx, 4000, 0, 253, Script::new()).is_ok());
228         }
229
230         #[test]
231         fn test_tx_change_edge() {
232                 // Check that we never add dust outputs
233                 let mut tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: Vec::new() };
234                 let orig_wtxid = tx.wtxid();
235                 // 9 sats isn't enough to pay fee on a dummy transaction...
236                 assert_eq!(tx.get_weight() as u64, 40); // ie 10 vbytes
237                 assert!(maybe_add_change_output(&mut tx, 9, 0, 253, Script::new()).is_err());
238                 assert_eq!(tx.wtxid(), orig_wtxid); // Failure doesn't change the transaction
239                 // but 10-564 is, just not enough to add a change output...
240                 assert!(maybe_add_change_output(&mut tx, 10, 0, 253, Script::new()).is_ok());
241                 assert_eq!(tx.output.len(), 0);
242                 assert_eq!(tx.wtxid(), orig_wtxid); // If we don't add an output, we don't change the transaction
243                 assert!(maybe_add_change_output(&mut tx, 564, 0, 253, Script::new()).is_ok());
244                 assert_eq!(tx.output.len(), 0);
245                 assert_eq!(tx.wtxid(), orig_wtxid); // If we don't add an output, we don't change the transaction
246                 // 565 is also not enough, if we anticipate 2 more weight units pushing us up to the next vbyte
247                 // (considering the two bytes for segwit flags)
248                 assert!(maybe_add_change_output(&mut tx, 565, 2, 253, Script::new()).is_ok());
249                 assert_eq!(tx.output.len(), 0);
250                 assert_eq!(tx.wtxid(), orig_wtxid); // If we don't add an output, we don't change the transaction
251                 // at 565 we can afford the change output at the dust limit (546)
252                 assert!(maybe_add_change_output(&mut tx, 565, 0, 253, Script::new()).is_ok());
253                 assert_eq!(tx.output.len(), 1);
254                 assert_eq!(tx.output[0].value, 546);
255                 assert_eq!(tx.output[0].script_pubkey, Script::new());
256                 assert_eq!(tx.get_weight() / 4, 565-546); // New weight is exactly the fee we wanted.
257
258                 tx.output.pop();
259                 assert_eq!(tx.wtxid(), orig_wtxid); // The only change is the addition of one output.
260         }
261
262         #[test]
263         fn test_tx_extra_outputs() {
264                 // Check that we correctly handle existing outputs
265                 let mut tx = Transaction { version: 2, lock_time: 0, input: vec![TxIn {
266                         previous_output: OutPoint::new(Txid::from_hash(Sha256dHash::default()), 0), script_sig: Script::new(), witness: Vec::new(), sequence: 0,
267                 }], output: vec![TxOut {
268                         script_pubkey: Builder::new().push_int(1).into_script(), value: 1000
269                 }] };
270                 let orig_wtxid = tx.wtxid();
271                 let orig_weight = tx.get_weight();
272                 assert_eq!(orig_weight / 4, 61);
273
274                 // Input value of the output value + fee - 1 should fail:
275                 assert!(maybe_add_change_output(&mut tx, 1000 + 61 + 100 - 1, 400, 250, Builder::new().push_int(2).into_script()).is_err());
276                 assert_eq!(tx.wtxid(), orig_wtxid); // Failure doesn't change the transaction
277                 // but one more input sat should succeed, without changing the transaction
278                 assert!(maybe_add_change_output(&mut tx, 1000 + 61 + 100, 400, 250, Builder::new().push_int(2).into_script()).is_ok());
279                 assert_eq!(tx.wtxid(), orig_wtxid); // If we don't add an output, we don't change the transaction
280                 // In order to get a change output, we need to add 546 plus the output's weight / 4 (10)...
281                 assert!(maybe_add_change_output(&mut tx, 1000 + 61 + 100 + 546 + 9, 400, 250, Builder::new().push_int(2).into_script()).is_ok());
282                 assert_eq!(tx.wtxid(), orig_wtxid); // If we don't add an output, we don't change the transaction
283
284                 assert!(maybe_add_change_output(&mut tx, 1000 + 61 + 100 + 546 + 10, 400, 250, Builder::new().push_int(2).into_script()).is_ok());
285                 assert_eq!(tx.output.len(), 2);
286                 assert_eq!(tx.output[1].value, 546);
287                 assert_eq!(tx.output[1].script_pubkey, Builder::new().push_int(2).into_script());
288                 assert_eq!(tx.get_weight() - orig_weight, 40); // Weight difference matches what we had to add above
289                 tx.output.pop();
290                 assert_eq!(tx.wtxid(), orig_wtxid); // The only change is the addition of one output.
291         }
292 }