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