Handle monitor update failures during funding on the funder side
[rust-lightning] / src / ln / channel.rs
1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::BitcoinHash;
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
8
9 use bitcoin_hashes::{Hash, HashEngine};
10 use bitcoin_hashes::sha256::Hash as Sha256;
11 use bitcoin_hashes::hash160::Hash as Hash160;
12 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
13
14 use secp256k1::key::{PublicKey,SecretKey};
15 use secp256k1::{Secp256k1,Signature};
16 use secp256k1;
17
18 use ln::msgs;
19 use ln::msgs::{DecodeError, OptionalField, LocalFeatures};
20 use ln::channelmonitor::ChannelMonitor;
21 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
22 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
23 use ln::chan_utils;
24 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
25 use chain::transaction::OutPoint;
26 use chain::keysinterface::{ChannelKeys, KeysInterface};
27 use util::transaction_utils;
28 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
29 use util::logger::{Logger, LogHolder};
30 use util::errors::APIError;
31 use util::config::{UserConfig,ChannelConfig};
32
33 use std;
34 use std::default::Default;
35 use std::{cmp,mem};
36 use std::sync::{Arc};
37
38 #[cfg(test)]
39 pub struct ChannelValueStat {
40         pub value_to_self_msat: u64,
41         pub channel_value_msat: u64,
42         pub channel_reserve_msat: u64,
43         pub pending_outbound_htlcs_amount_msat: u64,
44         pub pending_inbound_htlcs_amount_msat: u64,
45         pub holding_cell_outbound_amount_msat: u64,
46         pub their_max_htlc_value_in_flight_msat: u64, // outgoing
47 }
48
49 enum InboundHTLCRemovalReason {
50         FailRelay(msgs::OnionErrorPacket),
51         FailMalformed(([u8; 32], u16)),
52         Fulfill(PaymentPreimage),
53 }
54
55 enum InboundHTLCState {
56         /// Added by remote, to be included in next local commitment tx.
57         RemoteAnnounced(PendingHTLCStatus),
58         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
59         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
60         /// accept this HTLC. Implies AwaitingRemoteRevoke.
61         /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
62         /// a remote revoke_and_ack on a previous state before we can do so.
63         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
64         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
65         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
66         /// accept this HTLC. Implies AwaitingRemoteRevoke.
67         /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
68         /// revoke_and_ack.
69         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
70         Committed,
71         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
72         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
73         /// we'll drop it.
74         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
75         /// commitment transaction without it as otherwise we'll have to force-close the channel to
76         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
77         /// anyway). That said, ChannelMonitor does this for us (see
78         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
79         /// local state before then, once we're sure that the next commitment_signed and
80         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
81         LocalRemoved(InboundHTLCRemovalReason),
82 }
83
84 struct InboundHTLCOutput {
85         htlc_id: u64,
86         amount_msat: u64,
87         cltv_expiry: u32,
88         payment_hash: PaymentHash,
89         state: InboundHTLCState,
90 }
91
92 enum OutboundHTLCState {
93         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
94         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
95         /// we will promote to Committed (note that they may not accept it until the next time we
96         /// revoke, but we don't really care about that:
97         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
98         ///    money back (though we won't), and,
99         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
100         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
101         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
102         ///    we'll never get out of sync).
103         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
104         /// OutboundHTLCOutput's size just for a temporary bit
105         LocalAnnounced(Box<msgs::OnionPacket>),
106         Committed,
107         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
108         /// the change (though they'll need to revoke before we fail the payment).
109         RemoteRemoved(Option<HTLCFailReason>),
110         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
111         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
113         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
114         /// remote revoke_and_ack on a previous state before we can do so.
115         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
116         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
117         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
119         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
120         /// revoke_and_ack to drop completely.
121         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
122 }
123
124 struct OutboundHTLCOutput {
125         htlc_id: u64,
126         amount_msat: u64,
127         cltv_expiry: u32,
128         payment_hash: PaymentHash,
129         state: OutboundHTLCState,
130         source: HTLCSource,
131 }
132
133 /// See AwaitingRemoteRevoke ChannelState for more info
134 enum HTLCUpdateAwaitingACK {
135         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
136                 // always outbound
137                 amount_msat: u64,
138                 cltv_expiry: u32,
139                 payment_hash: PaymentHash,
140                 source: HTLCSource,
141                 onion_routing_packet: msgs::OnionPacket,
142         },
143         ClaimHTLC {
144                 payment_preimage: PaymentPreimage,
145                 htlc_id: u64,
146         },
147         FailHTLC {
148                 htlc_id: u64,
149                 err_packet: msgs::OnionErrorPacket,
150         },
151 }
152
153 /// There are a few "states" and then a number of flags which can be applied:
154 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
155 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
156 /// move on to ChannelFunded.
157 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
158 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
159 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
160 enum ChannelState {
161         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
162         OurInitSent = (1 << 0),
163         /// Implies we have received their open_channel/accept_channel message
164         TheirInitSent = (1 << 1),
165         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
166         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
167         /// upon receipt of funding_created, so simply skip this state.
168         FundingCreated = 4,
169         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
170         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
171         /// and our counterparty consider the funding transaction confirmed.
172         FundingSent = 8,
173         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
174         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
175         TheirFundingLocked = (1 << 4),
176         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
177         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
178         OurFundingLocked = (1 << 5),
179         ChannelFunded = 64,
180         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
181         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
182         /// dance.
183         PeerDisconnected = (1 << 7),
184         /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
185         /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
186         /// messages until they've managed to do so.
187         MonitorUpdateFailed = (1 << 8),
188         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
189         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
190         /// messages as then we will be unable to determine which HTLCs they included in their
191         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
192         /// later.
193         /// Flag is set on ChannelFunded.
194         AwaitingRemoteRevoke = (1 << 9),
195         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
196         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
197         /// to respond with our own shutdown message when possible.
198         RemoteShutdownSent = (1 << 10),
199         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
200         /// point, we may not add any new HTLCs to the channel.
201         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
202         /// us their shutdown.
203         LocalShutdownSent = (1 << 11),
204         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
205         /// to drop us, but we store this anyway.
206         ShutdownComplete = 4096,
207 }
208 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
209 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
210
211 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
212
213 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
214 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
215 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
216 // inbound channel.
217 pub(super) struct Channel {
218         config: ChannelConfig,
219
220         user_id: u64,
221
222         channel_id: [u8; 32],
223         channel_state: u32,
224         channel_outbound: bool,
225         secp_ctx: Secp256k1<secp256k1::All>,
226         channel_value_satoshis: u64,
227
228         local_keys: ChannelKeys,
229         shutdown_pubkey: PublicKey,
230
231         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
232         // generation start at 0 and count up...this simplifies some parts of implementation at the
233         // cost of others, but should really just be changed.
234
235         cur_local_commitment_transaction_number: u64,
236         cur_remote_commitment_transaction_number: u64,
237         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
238         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
239         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
240         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
241
242         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
243         /// need to ensure we resend them in the order we originally generated them. Note that because
244         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
245         /// sufficient to simply set this to the opposite of any message we are generating as we
246         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
247         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
248         /// send it first.
249         resend_order: RAACommitmentOrder,
250
251         monitor_pending_revoke_and_ack: bool,
252         monitor_pending_commitment_signed: bool,
253         monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
254         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
255
256         // pending_update_fee is filled when sending and receiving update_fee
257         // For outbound channel, feerate_per_kw is updated with the value from
258         // pending_update_fee when revoke_and_ack is received
259         //
260         // For inbound channel, feerate_per_kw is updated when it receives
261         // commitment_signed and revoke_and_ack is generated
262         // The pending value is kept when another pair of update_fee and commitment_signed
263         // is received during AwaitingRemoteRevoke and relieved when the expected
264         // revoke_and_ack is received and new commitment_signed is generated to be
265         // sent to the funder. Otherwise, the pending value is removed when receiving
266         // commitment_signed.
267         pending_update_fee: Option<u64>,
268         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
269         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
270         // is received. holding_cell_update_fee is updated when there are additional
271         // update_fee() during ChannelState::AwaitingRemoteRevoke.
272         holding_cell_update_fee: Option<u64>,
273         next_local_htlc_id: u64,
274         next_remote_htlc_id: u64,
275         channel_update_count: u32,
276         feerate_per_kw: u64,
277
278         #[cfg(debug_assertions)]
279         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
280         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
281         #[cfg(debug_assertions)]
282         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
283         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
284
285         #[cfg(test)]
286         // Used in ChannelManager's tests to send a revoked transaction
287         pub last_local_commitment_txn: Vec<Transaction>,
288         #[cfg(not(test))]
289         last_local_commitment_txn: Vec<Transaction>,
290
291         last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
292
293         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
294         /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
295         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
296         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
297         funding_tx_confirmed_in: Option<Sha256dHash>,
298         short_channel_id: Option<u64>,
299         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
300         /// ChannelManager deserialization (hence pub(super))
301         pub(super) last_block_connected: Sha256dHash,
302         funding_tx_confirmations: u64,
303
304         their_dust_limit_satoshis: u64,
305         #[cfg(test)]
306         pub(super) our_dust_limit_satoshis: u64,
307         #[cfg(not(test))]
308         our_dust_limit_satoshis: u64,
309         #[cfg(test)]
310         pub(super) their_max_htlc_value_in_flight_msat: u64,
311         #[cfg(not(test))]
312         their_max_htlc_value_in_flight_msat: u64,
313         //get_our_max_htlc_value_in_flight_msat(): u64,
314         /// minimum channel reserve for **self** to maintain - set by them.
315         their_channel_reserve_satoshis: u64,
316         //get_our_channel_reserve_satoshis(): u64,
317         their_htlc_minimum_msat: u64,
318         our_htlc_minimum_msat: u64,
319         their_to_self_delay: u16,
320         our_to_self_delay: u16,
321         #[cfg(test)]
322         pub their_max_accepted_htlcs: u16,
323         #[cfg(not(test))]
324         their_max_accepted_htlcs: u16,
325         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
326         minimum_depth: u32,
327
328         their_funding_pubkey: Option<PublicKey>,
329         their_revocation_basepoint: Option<PublicKey>,
330         their_payment_basepoint: Option<PublicKey>,
331         their_delayed_payment_basepoint: Option<PublicKey>,
332         their_htlc_basepoint: Option<PublicKey>,
333         their_cur_commitment_point: Option<PublicKey>,
334
335         their_prev_commitment_point: Option<PublicKey>,
336         their_node_id: PublicKey,
337
338         their_shutdown_scriptpubkey: Option<Script>,
339
340         channel_monitor: ChannelMonitor,
341
342         logger: Arc<Logger>,
343 }
344
345 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
346 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
347 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
348 /// really allow for this, so instead we're stuck closing it out at that point.
349 const UNCONF_THRESHOLD: u32 = 6;
350 /// Exposing these two constants for use in test in ChannelMonitor
351 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
352 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
353 const SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT: u64 = 79; // prevout: 36, nSequence: 4, script len: 1, witness lengths: (3+1)/4, sig: 73/4, if-selector: 1, redeemScript: (6 ops + 2*33 pubkeys + 1*2 delay)/4
354 const B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT: u64 = 104; // prevout: 40, nSequence: 4, script len: 1, witness lengths: 3/4, sig: 73/4, pubkey: 33/4, output: 31 (TODO: Wrong? Useless?)
355 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
356 /// it's 2^24.
357 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
358
359 #[cfg(test)]
360 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
361 #[cfg(not(test))]
362 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 139;
363 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
364
365 /// Used to return a simple Error back to ChannelManager. Will get converted to a
366 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
367 /// channel_id in ChannelManager.
368 #[derive(Debug)]
369 pub(super) enum ChannelError {
370         Ignore(&'static str),
371         Close(&'static str),
372 }
373
374 macro_rules! secp_check {
375         ($res: expr, $err: expr) => {
376                 match $res {
377                         Ok(thing) => thing,
378                         Err(_) => return Err(ChannelError::Close($err)),
379                 }
380         };
381 }
382
383 impl Channel {
384         // Convert constants + channel value to limits:
385         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
386                 channel_value_satoshis * 1000 / 10 //TODO
387         }
388
389         /// Returns a minimum channel reserve value **they** need to maintain
390         ///
391         /// Guaranteed to return a value no larger than channel_value_satoshis
392         fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
393                 let (q, _) = channel_value_satoshis.overflowing_div(100);
394                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
395         }
396
397         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
398                 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
399         }
400
401         fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
402                 1000 // TODO
403         }
404
405         // Constructors:
406         pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
407                 let chan_keys = keys_provider.get_channel_keys(false);
408
409                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
410                         return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
411                 }
412
413                 if push_msat > channel_value_satoshis * 1000 {
414                         return Err(APIError::APIMisuseError{err: "push value > channel value"});
415                 }
416                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
417                         return Err(APIError::APIMisuseError{err: "Configured with an unreasonable our_to_self_delay putting user funds at risks"});
418                 }
419
420
421                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
422                 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
423                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
424                 }
425
426                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
427
428                 let secp_ctx = Secp256k1::new();
429                 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
430                                                           &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), config.own_channel_config.our_to_self_delay,
431                                                           keys_provider.get_destination_script(), logger.clone());
432
433                 Ok(Channel {
434                         user_id: user_id,
435                         config: config.channel_options.clone(),
436
437                         channel_id: keys_provider.get_channel_id(),
438                         channel_state: ChannelState::OurInitSent as u32,
439                         channel_outbound: true,
440                         secp_ctx: secp_ctx,
441                         channel_value_satoshis: channel_value_satoshis,
442
443                         local_keys: chan_keys,
444                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
445                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
446                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
447                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
448
449                         pending_inbound_htlcs: Vec::new(),
450                         pending_outbound_htlcs: Vec::new(),
451                         holding_cell_htlc_updates: Vec::new(),
452                         pending_update_fee: None,
453                         holding_cell_update_fee: None,
454                         next_local_htlc_id: 0,
455                         next_remote_htlc_id: 0,
456                         channel_update_count: 1,
457
458                         resend_order: RAACommitmentOrder::CommitmentFirst,
459
460                         monitor_pending_revoke_and_ack: false,
461                         monitor_pending_commitment_signed: false,
462                         monitor_pending_forwards: Vec::new(),
463                         monitor_pending_failures: Vec::new(),
464
465                         #[cfg(debug_assertions)]
466                         max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
467                         #[cfg(debug_assertions)]
468                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
469
470                         last_local_commitment_txn: Vec::new(),
471
472                         last_sent_closing_fee: None,
473
474                         funding_tx_confirmed_in: None,
475                         short_channel_id: None,
476                         last_block_connected: Default::default(),
477                         funding_tx_confirmations: 0,
478
479                         feerate_per_kw: feerate,
480                         their_dust_limit_satoshis: 0,
481                         our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
482                         their_max_htlc_value_in_flight_msat: 0,
483                         their_channel_reserve_satoshis: 0,
484                         their_htlc_minimum_msat: 0,
485                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
486                         their_to_self_delay: 0,
487                         our_to_self_delay: config.own_channel_config.our_to_self_delay,
488                         their_max_accepted_htlcs: 0,
489                         minimum_depth: 0, // Filled in in accept_channel
490
491                         their_funding_pubkey: None,
492                         their_revocation_basepoint: None,
493                         their_payment_basepoint: None,
494                         their_delayed_payment_basepoint: None,
495                         their_htlc_basepoint: None,
496                         their_cur_commitment_point: None,
497
498                         their_prev_commitment_point: None,
499                         their_node_id: their_node_id,
500
501                         their_shutdown_scriptpubkey: None,
502
503                         channel_monitor: channel_monitor,
504
505                         logger,
506                 })
507         }
508
509         fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
510                 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
511                         return Err(ChannelError::Close("Peer's feerate much too low"));
512                 }
513                 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
514                         return Err(ChannelError::Close("Peer's feerate much too high"));
515                 }
516                 Ok(())
517         }
518
519         /// Creates a new channel from a remote sides' request for one.
520         /// Assumes chain_hash has already been checked and corresponds with what we expect!
521         pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, their_local_features: LocalFeatures, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
522                 let chan_keys = keys_provider.get_channel_keys(true);
523                 let mut local_config = (*config).channel_options.clone();
524
525                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
526                         return Err(ChannelError::Close("Configured with an unreasonable our_to_self_delay putting user funds at risks"));
527                 }
528
529                 // Check sanity of message fields:
530                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
531                         return Err(ChannelError::Close("funding value > 2^24"));
532                 }
533                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
534                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
535                 }
536                 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
537                         return Err(ChannelError::Close("push_msat larger than funding value"));
538                 }
539                 if msg.dust_limit_satoshis > msg.funding_satoshis {
540                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
541                 }
542                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
543                         return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
544                 }
545                 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
546                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
547                 }
548                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
549
550                 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
551                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
552                 }
553                 if msg.max_accepted_htlcs < 1 {
554                         return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
555                 }
556                 if msg.max_accepted_htlcs > 483 {
557                         return Err(ChannelError::Close("max_accpted_htlcs > 483"));
558                 }
559
560                 // Now check against optional parameters as set by config...
561                 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
562                         return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
563                 }
564                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
565                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
566                 }
567                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
568                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
569                 }
570                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
571                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
572                 }
573                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
574                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
575                 }
576                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
577                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
578                 }
579                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
580                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
581                 }
582
583                 // Convert things into internal flags and prep our state:
584
585                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
586                 if config.peer_channel_config_limits.force_announced_channel_preference {
587                         if local_config.announced_channel != their_announce {
588                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
589                         }
590                 }
591                 // we either accept their preference or the preferences match
592                 local_config.announced_channel = their_announce;
593
594                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
595
596                 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
597                 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
598                 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
599                         return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
600                 }
601                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
602                         return Err(ChannelError::Close("channel_reserve_satoshis too small"));
603                 }
604                 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
605                         return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
606                 }
607
608                 // check if the funder's amount for the initial commitment tx is sufficient
609                 // for full fee payment
610                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
611                 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
612                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
613                 }
614
615                 let to_local_msat = msg.push_msat;
616                 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
617                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
618                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
619                 }
620
621                 let secp_ctx = Secp256k1::new();
622                 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
623                                                               &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), config.own_channel_config.our_to_self_delay,
624                                                               keys_provider.get_destination_script(), logger.clone());
625                 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
626                 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
627
628                 let their_shutdown_scriptpubkey = if their_local_features.supports_upfront_shutdown_script() {
629                         match &msg.shutdown_scriptpubkey {
630                                 &OptionalField::Present(ref script) => {
631                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
632                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
633                                                 Some(script.clone())
634                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
635                                         } else if script.len() == 0 {
636                                                 None
637                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
638                                         } else {
639                                                 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
640                                         }
641                                 },
642                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
643                                 &OptionalField::Absent => {
644                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
645                                 }
646                         }
647                 } else { None };
648
649                 let mut chan = Channel {
650                         user_id: user_id,
651                         config: local_config,
652
653                         channel_id: msg.temporary_channel_id,
654                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
655                         channel_outbound: false,
656                         secp_ctx: secp_ctx,
657
658                         local_keys: chan_keys,
659                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
660                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
661                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
662                         value_to_self_msat: msg.push_msat,
663
664                         pending_inbound_htlcs: Vec::new(),
665                         pending_outbound_htlcs: Vec::new(),
666                         holding_cell_htlc_updates: Vec::new(),
667                         pending_update_fee: None,
668                         holding_cell_update_fee: None,
669                         next_local_htlc_id: 0,
670                         next_remote_htlc_id: 0,
671                         channel_update_count: 1,
672
673                         resend_order: RAACommitmentOrder::CommitmentFirst,
674
675                         monitor_pending_revoke_and_ack: false,
676                         monitor_pending_commitment_signed: false,
677                         monitor_pending_forwards: Vec::new(),
678                         monitor_pending_failures: Vec::new(),
679
680                         #[cfg(debug_assertions)]
681                         max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
682                         #[cfg(debug_assertions)]
683                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
684
685                         last_local_commitment_txn: Vec::new(),
686
687                         last_sent_closing_fee: None,
688
689                         funding_tx_confirmed_in: None,
690                         short_channel_id: None,
691                         last_block_connected: Default::default(),
692                         funding_tx_confirmations: 0,
693
694                         feerate_per_kw: msg.feerate_per_kw as u64,
695                         channel_value_satoshis: msg.funding_satoshis,
696                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
697                         our_dust_limit_satoshis: our_dust_limit_satoshis,
698                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
699                         their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
700                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
701                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
702                         their_to_self_delay: msg.to_self_delay,
703                         our_to_self_delay: config.own_channel_config.our_to_self_delay,
704                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
705                         minimum_depth: config.own_channel_config.minimum_depth,
706
707                         their_funding_pubkey: Some(msg.funding_pubkey),
708                         their_revocation_basepoint: Some(msg.revocation_basepoint),
709                         their_payment_basepoint: Some(msg.payment_basepoint),
710                         their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
711                         their_htlc_basepoint: Some(msg.htlc_basepoint),
712                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
713
714                         their_prev_commitment_point: None,
715                         their_node_id: their_node_id,
716
717                         their_shutdown_scriptpubkey,
718
719                         channel_monitor: channel_monitor,
720
721                         logger,
722                 };
723
724                 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
725                 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
726
727                 Ok(chan)
728         }
729
730         // Utilities to derive keys:
731
732         fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
733                 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
734                 SecretKey::from_slice(&res).unwrap()
735         }
736
737         // Utilities to build transactions:
738
739         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
740                 let mut sha = Sha256::engine();
741                 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
742
743                 if self.channel_outbound {
744                         sha.input(&our_payment_basepoint.serialize());
745                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
746                 } else {
747                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
748                         sha.input(&our_payment_basepoint.serialize());
749                 }
750                 let res = Sha256::from_engine(sha).into_inner();
751
752                 ((res[26] as u64) << 5*8) |
753                 ((res[27] as u64) << 4*8) |
754                 ((res[28] as u64) << 3*8) |
755                 ((res[29] as u64) << 2*8) |
756                 ((res[30] as u64) << 1*8) |
757                 ((res[31] as u64) << 0*8)
758         }
759
760         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
761         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
762         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
763         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
764         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
765         /// an HTLC to a).
766         /// @local is used only to convert relevant internal structures which refer to remote vs local
767         /// to decide value of outputs and direction of HTLCs.
768         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
769         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
770         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
771         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
772         /// which peer generated this transaction and "to whom" this transaction flows.
773         /// Returns (the transaction built, the number of HTLC outputs which were present in the
774         /// transaction, the list of HTLCs which were not ignored when building the transaction).
775         /// Note that below-dust HTLCs are included in the third return value, but not the second, and
776         /// sources are provided only for outbound HTLCs in the third return value.
777         #[inline]
778         fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
779                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
780
781                 let txins = {
782                         let mut ins: Vec<TxIn> = Vec::new();
783                         ins.push(TxIn {
784                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
785                                 script_sig: Script::new(),
786                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
787                                 witness: Vec::new(),
788                         });
789                         ins
790                 };
791
792                 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
793                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
794
795                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
796                 let mut remote_htlc_total_msat = 0;
797                 let mut local_htlc_total_msat = 0;
798                 let mut value_to_self_msat_offset = 0;
799
800                 log_trace!(self, "Building commitment transaction number {} for {}, generated by {} with fee {}...", commitment_number, if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
801
802                 macro_rules! get_htlc_in_commitment {
803                         ($htlc: expr, $offered: expr) => {
804                                 HTLCOutputInCommitment {
805                                         offered: $offered,
806                                         amount_msat: $htlc.amount_msat,
807                                         cltv_expiry: $htlc.cltv_expiry,
808                                         payment_hash: $htlc.payment_hash,
809                                         transaction_output_index: None
810                                 }
811                         }
812                 }
813
814                 macro_rules! add_htlc_output {
815                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
816                                 if $outbound == local { // "offered HTLC output"
817                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
818                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
819                                                 log_trace!(self, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
820                                                 txouts.push((TxOut {
821                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
822                                                         value: $htlc.amount_msat / 1000
823                                                 }, Some((htlc_in_tx, $source))));
824                                         } else {
825                                                 log_trace!(self, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
826                                                 included_dust_htlcs.push((htlc_in_tx, $source));
827                                         }
828                                 } else {
829                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
830                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
831                                                 log_trace!(self, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
832                                                 txouts.push((TxOut { // "received HTLC output"
833                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
834                                                         value: $htlc.amount_msat / 1000
835                                                 }, Some((htlc_in_tx, $source))));
836                                         } else {
837                                                 log_trace!(self, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
838                                                 included_dust_htlcs.push((htlc_in_tx, $source));
839                                         }
840                                 }
841                         }
842                 }
843
844                 for ref htlc in self.pending_inbound_htlcs.iter() {
845                         let (include, state_name) = match htlc.state {
846                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
847                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
848                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
849                                 InboundHTLCState::Committed => (true, "Committed"),
850                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
851                         };
852
853                         if include {
854                                 add_htlc_output!(htlc, false, None, state_name);
855                                 remote_htlc_total_msat += htlc.amount_msat;
856                         } else {
857                                 log_trace!(self, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
858                                 match &htlc.state {
859                                         &InboundHTLCState::LocalRemoved(ref reason) => {
860                                                 if generated_by_local {
861                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
862                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
863                                                         }
864                                                 }
865                                         },
866                                         _ => {},
867                                 }
868                         }
869                 }
870
871                 for ref htlc in self.pending_outbound_htlcs.iter() {
872                         let (include, state_name) = match htlc.state {
873                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
874                                 OutboundHTLCState::Committed => (true, "Committed"),
875                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
876                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
877                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
878                         };
879
880                         if include {
881                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
882                                 local_htlc_total_msat += htlc.amount_msat;
883                         } else {
884                                 log_trace!(self, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
885                                 match htlc.state {
886                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
887                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
888                                         },
889                                         OutboundHTLCState::RemoteRemoved(None) => {
890                                                 if !generated_by_local {
891                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
892                                                 }
893                                         },
894                                         _ => {},
895                                 }
896                         }
897                 }
898
899                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
900                 assert!(value_to_self_msat >= 0);
901                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
902                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
903                 // "violate" their reserve value by couting those against it. Thus, we have to convert
904                 // everything to i64 before subtracting as otherwise we can overflow.
905                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
906                 assert!(value_to_remote_msat >= 0);
907
908                 #[cfg(debug_assertions)]
909                 {
910                         // Make sure that the to_self/to_remote is always either past the appropriate
911                         // channel_reserve *or* it is making progress towards it.
912                         // TODO: This should happen after fee calculation, but we don't handle that correctly
913                         // yet!
914                         let mut max_commitment_tx_output = if generated_by_local {
915                                 self.max_commitment_tx_output_local.lock().unwrap()
916                         } else {
917                                 self.max_commitment_tx_output_remote.lock().unwrap()
918                         };
919                         debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
920                         max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
921                         debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
922                         max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
923                 }
924
925                 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
926                 let (value_to_self, value_to_remote) = if self.channel_outbound {
927                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
928                 } else {
929                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
930                 };
931
932                 let value_to_a = if local { value_to_self } else { value_to_remote };
933                 let value_to_b = if local { value_to_remote } else { value_to_self };
934
935                 if value_to_a >= (dust_limit_satoshis as i64) {
936                         log_trace!(self, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
937                         txouts.push((TxOut {
938                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
939                                                                                        if local { self.their_to_self_delay } else { self.our_to_self_delay },
940                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
941                                 value: value_to_a as u64
942                         }, None));
943                 }
944
945                 if value_to_b >= (dust_limit_satoshis as i64) {
946                         log_trace!(self, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
947                         txouts.push((TxOut {
948                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
949                                                              .push_slice(&Hash160::hash(&keys.b_payment_key.serialize())[..])
950                                                              .into_script(),
951                                 value: value_to_b as u64
952                         }, None));
953                 }
954
955                 transaction_utils::sort_outputs(&mut txouts, |a, b| {
956                         if let &Some(ref a_htlc) = a {
957                                 if let &Some(ref b_htlc) = b {
958                                         a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
959                                                 // Note that due to hash collisions, we have to have a fallback comparison
960                                                 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
961                                                 // may fail)!
962                                                 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
963                                 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
964                                 // close the channel due to mismatches - they're doing something dumb:
965                                 } else { cmp::Ordering::Equal }
966                         } else { cmp::Ordering::Equal }
967                 });
968
969                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
970                 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
971                 for (idx, mut out) in txouts.drain(..).enumerate() {
972                         outputs.push(out.0);
973                         if let Some((mut htlc, source_option)) = out.1.take() {
974                                 htlc.transaction_output_index = Some(idx as u32);
975                                 htlcs_included.push((htlc, source_option));
976                         }
977                 }
978                 let non_dust_htlc_count = htlcs_included.len();
979                 htlcs_included.append(&mut included_dust_htlcs);
980
981                 (Transaction {
982                         version: 2,
983                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
984                         input: txins,
985                         output: outputs,
986                 }, non_dust_htlc_count, htlcs_included)
987         }
988
989         #[inline]
990         fn get_closing_scriptpubkey(&self) -> Script {
991                 let our_channel_close_key_hash = Hash160::hash(&self.shutdown_pubkey.serialize());
992                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
993         }
994
995         #[inline]
996         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
997                 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
998         }
999
1000         #[inline]
1001         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1002                 let txins = {
1003                         let mut ins: Vec<TxIn> = Vec::new();
1004                         ins.push(TxIn {
1005                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
1006                                 script_sig: Script::new(),
1007                                 sequence: 0xffffffff,
1008                                 witness: Vec::new(),
1009                         });
1010                         ins
1011                 };
1012
1013                 assert!(self.pending_inbound_htlcs.is_empty());
1014                 assert!(self.pending_outbound_htlcs.is_empty());
1015                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1016
1017                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1018                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1019                 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
1020
1021                 if value_to_self < 0 {
1022                         assert!(self.channel_outbound);
1023                         total_fee_satoshis += (-value_to_self) as u64;
1024                 } else if value_to_remote < 0 {
1025                         assert!(!self.channel_outbound);
1026                         total_fee_satoshis += (-value_to_remote) as u64;
1027                 }
1028
1029                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1030                         txouts.push((TxOut {
1031                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1032                                 value: value_to_remote as u64
1033                         }, ()));
1034                 }
1035
1036                 if value_to_self as u64 > self.our_dust_limit_satoshis {
1037                         txouts.push((TxOut {
1038                                 script_pubkey: self.get_closing_scriptpubkey(),
1039                                 value: value_to_self as u64
1040                         }, ()));
1041                 }
1042
1043                 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1044
1045                 let mut outputs: Vec<TxOut> = Vec::new();
1046                 for out in txouts.drain(..) {
1047                         outputs.push(out.0);
1048                 }
1049
1050                 (Transaction {
1051                         version: 2,
1052                         lock_time: 0,
1053                         input: txins,
1054                         output: outputs,
1055                 }, total_fee_satoshis)
1056         }
1057
1058         #[inline]
1059         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1060         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1061         /// our counterparty!)
1062         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1063         /// TODO Some magic rust shit to compile-time check this?
1064         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1065                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1066                 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1067                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1068
1069                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), "Local tx keys generation got bogus keys"))
1070         }
1071
1072         #[inline]
1073         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1074         /// will sign and send to our counterparty.
1075         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1076         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1077                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1078                 //may see payments to it!
1079                 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1080                 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1081                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1082
1083                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1084         }
1085
1086         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1087         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1088         /// Panics if called before accept_channel/new_from_req
1089         pub fn get_funding_redeemscript(&self) -> Script {
1090                 let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
1091                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1092                 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1093                 if our_funding_key[..] < their_funding_key[..] {
1094                         builder.push_slice(&our_funding_key)
1095                                 .push_slice(&their_funding_key)
1096                 } else {
1097                         builder.push_slice(&their_funding_key)
1098                                 .push_slice(&our_funding_key)
1099                 }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
1100         }
1101
1102         fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1103                 if tx.input.len() != 1 {
1104                         panic!("Tried to sign commitment transaction that had input count != 1!");
1105                 }
1106                 if tx.input[0].witness.len() != 0 {
1107                         panic!("Tried to re-sign commitment transaction");
1108                 }
1109
1110                 let funding_redeemscript = self.get_funding_redeemscript();
1111
1112                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
1113                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1114
1115                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1116
1117                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1118                 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1119                 if our_funding_key[..] < their_funding_key[..] {
1120                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1121                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1122                 } else {
1123                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1124                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1125                 }
1126                 tx.input[0].witness[1].push(SigHashType::All as u8);
1127                 tx.input[0].witness[2].push(SigHashType::All as u8);
1128
1129                 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1130
1131                 our_sig
1132         }
1133
1134         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1135         /// @local is used only to convert relevant internal structures which refer to remote vs local
1136         /// to decide value of outputs and direction of HTLCs.
1137         fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1138                 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { self.our_to_self_delay }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1139         }
1140
1141         fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), ChannelError> {
1142                 if tx.input.len() != 1 {
1143                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1144                 }
1145
1146                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1147
1148                 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
1149                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1150                 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1151                 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1152         }
1153
1154         /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1155         /// HTLC-Success transaction (ie htlc.offered is false), preimage must be set!
1156         fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<PaymentPreimage>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, ChannelError> {
1157                 if tx.input.len() != 1 {
1158                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1159                 }
1160                 if tx.input[0].witness.len() != 0 {
1161                         panic!("Tried to re-sign HTLC transaction");
1162                 }
1163
1164                 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1165
1166                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1167
1168                 if local_tx { // b, then a
1169                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1170                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1171                 } else {
1172                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1173                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1174                 }
1175                 tx.input[0].witness[1].push(SigHashType::All as u8);
1176                 tx.input[0].witness[2].push(SigHashType::All as u8);
1177
1178                 if htlc.offered {
1179                         tx.input[0].witness.push(Vec::new());
1180                 } else {
1181                         tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1182                 }
1183
1184                 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1185
1186                 Ok(our_sig)
1187         }
1188
1189         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1190         /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1191         /// Ok(_) if debug assertions are turned on and preconditions are met.
1192         fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), ChannelError> {
1193                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1194                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1195                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1196                 // either.
1197                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1198                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1199                 }
1200                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1201
1202                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1203
1204                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1205                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1206                 // these, but for now we just have to treat them as normal.
1207
1208                 let mut pending_idx = std::usize::MAX;
1209                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1210                         if htlc.htlc_id == htlc_id_arg {
1211                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1212                                 match htlc.state {
1213                                         InboundHTLCState::Committed => {},
1214                                         InboundHTLCState::LocalRemoved(ref reason) => {
1215                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1216                                                 } else {
1217                                                         log_warn!(self, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1218                                                 }
1219                                                 return Ok((None, None));
1220                                         },
1221                                         _ => {
1222                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1223                                                 // Don't return in release mode here so that we can update channel_monitor
1224                                         }
1225                                 }
1226                                 pending_idx = idx;
1227                                 break;
1228                         }
1229                 }
1230                 if pending_idx == std::usize::MAX {
1231                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1232                 }
1233
1234                 // Now update local state:
1235                 //
1236                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1237                 // can claim it even if the channel hits the chain before we see their next commitment.
1238                 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1239
1240                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1241                         for pending_update in self.holding_cell_htlc_updates.iter() {
1242                                 match pending_update {
1243                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1244                                                 if htlc_id_arg == htlc_id {
1245                                                         return Ok((None, None));
1246                                                 }
1247                                         },
1248                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1249                                                 if htlc_id_arg == htlc_id {
1250                                                         log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1251                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1252                                                         // rare enough it may not be worth the complexity burden.
1253                                                         return Ok((None, Some(self.channel_monitor.clone())));
1254                                                 }
1255                                         },
1256                                         _ => {}
1257                                 }
1258                         }
1259                         log_trace!(self, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1260                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1261                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1262                         });
1263                         return Ok((None, Some(self.channel_monitor.clone())));
1264                 }
1265
1266                 {
1267                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1268                         if let InboundHTLCState::Committed = htlc.state {
1269                         } else {
1270                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1271                                 return Ok((None, Some(self.channel_monitor.clone())));
1272                         }
1273                         log_trace!(self, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1274                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1275                 }
1276
1277                 Ok((Some(msgs::UpdateFulfillHTLC {
1278                         channel_id: self.channel_id(),
1279                         htlc_id: htlc_id_arg,
1280                         payment_preimage: payment_preimage_arg,
1281                 }), Some(self.channel_monitor.clone())))
1282         }
1283
1284         pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), ChannelError> {
1285                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1286                         (Some(update_fulfill_htlc), _) => {
1287                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1288                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1289                         },
1290                         (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1291                         (None, None) => Ok((None, None))
1292                 }
1293         }
1294
1295         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1296         /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1297         /// Ok(_) if debug assertions are turned on and preconditions are met.
1298         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1299                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1300                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1301                 }
1302                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1303
1304                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1305                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1306                 // these, but for now we just have to treat them as normal.
1307
1308                 let mut pending_idx = std::usize::MAX;
1309                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1310                         if htlc.htlc_id == htlc_id_arg {
1311                                 match htlc.state {
1312                                         InboundHTLCState::Committed => {},
1313                                         InboundHTLCState::LocalRemoved(_) => {
1314                                                 return Ok(None);
1315                                         },
1316                                         _ => {
1317                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1318                                                 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1319                                         }
1320                                 }
1321                                 pending_idx = idx;
1322                         }
1323                 }
1324                 if pending_idx == std::usize::MAX {
1325                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1326                 }
1327
1328                 // Now update local state:
1329                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1330                         for pending_update in self.holding_cell_htlc_updates.iter() {
1331                                 match pending_update {
1332                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1333                                                 if htlc_id_arg == htlc_id {
1334                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1335                                                 }
1336                                         },
1337                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1338                                                 if htlc_id_arg == htlc_id {
1339                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1340                                                 }
1341                                         },
1342                                         _ => {}
1343                                 }
1344                         }
1345                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1346                                 htlc_id: htlc_id_arg,
1347                                 err_packet,
1348                         });
1349                         return Ok(None);
1350                 }
1351
1352                 {
1353                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1354                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1355                 }
1356
1357                 Ok(Some(msgs::UpdateFailHTLC {
1358                         channel_id: self.channel_id(),
1359                         htlc_id: htlc_id_arg,
1360                         reason: err_packet
1361                 }))
1362         }
1363
1364         // Message handlers:
1365
1366         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_local_features: LocalFeatures) -> Result<(), ChannelError> {
1367                 // Check sanity of message fields:
1368                 if !self.channel_outbound {
1369                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1370                 }
1371                 if self.channel_state != ChannelState::OurInitSent as u32 {
1372                         return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1373                 }
1374                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1375                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1376                 }
1377                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1378                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1379                 }
1380                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1381                         return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1382                 }
1383                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1384                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1385                 }
1386                 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1387                         return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1388                 }
1389                 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1390                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1391                 }
1392                 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1393                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1394                 }
1395                 if msg.max_accepted_htlcs < 1 {
1396                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1397                 }
1398                 if msg.max_accepted_htlcs > 483 {
1399                         return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1400                 }
1401
1402                 // Now check against optional parameters as set by config...
1403                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1404                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1405                 }
1406                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1407                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1408                 }
1409                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1410                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1411                 }
1412                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1413                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1414                 }
1415                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1416                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1417                 }
1418                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1419                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1420                 }
1421                 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1422                         return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1423                 }
1424
1425                 let their_shutdown_scriptpubkey = if their_local_features.supports_upfront_shutdown_script() {
1426                         match &msg.shutdown_scriptpubkey {
1427                                 &OptionalField::Present(ref script) => {
1428                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1429                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1430                                                 Some(script.clone())
1431                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1432                                         } else if script.len() == 0 {
1433                                                 None
1434                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1435                                         } else {
1436                                                 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
1437                                         }
1438                                 },
1439                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1440                                 &OptionalField::Absent => {
1441                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
1442                                 }
1443                         }
1444                 } else { None };
1445
1446                 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1447
1448                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1449                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1450                 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1451                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1452                 self.their_to_self_delay = msg.to_self_delay;
1453                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1454                 self.minimum_depth = msg.minimum_depth;
1455                 self.their_funding_pubkey = Some(msg.funding_pubkey);
1456                 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1457                 self.their_payment_basepoint = Some(msg.payment_basepoint);
1458                 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1459                 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1460                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1461                 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1462
1463                 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1464                 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1465                 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1466
1467                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1468
1469                 Ok(())
1470         }
1471
1472         fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), ChannelError> {
1473                 let funding_script = self.get_funding_redeemscript();
1474
1475                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1476                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1477                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1478
1479                 // They sign the "local" commitment transaction...
1480                 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer");
1481
1482                 // ...and we sign it, allowing us to broadcast the tx if we wish
1483                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1484
1485                 let remote_keys = self.build_remote_transaction_keys()?;
1486                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1487                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1488
1489                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1490                 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1491         }
1492
1493         pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), ChannelError> {
1494                 if self.channel_outbound {
1495                         return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1496                 }
1497                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1498                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1499                         // remember the channel, so it's safe to just send an error_message here and drop the
1500                         // channel.
1501                         return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1502                 }
1503                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1504                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1505                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1506                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1507                 }
1508
1509                 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1510                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1511                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1512
1513                 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1514                         Ok(res) => res,
1515                         Err(e) => {
1516                                 self.channel_monitor.unset_funding_info();
1517                                 return Err(e);
1518                         }
1519                 };
1520
1521                 // Now that we're past error-generating stuff, update our local state:
1522
1523                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1524                 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1525                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new());
1526                 self.channel_state = ChannelState::FundingSent as u32;
1527                 self.channel_id = funding_txo.to_channel_id();
1528                 self.cur_remote_commitment_transaction_number -= 1;
1529                 self.cur_local_commitment_transaction_number -= 1;
1530
1531                 Ok((msgs::FundingSigned {
1532                         channel_id: self.channel_id,
1533                         signature: our_signature
1534                 }, self.channel_monitor.clone()))
1535         }
1536
1537         /// Handles a funding_signed message from the remote end.
1538         /// If this call is successful, broadcast the funding transaction (and not before!)
1539         pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, ChannelError> {
1540                 if !self.channel_outbound {
1541                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1542                 }
1543                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1544                         return Err(ChannelError::Close("Received funding_signed in strange state!"));
1545                 }
1546                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1547                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1548                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1549                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1550                 }
1551
1552                 let funding_script = self.get_funding_redeemscript();
1553
1554                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1555                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1556                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1557
1558                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1559                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer");
1560
1561                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1562                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1563                 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1564                 self.channel_state = ChannelState::FundingSent as u32 | (self.channel_state & (ChannelState::MonitorUpdateFailed as u32));
1565                 self.cur_local_commitment_transaction_number -= 1;
1566
1567                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1568                         Ok(self.channel_monitor.clone())
1569                 } else {
1570                         Err(ChannelError::Ignore("Previous monitor update failure prevented funding_signed from allowing funding broadcast"))
1571                 }
1572         }
1573
1574         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1575                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1576                         return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1577                 }
1578
1579                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1580
1581                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1582                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1583                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1584                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1585                         self.channel_update_count += 1;
1586                 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1587                                 // Note that funding_signed/funding_created will have decremented both by 1!
1588                                 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1589                                 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1590                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1591                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1592                         }
1593                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1594                         return Ok(());
1595                 } else {
1596                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1597                 }
1598
1599                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1600                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1601                 Ok(())
1602         }
1603
1604         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1605         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1606                 let mut htlc_inbound_value_msat = 0;
1607                 for ref htlc in self.pending_inbound_htlcs.iter() {
1608                         htlc_inbound_value_msat += htlc.amount_msat;
1609                 }
1610                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1611         }
1612
1613         /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1614         /// holding cell.
1615         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1616                 let mut htlc_outbound_value_msat = 0;
1617                 for ref htlc in self.pending_outbound_htlcs.iter() {
1618                         htlc_outbound_value_msat += htlc.amount_msat;
1619                 }
1620
1621                 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1622                 for update in self.holding_cell_htlc_updates.iter() {
1623                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1624                                 htlc_outbound_count += 1;
1625                                 htlc_outbound_value_msat += amount_msat;
1626                         }
1627                 }
1628
1629                 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1630         }
1631
1632         /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1633         /// Doesn't bother handling the
1634         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1635         /// corner case properly.
1636         pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1637                 // Note that we have to handle overflow due to the above case.
1638                 (cmp::min(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1639                 cmp::min(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1640         }
1641
1642         pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1643                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1644                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1645                 }
1646                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1647                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1648                 }
1649                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1650                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1651                 }
1652                 if msg.amount_msat < self.our_htlc_minimum_msat {
1653                         return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1654                 }
1655
1656                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1657                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1658                         return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1659                 }
1660                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1661                 // Check our_max_htlc_value_in_flight_msat
1662                 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1663                         return Err(ChannelError::Close("Remote HTLC add would put them over their max HTLC value in flight"));
1664                 }
1665                 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1666                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1667                 // something if we punish them for broadcasting an old state).
1668                 // Note that we don't really care about having a small/no to_remote output in our local
1669                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1670                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1671                 // present in the next commitment transaction we send them (at least for fulfilled ones,
1672                 // failed ones won't modify value_to_self).
1673                 // Note that we will send HTLCs which another instance of rust-lightning would think
1674                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1675                 // Channel state once they will not be present in the next received commitment
1676                 // transaction).
1677                 let mut removed_outbound_total_msat = 0;
1678                 for ref htlc in self.pending_outbound_htlcs.iter() {
1679                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1680                                 removed_outbound_total_msat += htlc.amount_msat;
1681                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1682                                 removed_outbound_total_msat += htlc.amount_msat;
1683                         }
1684                 }
1685                 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1686                         return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1687                 }
1688                 if self.next_remote_htlc_id != msg.htlc_id {
1689                         return Err(ChannelError::Close("Remote skipped HTLC ID"));
1690                 }
1691                 if msg.cltv_expiry >= 500000000 {
1692                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1693                 }
1694
1695                 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1696
1697                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1698                         if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1699                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1700                         }
1701                 }
1702
1703                 // Now update local state:
1704                 self.next_remote_htlc_id += 1;
1705                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1706                         htlc_id: msg.htlc_id,
1707                         amount_msat: msg.amount_msat,
1708                         payment_hash: msg.payment_hash,
1709                         cltv_expiry: msg.cltv_expiry,
1710                         state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1711                 });
1712                 Ok(())
1713         }
1714
1715         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1716         #[inline]
1717         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1718                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1719                         if htlc.htlc_id == htlc_id {
1720                                 match check_preimage {
1721                                         None => {},
1722                                         Some(payment_hash) =>
1723                                                 if payment_hash != htlc.payment_hash {
1724                                                         return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1725                                                 }
1726                                 };
1727                                 match htlc.state {
1728                                         OutboundHTLCState::LocalAnnounced(_) =>
1729                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1730                                         OutboundHTLCState::Committed => {
1731                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1732                                         },
1733                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1734                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1735                                 }
1736                                 return Ok(&htlc.source);
1737                         }
1738                 }
1739                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1740         }
1741
1742         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1743                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1744                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1745                 }
1746                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1747                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1748                 }
1749
1750                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1751                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1752         }
1753
1754         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1755                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1756                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1757                 }
1758                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1759                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1760                 }
1761
1762                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1763                 Ok(())
1764         }
1765
1766         pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1767                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1768                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1769                 }
1770                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1771                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1772                 }
1773
1774                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1775                 Ok(())
1776         }
1777
1778         pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1779                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1780                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state"));
1781                 }
1782                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1783                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish"));
1784                 }
1785                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1786                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds"));
1787                 }
1788
1789                 let funding_script = self.get_funding_redeemscript();
1790
1791                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1792
1793                 let mut update_fee = false;
1794                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1795                         update_fee = true;
1796                         self.pending_update_fee.unwrap()
1797                 } else {
1798                         self.feerate_per_kw
1799                 };
1800
1801                 let mut local_commitment_tx = {
1802                         let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1803                         let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1804                         (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1805                 };
1806                 let local_commitment_txid = local_commitment_tx.0.txid();
1807                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1808                 log_trace!(self, "Checking commitment tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey.unwrap().serialize()), encode::serialize_hex(&local_commitment_tx.0), encode::serialize_hex(&funding_script));
1809                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
1810
1811                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1812                 if update_fee {
1813                         let num_htlcs = local_commitment_tx.1;
1814                         let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1815
1816                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1817                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee"));
1818                         }
1819                 }
1820
1821                 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1822                         return Err(ChannelError::Close("Got wrong number of HTLC signatures from remote"));
1823                 }
1824
1825                 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1 + 1);
1826                 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1827                 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1828
1829                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1830                 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1831                         if let Some(_) = htlc.transaction_output_index {
1832                                 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1833                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1834                                 log_trace!(self, "Checking HTLC tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript));
1835                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1836                                 secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
1837                                 let htlc_sig = if htlc.offered {
1838                                         let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, &htlc, &local_keys)?;
1839                                         new_local_commitment_txn.push(htlc_tx);
1840                                         htlc_sig
1841                                 } else {
1842                                         self.create_htlc_tx_signature(&htlc_tx, &htlc, &local_keys)?.1
1843                                 };
1844                                 htlcs_and_sigs.push((htlc, Some((msg.htlc_signatures[idx], htlc_sig)), source));
1845                         } else {
1846                                 htlcs_and_sigs.push((htlc, None, source));
1847                         }
1848                 }
1849
1850                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1851                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1852
1853                 // Update state now that we've passed all the can-fail calls...
1854                 let mut need_our_commitment = false;
1855                 if !self.channel_outbound {
1856                         if let Some(fee_update) = self.pending_update_fee {
1857                                 self.feerate_per_kw = fee_update;
1858                                 // We later use the presence of pending_update_fee to indicate we should generate a
1859                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1860                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1861                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1862                                         need_our_commitment = true;
1863                                         self.pending_update_fee = None;
1864                                 }
1865                         }
1866                 }
1867
1868                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1869
1870                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1871                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1872                                 Some(forward_info.clone())
1873                         } else { None };
1874                         if let Some(forward_info) = new_forward {
1875                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1876                                 need_our_commitment = true;
1877                         }
1878                 }
1879                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1880                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1881                                 Some(fail_reason.take())
1882                         } else { None } {
1883                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1884                                 need_our_commitment = true;
1885                         }
1886                 }
1887
1888                 self.cur_local_commitment_transaction_number -= 1;
1889                 self.last_local_commitment_txn = new_local_commitment_txn;
1890                 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1891                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1892                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1893
1894                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1895                         // In case we initially failed monitor updating without requiring a response, we need
1896                         // to make sure the RAA gets sent first.
1897                         self.monitor_pending_revoke_and_ack = true;
1898                         if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1899                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1900                                 // the corresponding HTLC status updates so that get_last_commitment_update
1901                                 // includes the right HTLCs.
1902                                 // Note that this generates a monitor update that we ignore! This is OK since we
1903                                 // won't actually send the commitment_signed that generated the update to the other
1904                                 // side until the latest monitor has been pulled from us and stored.
1905                                 self.monitor_pending_commitment_signed = true;
1906                                 self.send_commitment_no_status_check()?;
1907                         }
1908                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1909                         // re-send the message on restoration)
1910                         return Err(ChannelError::Ignore("Previous monitor update failure prevented generation of RAA"));
1911                 }
1912
1913                 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1914                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1915                         // we'll send one right away when we get the revoke_and_ack when we
1916                         // free_holding_cell_htlcs().
1917                         let (msg, monitor) = self.send_commitment_no_status_check()?;
1918                         (Some(msg), monitor, None)
1919                 } else if !need_our_commitment {
1920                         (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1921                 } else { (None, self.channel_monitor.clone(), None) };
1922
1923                 Ok((msgs::RevokeAndACK {
1924                         channel_id: self.channel_id,
1925                         per_commitment_secret: per_commitment_secret,
1926                         next_per_commitment_point: next_per_commitment_point,
1927                 }, our_commitment_signed, closing_signed, monitor_update))
1928         }
1929
1930         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1931         /// fulfilling or failing the last pending HTLC)
1932         fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, ChannelError> {
1933                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1934                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1935                         log_trace!(self, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
1936
1937                         let mut htlc_updates = Vec::new();
1938                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1939                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1940                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1941                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1942                         let mut err = None;
1943                         for htlc_update in htlc_updates.drain(..) {
1944                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
1945                                 // fee races with adding too many outputs which push our total payments just over
1946                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
1947                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
1948                                 // to rebalance channels.
1949                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1950                                         self.holding_cell_htlc_updates.push(htlc_update);
1951                                 } else {
1952                                         match &htlc_update {
1953                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
1954                                                         match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1955                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1956                                                                 Err(e) => {
1957                                                                         match e {
1958                                                                                 ChannelError::Ignore(ref msg) => {
1959                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
1960                                                                                 },
1961                                                                                 _ => {
1962                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
1963                                                                                 },
1964                                                                         }
1965                                                                         err = Some(e);
1966                                                                 }
1967                                                         }
1968                                                 },
1969                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
1970                                                         match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
1971                                                                 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1972                                                                 Err(e) => {
1973                                                                         if let ChannelError::Ignore(_) = e {}
1974                                                                         else {
1975                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1976                                                                         }
1977                                                                 }
1978                                                         }
1979                                                 },
1980                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1981                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1982                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1983                                                                 Err(e) => {
1984                                                                         if let ChannelError::Ignore(_) = e {}
1985                                                                         else {
1986                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1987                                                                         }
1988                                                                 }
1989                                                         }
1990                                                 },
1991                                         }
1992                                         if err.is_some() {
1993                                                 self.holding_cell_htlc_updates.push(htlc_update);
1994                                                 if let Some(ChannelError::Ignore(_)) = err {
1995                                                         // If we failed to add the HTLC, but got an Ignore error, we should
1996                                                         // still send the new commitment_signed, so reset the err to None.
1997                                                         err = None;
1998                                                 }
1999                                         }
2000                                 }
2001                         }
2002                         //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2003                         //fail it back the route, if it's a temporary issue we can ignore it...
2004                         match err {
2005                                 None => {
2006                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2007                                                 // This should never actually happen and indicates we got some Errs back
2008                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2009                                                 // case there is some strange way to hit duplicate HTLC removes.
2010                                                 return Ok(None);
2011                                         }
2012                                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2013                                                         self.pending_update_fee = self.holding_cell_update_fee.take();
2014                                                         Some(msgs::UpdateFee {
2015                                                                 channel_id: self.channel_id,
2016                                                                 feerate_per_kw: feerate as u32,
2017                                                         })
2018                                                 } else {
2019                                                         None
2020                                                 };
2021                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2022                                         Ok(Some((msgs::CommitmentUpdate {
2023                                                 update_add_htlcs,
2024                                                 update_fulfill_htlcs,
2025                                                 update_fail_htlcs,
2026                                                 update_fail_malformed_htlcs: Vec::new(),
2027                                                 update_fee: update_fee,
2028                                                 commitment_signed,
2029                                         }, monitor_update)))
2030                                 },
2031                                 Some(e) => Err(e)
2032                         }
2033                 } else {
2034                         Ok(None)
2035                 }
2036         }
2037
2038         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2039         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2040         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2041         /// generating an appropriate error *after* the channel state has been updated based on the
2042         /// revoke_and_ack message.
2043         pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
2044                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2045                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2046                 }
2047                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2048                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2049                 }
2050                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2051                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2052                 }
2053
2054                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2055                         if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
2056                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2057                         }
2058                 }
2059                 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2060                         .map_err(|e| ChannelError::Close(e.0))?;
2061
2062                 // Update state now that we've passed all the can-fail calls...
2063                 // (note that we may still fail to generate the new commitment_signed message, but that's
2064                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2065                 // channel based on that, but stepping stuff here should be safe either way.
2066                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2067                 self.their_prev_commitment_point = self.their_cur_commitment_point;
2068                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2069                 self.cur_remote_commitment_transaction_number -= 1;
2070
2071                 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2072                 let mut to_forward_infos = Vec::new();
2073                 let mut revoked_htlcs = Vec::new();
2074                 let mut update_fail_htlcs = Vec::new();
2075                 let mut update_fail_malformed_htlcs = Vec::new();
2076                 let mut require_commitment = false;
2077                 let mut value_to_self_msat_diff: i64 = 0;
2078
2079                 {
2080                         // Take references explicitly so that we can hold multiple references to self.
2081                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2082                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2083                         let logger = LogHolder { logger: &self.logger };
2084
2085                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2086                         pending_inbound_htlcs.retain(|htlc| {
2087                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2088                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2089                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2090                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2091                                         }
2092                                         false
2093                                 } else { true }
2094                         });
2095                         pending_outbound_htlcs.retain(|htlc| {
2096                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2097                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2098                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2099                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2100                                         } else {
2101                                                 // They fulfilled, so we sent them money
2102                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2103                                         }
2104                                         false
2105                                 } else { true }
2106                         });
2107                         for htlc in pending_inbound_htlcs.iter_mut() {
2108                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2109                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2110                                         true
2111                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2112                                         log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2113                                         true
2114                                 } else { false };
2115                                 if swap {
2116                                         let mut state = InboundHTLCState::Committed;
2117                                         mem::swap(&mut state, &mut htlc.state);
2118
2119                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2120                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2121                                                 require_commitment = true;
2122                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2123                                                 match forward_info {
2124                                                         PendingHTLCStatus::Fail(fail_msg) => {
2125                                                                 require_commitment = true;
2126                                                                 match fail_msg {
2127                                                                         HTLCFailureMsg::Relay(msg) => {
2128                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2129                                                                                 update_fail_htlcs.push(msg)
2130                                                                         },
2131                                                                         HTLCFailureMsg::Malformed(msg) => {
2132                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2133                                                                                 update_fail_malformed_htlcs.push(msg)
2134                                                                         },
2135                                                                 }
2136                                                         },
2137                                                         PendingHTLCStatus::Forward(forward_info) => {
2138                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2139                                                                 htlc.state = InboundHTLCState::Committed;
2140                                                         }
2141                                                 }
2142                                         }
2143                                 }
2144                         }
2145                         for htlc in pending_outbound_htlcs.iter_mut() {
2146                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2147                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2148                                         htlc.state = OutboundHTLCState::Committed;
2149                                 }
2150                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2151                                         Some(fail_reason.take())
2152                                 } else { None } {
2153                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2154                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2155                                         require_commitment = true;
2156                                 }
2157                         }
2158                 }
2159                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2160
2161                 if self.channel_outbound {
2162                         if let Some(feerate) = self.pending_update_fee.take() {
2163                                 self.feerate_per_kw = feerate;
2164                         }
2165                 } else {
2166                         if let Some(feerate) = self.pending_update_fee {
2167                                 // Because a node cannot send two commitment_signeds in a row without getting a
2168                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2169                                 // it should use to create keys with) and because a node can't send a
2170                                 // commitment_signed without changes, checking if the feerate is equal to the
2171                                 // pending feerate update is sufficient to detect require_commitment.
2172                                 if feerate == self.feerate_per_kw {
2173                                         require_commitment = true;
2174                                         self.pending_update_fee = None;
2175                                 }
2176                         }
2177                 }
2178
2179                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2180                         // We can't actually generate a new commitment transaction (incl by freeing holding
2181                         // cells) while we can't update the monitor, so we just return what we have.
2182                         if require_commitment {
2183                                 self.monitor_pending_commitment_signed = true;
2184                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2185                                 // which does not update state, but we're definitely now awaiting a remote revoke
2186                                 // before we can step forward any more, so set it here.
2187                                 self.send_commitment_no_status_check()?;
2188                         }
2189                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2190                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2191                         return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2192                 }
2193
2194                 match self.free_holding_cell_htlcs()? {
2195                         Some(mut commitment_update) => {
2196                                 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2197                                 for fail_msg in update_fail_htlcs.drain(..) {
2198                                         commitment_update.0.update_fail_htlcs.push(fail_msg);
2199                                 }
2200                                 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2201                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2202                                         commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2203                                 }
2204                                 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2205                         },
2206                         None => {
2207                                 if require_commitment {
2208                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2209                                         Ok((Some(msgs::CommitmentUpdate {
2210                                                 update_add_htlcs: Vec::new(),
2211                                                 update_fulfill_htlcs: Vec::new(),
2212                                                 update_fail_htlcs,
2213                                                 update_fail_malformed_htlcs,
2214                                                 update_fee: None,
2215                                                 commitment_signed
2216                                         }), to_forward_infos, revoked_htlcs, None, monitor_update))
2217                                 } else {
2218                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2219                                 }
2220                         }
2221                 }
2222
2223         }
2224
2225         /// Adds a pending update to this channel. See the doc for send_htlc for
2226         /// further details on the optionness of the return value.
2227         /// You MUST call send_commitment prior to any other calls on this Channel
2228         fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2229                 if !self.channel_outbound {
2230                         panic!("Cannot send fee from inbound channel");
2231                 }
2232                 if !self.is_usable() {
2233                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2234                 }
2235                 if !self.is_live() {
2236                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2237                 }
2238
2239                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2240                         self.holding_cell_update_fee = Some(feerate_per_kw);
2241                         return None;
2242                 }
2243
2244                 debug_assert!(self.pending_update_fee.is_none());
2245                 self.pending_update_fee = Some(feerate_per_kw);
2246
2247                 Some(msgs::UpdateFee {
2248                         channel_id: self.channel_id,
2249                         feerate_per_kw: feerate_per_kw as u32,
2250                 })
2251         }
2252
2253         pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
2254                 match self.send_update_fee(feerate_per_kw) {
2255                         Some(update_fee) => {
2256                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2257                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2258                         },
2259                         None => Ok(None)
2260                 }
2261         }
2262
2263         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2264         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2265         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2266         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2267         /// No further message handling calls may be made until a channel_reestablish dance has
2268         /// completed.
2269         pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2270                 let mut outbound_drops = Vec::new();
2271
2272                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2273                 if self.channel_state < ChannelState::FundingSent as u32 {
2274                         self.channel_state = ChannelState::ShutdownComplete as u32;
2275                         return outbound_drops;
2276                 }
2277                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2278                 // will be retransmitted.
2279                 self.last_sent_closing_fee = None;
2280
2281                 let mut inbound_drop_count = 0;
2282                 self.pending_inbound_htlcs.retain(|htlc| {
2283                         match htlc.state {
2284                                 InboundHTLCState::RemoteAnnounced(_) => {
2285                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2286                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2287                                         // this HTLC accordingly
2288                                         inbound_drop_count += 1;
2289                                         false
2290                                 },
2291                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2292                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2293                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2294                                         // in response to it yet, so don't touch it.
2295                                         true
2296                                 },
2297                                 InboundHTLCState::Committed => true,
2298                                 InboundHTLCState::LocalRemoved(_) => {
2299                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2300                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2301                                         // (that we missed). Keep this around for now and if they tell us they missed
2302                                         // the commitment_signed we can re-transmit the update then.
2303                                         true
2304                                 },
2305                         }
2306                 });
2307                 self.next_remote_htlc_id -= inbound_drop_count;
2308
2309                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2310                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2311                                 // They sent us an update to remove this but haven't yet sent the corresponding
2312                                 // commitment_signed, we need to move it back to Committed and they can re-send
2313                                 // the update upon reconnection.
2314                                 htlc.state = OutboundHTLCState::Committed;
2315                         }
2316                 }
2317
2318                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2319                         match htlc_update {
2320                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2321                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2322                                         false
2323                                 },
2324                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2325                         }
2326                 });
2327                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2328                 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2329                 outbound_drops
2330         }
2331
2332         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2333         /// updates are partially paused.
2334         /// This must be called immediately after the call which generated the ChannelMonitor update
2335         /// which failed. The messages which were generated from that call which generated the
2336         /// monitor update failure must *not* have been sent to the remote end, and must instead
2337         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2338         pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2339                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2340                 self.monitor_pending_revoke_and_ack = resend_raa;
2341                 self.monitor_pending_commitment_signed = resend_commitment;
2342                 assert!(self.monitor_pending_forwards.is_empty());
2343                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2344                 assert!(self.monitor_pending_failures.is_empty());
2345                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2346                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2347         }
2348
2349         /// Indicates that the latest ChannelMonitor update has been committed by the client
2350         /// successfully and we should restore normal operation. Returns messages which should be sent
2351         /// to the remote side.
2352         pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool) {
2353                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2354                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2355                 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2356
2357                 let mut forwards = Vec::new();
2358                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2359                 let mut failures = Vec::new();
2360                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2361
2362                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2363                         self.monitor_pending_revoke_and_ack = false;
2364                         self.monitor_pending_commitment_signed = false;
2365                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe);
2366                 }
2367
2368                 let raa = if self.monitor_pending_revoke_and_ack {
2369                         Some(self.get_last_revoke_and_ack())
2370                 } else { None };
2371                 let commitment_update = if self.monitor_pending_commitment_signed {
2372                         Some(self.get_last_commitment_update())
2373                 } else { None };
2374
2375                 self.monitor_pending_revoke_and_ack = false;
2376                 self.monitor_pending_commitment_signed = false;
2377                 let order = self.resend_order.clone();
2378                 log_trace!(self, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2379                         if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2380                         if commitment_update.is_some() { "a" } else { "no" },
2381                         if raa.is_some() { "an" } else { "no" },
2382                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2383                 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe)
2384         }
2385
2386         pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2387                 if self.channel_outbound {
2388                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2389                 }
2390                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2391                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2392                 }
2393                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2394                 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2395                 self.channel_update_count += 1;
2396                 Ok(())
2397         }
2398
2399         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2400                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2401                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2402                 msgs::RevokeAndACK {
2403                         channel_id: self.channel_id,
2404                         per_commitment_secret,
2405                         next_per_commitment_point,
2406                 }
2407         }
2408
2409         fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2410                 let mut update_add_htlcs = Vec::new();
2411                 let mut update_fulfill_htlcs = Vec::new();
2412                 let mut update_fail_htlcs = Vec::new();
2413                 let mut update_fail_malformed_htlcs = Vec::new();
2414
2415                 for htlc in self.pending_outbound_htlcs.iter() {
2416                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2417                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2418                                         channel_id: self.channel_id(),
2419                                         htlc_id: htlc.htlc_id,
2420                                         amount_msat: htlc.amount_msat,
2421                                         payment_hash: htlc.payment_hash,
2422                                         cltv_expiry: htlc.cltv_expiry,
2423                                         onion_routing_packet: (**onion_packet).clone(),
2424                                 });
2425                         }
2426                 }
2427
2428                 for htlc in self.pending_inbound_htlcs.iter() {
2429                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2430                                 match reason {
2431                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2432                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2433                                                         channel_id: self.channel_id(),
2434                                                         htlc_id: htlc.htlc_id,
2435                                                         reason: err_packet.clone()
2436                                                 });
2437                                         },
2438                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2439                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2440                                                         channel_id: self.channel_id(),
2441                                                         htlc_id: htlc.htlc_id,
2442                                                         sha256_of_onion: sha256_of_onion.clone(),
2443                                                         failure_code: failure_code.clone(),
2444                                                 });
2445                                         },
2446                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2447                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2448                                                         channel_id: self.channel_id(),
2449                                                         htlc_id: htlc.htlc_id,
2450                                                         payment_preimage: payment_preimage.clone(),
2451                                                 });
2452                                         },
2453                                 }
2454                         }
2455                 }
2456
2457                 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2458                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2459                 msgs::CommitmentUpdate {
2460                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2461                         update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2462                         commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2463                 }
2464         }
2465
2466         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2467         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2468         pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2469                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2470                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2471                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2472                         // just close here instead of trying to recover.
2473                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2474                 }
2475
2476                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2477                         msg.next_local_commitment_number == 0 {
2478                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2479                 }
2480
2481                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2482                 // remaining cases either succeed or ErrorMessage-fail).
2483                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2484
2485                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2486                         Some(msgs::Shutdown {
2487                                 channel_id: self.channel_id,
2488                                 scriptpubkey: self.get_closing_scriptpubkey(),
2489                         })
2490                 } else { None };
2491
2492                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2493                         if self.channel_state & ChannelState::OurFundingLocked as u32 == 0 {
2494                                 if msg.next_remote_commitment_number != 0 {
2495                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2496                                 }
2497                                 // Short circuit the whole handler as there is nothing we can resend them
2498                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2499                         }
2500
2501                         // We have OurFundingLocked set!
2502                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2503                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2504                         return Ok((Some(msgs::FundingLocked {
2505                                 channel_id: self.channel_id(),
2506                                 next_per_commitment_point: next_per_commitment_point,
2507                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2508                 }
2509
2510                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2511                         // Remote isn't waiting on any RevokeAndACK from us!
2512                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2513                         None
2514                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2515                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2516                                 self.monitor_pending_revoke_and_ack = true;
2517                                 None
2518                         } else {
2519                                 Some(self.get_last_revoke_and_ack())
2520                         }
2521                 } else {
2522                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2523                 };
2524
2525                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2526                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2527                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2528                 // the corresponding revoke_and_ack back yet.
2529                 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2530
2531                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2532                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2533                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2534                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2535                         Some(msgs::FundingLocked {
2536                                 channel_id: self.channel_id(),
2537                                 next_per_commitment_point: next_per_commitment_point,
2538                         })
2539                 } else { None };
2540
2541                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2542                         if required_revoke.is_some() {
2543                                 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2544                         } else {
2545                                 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2546                         }
2547
2548                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2549                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2550                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2551                                 // have received some updates while we were disconnected. Free the holding cell
2552                                 // now!
2553                                 match self.free_holding_cell_htlcs() {
2554                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2555                                         Err(ChannelError::Ignore(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2556                                         Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), self.resend_order.clone(), shutdown_msg)),
2557                                         Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2558                                 }
2559                         } else {
2560                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2561                         }
2562                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2563                         if required_revoke.is_some() {
2564                                 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2565                         } else {
2566                                 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2567                         }
2568
2569                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2570                                 self.monitor_pending_commitment_signed = true;
2571                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2572                         }
2573
2574                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, self.resend_order.clone(), shutdown_msg));
2575                 } else {
2576                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2577                 }
2578         }
2579
2580         fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2581                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2582                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2583                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2584                         return None;
2585                 }
2586
2587                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2588                 if self.feerate_per_kw > proposed_feerate {
2589                         proposed_feerate = self.feerate_per_kw;
2590                 }
2591                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2592                 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2593
2594                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2595                 let funding_redeemscript = self.get_funding_redeemscript();
2596                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2597
2598                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2599                 Some(msgs::ClosingSigned {
2600                         channel_id: self.channel_id,
2601                         fee_satoshis: total_fee_satoshis,
2602                         signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2603                 })
2604         }
2605
2606         pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError> {
2607                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2608                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2609                 }
2610                 if self.channel_state < ChannelState::FundingSent as u32 {
2611                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2612                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2613                         // can do that via error message without getting a connection fail anyway...
2614                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2615                 }
2616                 for htlc in self.pending_inbound_htlcs.iter() {
2617                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2618                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2619                         }
2620                 }
2621                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2622
2623                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2624                 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2625                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2626                         return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2627                 }
2628
2629                 //Check shutdown_scriptpubkey form as BOLT says we must
2630                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2631                         return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2632                 }
2633
2634                 if self.their_shutdown_scriptpubkey.is_some() {
2635                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2636                                 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2637                         }
2638                 } else {
2639                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2640                 }
2641
2642                 // From here on out, we may not fail!
2643
2644                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2645                 self.channel_update_count += 1;
2646
2647                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2648                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2649                 // cell HTLCs and return them to fail the payment.
2650                 self.holding_cell_update_fee = None;
2651                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2652                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2653                         match htlc_update {
2654                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2655                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2656                                         false
2657                                 },
2658                                 _ => true
2659                         }
2660                 });
2661                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2662                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2663                 // any further commitment updates after we set LocalShutdownSent.
2664
2665                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2666                         None
2667                 } else {
2668                         Some(msgs::Shutdown {
2669                                 channel_id: self.channel_id,
2670                                 scriptpubkey: self.get_closing_scriptpubkey(),
2671                         })
2672                 };
2673
2674                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2675                 self.channel_update_count += 1;
2676                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2677         }
2678
2679         pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError> {
2680                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2681                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2682                 }
2683                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2684                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2685                 }
2686                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2687                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2688                 }
2689                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2690                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2691                 }
2692
2693                 let funding_redeemscript = self.get_funding_redeemscript();
2694                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2695                 if used_total_fee != msg.fee_satoshis {
2696                         return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2697                 }
2698                 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2699
2700                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2701                         Ok(_) => {},
2702                         Err(_e) => {
2703                                 // The remote end may have decided to revoke their output due to inconsistent dust
2704                                 // limits, so check for that case by re-checking the signature here.
2705                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2706                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2707                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer");
2708                         },
2709                 };
2710
2711                 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2712                         if last_fee == msg.fee_satoshis {
2713                                 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2714                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2715                                 self.channel_update_count += 1;
2716                                 return Ok((None, Some(closing_tx)));
2717                         }
2718                 }
2719
2720                 macro_rules! propose_new_feerate {
2721                         ($new_feerate: expr) => {
2722                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2723                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2724                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2725                                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2726                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2727                                 return Ok((Some(msgs::ClosingSigned {
2728                                         channel_id: self.channel_id,
2729                                         fee_satoshis: used_total_fee,
2730                                         signature: our_sig,
2731                                 }), None))
2732                         }
2733                 }
2734
2735                 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2736                 if self.channel_outbound {
2737                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2738                         if proposed_sat_per_kw > our_max_feerate {
2739                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2740                                         if our_max_feerate <= last_feerate {
2741                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2742                                         }
2743                                 }
2744                                 propose_new_feerate!(our_max_feerate);
2745                         }
2746                 } else {
2747                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2748                         if proposed_sat_per_kw < our_min_feerate {
2749                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2750                                         if our_min_feerate >= last_feerate {
2751                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2752                                         }
2753                                 }
2754                                 propose_new_feerate!(our_min_feerate);
2755                         }
2756                 }
2757
2758                 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2759                 self.channel_state = ChannelState::ShutdownComplete as u32;
2760                 self.channel_update_count += 1;
2761
2762                 Ok((Some(msgs::ClosingSigned {
2763                         channel_id: self.channel_id,
2764                         fee_satoshis: msg.fee_satoshis,
2765                         signature: our_sig,
2766                 }), Some(closing_tx)))
2767         }
2768
2769         // Public utilities:
2770
2771         pub fn channel_id(&self) -> [u8; 32] {
2772                 self.channel_id
2773         }
2774
2775         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2776         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2777         pub fn get_user_id(&self) -> u64 {
2778                 self.user_id
2779         }
2780
2781         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2782         pub fn channel_monitor(&self) -> ChannelMonitor {
2783                 if self.channel_state < ChannelState::FundingCreated as u32 {
2784                         panic!("Can't get a channel monitor until funding has been created");
2785                 }
2786                 self.channel_monitor.clone()
2787         }
2788
2789         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2790         /// is_usable() returns true).
2791         /// Allowed in any state (including after shutdown)
2792         pub fn get_short_channel_id(&self) -> Option<u64> {
2793                 self.short_channel_id
2794         }
2795
2796         /// Returns the funding_txo we either got from our peer, or were given by
2797         /// get_outbound_funding_created.
2798         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2799                 self.channel_monitor.get_funding_txo()
2800         }
2801
2802         /// Allowed in any state (including after shutdown)
2803         pub fn get_their_node_id(&self) -> PublicKey {
2804                 self.their_node_id
2805         }
2806
2807         /// Allowed in any state (including after shutdown)
2808         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2809                 self.our_htlc_minimum_msat
2810         }
2811
2812         /// Allowed in any state (including after shutdown)
2813         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2814                 self.our_htlc_minimum_msat
2815         }
2816
2817         pub fn get_value_satoshis(&self) -> u64 {
2818                 self.channel_value_satoshis
2819         }
2820
2821         pub fn get_fee_proportional_millionths(&self) -> u32 {
2822                 self.config.fee_proportional_millionths
2823         }
2824
2825         #[cfg(test)]
2826         pub fn get_feerate(&self) -> u64 {
2827                 self.feerate_per_kw
2828         }
2829
2830         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2831                 self.cur_local_commitment_transaction_number + 1
2832         }
2833
2834         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2835                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2836         }
2837
2838         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2839                 self.cur_remote_commitment_transaction_number + 2
2840         }
2841
2842         //TODO: Testing purpose only, should be changed in another way after #81
2843         #[cfg(test)]
2844         pub fn get_local_keys(&self) -> &ChannelKeys {
2845                 &self.local_keys
2846         }
2847
2848         #[cfg(test)]
2849         pub fn get_value_stat(&self) -> ChannelValueStat {
2850                 ChannelValueStat {
2851                         value_to_self_msat: self.value_to_self_msat,
2852                         channel_value_msat: self.channel_value_satoshis * 1000,
2853                         channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2854                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2855                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2856                         holding_cell_outbound_amount_msat: {
2857                                 let mut res = 0;
2858                                 for h in self.holding_cell_htlc_updates.iter() {
2859                                         match h {
2860                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2861                                                         res += amount_msat;
2862                                                 }
2863                                                 _ => {}
2864                                         }
2865                                 }
2866                                 res
2867                         },
2868                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2869                 }
2870         }
2871
2872         /// Allowed in any state (including after shutdown)
2873         pub fn get_channel_update_count(&self) -> u32 {
2874                 self.channel_update_count
2875         }
2876
2877         pub fn should_announce(&self) -> bool {
2878                 self.config.announced_channel
2879         }
2880
2881         pub fn is_outbound(&self) -> bool {
2882                 self.channel_outbound
2883         }
2884
2885         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2886         /// Allowed in any state (including after shutdown)
2887         pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2888                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2889                 // output value back into a transaction with the regular channel output:
2890
2891                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2892                 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2893
2894                 if self.channel_outbound {
2895                         // + the marginal fee increase cost to us in the commitment transaction:
2896                         res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2897                 }
2898
2899                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2900                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2901
2902                 res as u32
2903         }
2904
2905         /// Returns true if we've ever received a message from the remote end for this Channel
2906         pub fn have_received_message(&self) -> bool {
2907                 self.channel_state > (ChannelState::OurInitSent as u32)
2908         }
2909
2910         /// Returns true if this channel is fully established and not known to be closing.
2911         /// Allowed in any state (including after shutdown)
2912         pub fn is_usable(&self) -> bool {
2913                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2914                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2915         }
2916
2917         /// Returns true if this channel is currently available for use. This is a superset of
2918         /// is_usable() and considers things like the channel being temporarily disabled.
2919         /// Allowed in any state (including after shutdown)
2920         pub fn is_live(&self) -> bool {
2921                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2922         }
2923
2924         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2925         /// Allowed in any state (including after shutdown)
2926         pub fn is_awaiting_monitor_update(&self) -> bool {
2927                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2928         }
2929
2930         /// Returns true if funding_created was sent/received.
2931         pub fn is_funding_initiated(&self) -> bool {
2932                 self.channel_state >= ChannelState::FundingCreated as u32
2933         }
2934
2935         /// Returns true if this channel is fully shut down. True here implies that no further actions
2936         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2937         /// will be handled appropriately by the chain monitor.
2938         pub fn is_shutdown(&self) -> bool {
2939                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
2940                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2941                         true
2942                 } else { false }
2943         }
2944
2945         /// Called by channelmanager based on chain blocks being connected.
2946         /// Note that we only need to use this to detect funding_signed, anything else is handled by
2947         /// the channel_monitor.
2948         /// In case of Err, the channel may have been closed, at which point the standard requirements
2949         /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2950         /// Only returns an ErrorAction of DisconnectPeer, if Err.
2951         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
2952                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2953                 if header.bitcoin_hash() != self.last_block_connected {
2954                         self.last_block_connected = header.bitcoin_hash();
2955                         self.channel_monitor.last_block_hash = self.last_block_connected;
2956                         if self.funding_tx_confirmations > 0 {
2957                                 self.funding_tx_confirmations += 1;
2958                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2959                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2960                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
2961                                                 true
2962                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2963                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2964                                                 self.channel_update_count += 1;
2965                                                 true
2966                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2967                                                 // We got a reorg but not enough to trigger a force close, just update
2968                                                 // funding_tx_confirmed_in and return.
2969                                                 false
2970                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2971                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2972                                         } else {
2973                                                 // We got a reorg but not enough to trigger a force close, just update
2974                                                 // funding_tx_confirmed_in and return.
2975                                                 false
2976                                         };
2977                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2978
2979                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2980                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2981                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2982                                         //a protocol oversight, but I assume I'm just missing something.
2983                                         if need_commitment_update {
2984                                                 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2985                                                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2986                                                 return Ok(Some(msgs::FundingLocked {
2987                                                         channel_id: self.channel_id,
2988                                                         next_per_commitment_point: next_per_commitment_point,
2989                                                 }));
2990                                         }
2991                                 }
2992                         }
2993                 }
2994                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2995                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2996                                 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2997                                         let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2998                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2999                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
3000                                                 if self.channel_outbound {
3001                                                         // If we generated the funding transaction and it doesn't match what it
3002                                                         // should, the client is really broken and we should just panic and
3003                                                         // tell them off. That said, because hash collisions happen with high
3004                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
3005                                                         // channel and move on.
3006                                                         #[cfg(not(feature = "fuzztarget"))]
3007                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3008                                                 }
3009                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3010                                                 self.channel_update_count += 1;
3011                                                 return Err(msgs::ErrorMessage {
3012                                                         channel_id: self.channel_id(),
3013                                                         data: "funding tx had wrong script/value".to_owned()
3014                                                 });
3015                                         } else {
3016                                                 if self.channel_outbound {
3017                                                         for input in tx.input.iter() {
3018                                                                 if input.witness.is_empty() {
3019                                                                         // We generated a malleable funding transaction, implying we've
3020                                                                         // just exposed ourselves to funds loss to our counterparty.
3021                                                                         #[cfg(not(feature = "fuzztarget"))]
3022                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3023                                                                 }
3024                                                         }
3025                                                 }
3026                                                 self.funding_tx_confirmations = 1;
3027                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
3028                                                                              ((*index_in_block as u64) << (2*8)) |
3029                                                                              ((txo_idx as u64)         << (0*8)));
3030                                         }
3031                                 }
3032                         }
3033                 }
3034                 Ok(None)
3035         }
3036
3037         /// Called by channelmanager based on chain blocks being disconnected.
3038         /// Returns true if we need to close the channel now due to funding transaction
3039         /// unconfirmation/reorg.
3040         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3041                 if self.funding_tx_confirmations > 0 {
3042                         self.funding_tx_confirmations -= 1;
3043                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3044                                 return true;
3045                         }
3046                 }
3047                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3048                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3049                 }
3050                 self.last_block_connected = header.bitcoin_hash();
3051                 self.channel_monitor.last_block_hash = self.last_block_connected;
3052                 false
3053         }
3054
3055         // Methods to get unprompted messages to send to the remote end (or where we already returned
3056         // something in the handler for the message that prompted this message):
3057
3058         pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
3059                 if !self.channel_outbound {
3060                         panic!("Tried to open a channel for an inbound channel?");
3061                 }
3062                 if self.channel_state != ChannelState::OurInitSent as u32 {
3063                         panic!("Cannot generate an open_channel after we've moved forward");
3064                 }
3065
3066                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3067                         panic!("Tried to send an open_channel for a channel that has already advanced");
3068                 }
3069
3070                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3071
3072                 msgs::OpenChannel {
3073                         chain_hash: chain_hash,
3074                         temporary_channel_id: self.channel_id,
3075                         funding_satoshis: self.channel_value_satoshis,
3076                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3077                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3078                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3079                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3080                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3081                         feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3082                         to_self_delay: self.our_to_self_delay,
3083                         max_accepted_htlcs: OUR_MAX_HTLCS,
3084                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3085                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3086                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3087                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3088                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3089                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3090                         channel_flags: if self.config.announced_channel {1} else {0},
3091                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3092                 }
3093         }
3094
3095         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3096                 if self.channel_outbound {
3097                         panic!("Tried to send accept_channel for an outbound channel?");
3098                 }
3099                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3100                         panic!("Tried to send accept_channel after channel had moved forward");
3101                 }
3102                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3103                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3104                 }
3105
3106                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3107
3108                 msgs::AcceptChannel {
3109                         temporary_channel_id: self.channel_id,
3110                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3111                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3112                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3113                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3114                         minimum_depth: self.minimum_depth,
3115                         to_self_delay: self.our_to_self_delay,
3116                         max_accepted_htlcs: OUR_MAX_HTLCS,
3117                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3118                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3119                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3120                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3121                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3122                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3123                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3124                 }
3125         }
3126
3127         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3128         fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
3129                 let funding_script = self.get_funding_redeemscript();
3130
3131                 let remote_keys = self.build_remote_transaction_keys()?;
3132                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3133                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
3134
3135                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
3136                 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
3137         }
3138
3139         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3140         /// a funding_created message for the remote peer.
3141         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3142         /// or if called on an inbound channel.
3143         /// Note that channel_id changes during this call!
3144         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3145         /// If an Err is returned, it is a ChannelError::Close.
3146         pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), ChannelError> {
3147                 if !self.channel_outbound {
3148                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3149                 }
3150                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3151                         panic!("Tried to get a funding_created messsage at a time other than immediately after initial handshake completion (or tried to get funding_created twice)");
3152                 }
3153                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
3154                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3155                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3156                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3157                 }
3158
3159                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
3160                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
3161
3162                 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3163                         Ok(res) => res,
3164                         Err(e) => {
3165                                 log_error!(self, "Got bad signatures: {:?}!", e);
3166                                 self.channel_monitor.unset_funding_info();
3167                                 return Err(e);
3168                         }
3169                 };
3170
3171                 let temporary_channel_id = self.channel_id;
3172
3173                 // Now that we're past error-generating stuff, update our local state:
3174                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3175                 self.channel_state = ChannelState::FundingCreated as u32;
3176                 self.channel_id = funding_txo.to_channel_id();
3177                 self.cur_remote_commitment_transaction_number -= 1;
3178
3179                 Ok((msgs::FundingCreated {
3180                         temporary_channel_id: temporary_channel_id,
3181                         funding_txid: funding_txo.txid,
3182                         funding_output_index: funding_txo.index,
3183                         signature: our_signature
3184                 }, self.channel_monitor.clone()))
3185         }
3186
3187         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3188         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3189         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3190         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3191         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3192         /// closing).
3193         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3194         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3195         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3196                 if !self.config.announced_channel {
3197                         return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3198                 }
3199                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3200                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3201                 }
3202                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3203                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3204                 }
3205
3206                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3207                 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3208
3209                 let msg = msgs::UnsignedChannelAnnouncement {
3210                         features: msgs::GlobalFeatures::new(),
3211                         chain_hash: chain_hash,
3212                         short_channel_id: self.get_short_channel_id().unwrap(),
3213                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3214                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3215                         bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3216                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3217                         excess_data: Vec::new(),
3218                 };
3219
3220                 let msghash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
3221                 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3222
3223                 Ok((msg, sig))
3224         }
3225
3226         /// May panic if called on a channel that wasn't immediately-previously
3227         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3228         pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3229                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3230                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3231                 msgs::ChannelReestablish {
3232                         channel_id: self.channel_id(),
3233                         // The protocol has two different commitment number concepts - the "commitment
3234                         // transaction number", which starts from 0 and counts up, and the "revocation key
3235                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3236                         // commitment transaction numbers by the index which will be used to reveal the
3237                         // revocation key for that commitment transaction, which means we have to convert them
3238                         // to protocol-level commitment numbers here...
3239
3240                         // next_local_commitment_number is the next commitment_signed number we expect to
3241                         // receive (indicating if they need to resend one that we missed).
3242                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3243                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3244                         // receive, however we track it by the next commitment number for a remote transaction
3245                         // (which is one further, as they always revoke previous commitment transaction, not
3246                         // the one we send) so we have to decrement by 1. Note that if
3247                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3248                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3249                         // overflow here.
3250                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3251                         data_loss_protect: OptionalField::Absent,
3252                 }
3253         }
3254
3255
3256         // Send stuff to our remote peers:
3257
3258         /// Adds a pending outbound HTLC to this channel, note that you probably want
3259         /// send_htlc_and_commit instead cause you'll want both messages at once.
3260         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3261         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3262         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3263         /// You MUST call send_commitment prior to any other calls on this Channel
3264         /// If an Err is returned, it's a ChannelError::Ignore!
3265         pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
3266                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3267                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3268                 }
3269
3270                 if amount_msat > self.channel_value_satoshis * 1000 {
3271                         return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3272                 }
3273                 if amount_msat < self.their_htlc_minimum_msat {
3274                         return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3275                 }
3276
3277                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3278                         // Note that this should never really happen, if we're !is_live() on receipt of an
3279                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3280                         // the user to send directly into a !is_live() channel. However, if we
3281                         // disconnected during the time the previous hop was doing the commitment dance we may
3282                         // end up getting here after the forwarding delay. In any case, returning an
3283                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3284                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3285                 }
3286
3287                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3288                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3289                         return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3290                 }
3291                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3292                 // Check their_max_htlc_value_in_flight_msat
3293                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3294                         return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight"));
3295                 }
3296
3297                 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3298                 // reserve for them to have something to claim if we misbehave)
3299                 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3300                         return Err(ChannelError::Ignore("Cannot send value that would put us over the reserve value"));
3301                 }
3302
3303                 //TODO: Check cltv_expiry? Do this in channel manager?
3304
3305                 // Now update local state:
3306                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3307                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3308                                 amount_msat: amount_msat,
3309                                 payment_hash: payment_hash,
3310                                 cltv_expiry: cltv_expiry,
3311                                 source,
3312                                 onion_routing_packet: onion_routing_packet,
3313                         });
3314                         return Ok(None);
3315                 }
3316
3317                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3318                         htlc_id: self.next_local_htlc_id,
3319                         amount_msat: amount_msat,
3320                         payment_hash: payment_hash.clone(),
3321                         cltv_expiry: cltv_expiry,
3322                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3323                         source,
3324                 });
3325
3326                 let res = msgs::UpdateAddHTLC {
3327                         channel_id: self.channel_id,
3328                         htlc_id: self.next_local_htlc_id,
3329                         amount_msat: amount_msat,
3330                         payment_hash: payment_hash,
3331                         cltv_expiry: cltv_expiry,
3332                         onion_routing_packet: onion_routing_packet,
3333                 };
3334                 self.next_local_htlc_id += 1;
3335
3336                 Ok(Some(res))
3337         }
3338
3339         /// Creates a signed commitment transaction to send to the remote peer.
3340         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3341         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3342         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3343         pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3344                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3345                         panic!("Cannot create commitment tx until channel is fully established");
3346                 }
3347                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3348                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3349                 }
3350                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3351                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3352                 }
3353                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3354                         panic!("Cannot create commitment tx while awaiting monitor update unfreeze, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3355                 }
3356                 let mut have_updates = self.pending_update_fee.is_some();
3357                 for htlc in self.pending_outbound_htlcs.iter() {
3358                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3359                                 have_updates = true;
3360                         }
3361                         if have_updates { break; }
3362                 }
3363                 for htlc in self.pending_inbound_htlcs.iter() {
3364                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3365                                 have_updates = true;
3366                         }
3367                         if have_updates { break; }
3368                 }
3369                 if !have_updates {
3370                         panic!("Cannot create commitment tx until we have some updates to send");
3371                 }
3372                 self.send_commitment_no_status_check()
3373         }
3374         /// Only fails in case of bad keys
3375         fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3376                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3377                 // fail to generate this, we still are at least at a position where upgrading their status
3378                 // is acceptable.
3379                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3380                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3381                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3382                         } else { None };
3383                         if let Some(state) = new_state {
3384                                 htlc.state = state;
3385                         }
3386                 }
3387                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3388                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3389                                 Some(fail_reason.take())
3390                         } else { None } {
3391                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3392                         }
3393                 }
3394                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3395
3396                 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3397                         Ok((res, (remote_commitment_tx, mut htlcs))) => {
3398                                 // Update state now that we've passed all the can-fail calls...
3399                                 let htlcs_no_ref = htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3400                                 (res, remote_commitment_tx, htlcs_no_ref)
3401                         },
3402                         Err(e) => return Err(e),
3403                 };
3404
3405                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx, htlcs, self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3406                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3407                 Ok((res, self.channel_monitor.clone()))
3408         }
3409
3410         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3411         /// when we shouldn't change HTLC/channel state.
3412         fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3413                 let funding_script = self.get_funding_redeemscript();
3414
3415                 let mut feerate_per_kw = self.feerate_per_kw;
3416                 if let Some(feerate) = self.pending_update_fee {
3417                         if self.channel_outbound {
3418                                 feerate_per_kw = feerate;
3419                         }
3420                 }
3421
3422                 let remote_keys = self.build_remote_transaction_keys()?;
3423                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3424                 let remote_commitment_txid = remote_commitment_tx.0.txid();
3425                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
3426                 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3427                 log_trace!(self, "Signing remote commitment tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&remote_commitment_tx.0), encode::serialize_hex(&funding_script), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize()), log_bytes!(our_sig.serialize_compact()[..]));
3428
3429                 let mut htlc_sigs = Vec::with_capacity(remote_commitment_tx.1);
3430                 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3431                         if let Some(_) = htlc.transaction_output_index {
3432                                 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3433                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3434                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
3435                                 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
3436                                 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3437                                 log_trace!(self, "Signing remote HTLC tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key).serialize()), log_bytes!(htlc_sigs.last().unwrap().serialize_compact()[..]));
3438                         }
3439                 }
3440
3441                 Ok((msgs::CommitmentSigned {
3442                         channel_id: self.channel_id,
3443                         signature: our_sig,
3444                         htlc_signatures: htlc_sigs,
3445                 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3446         }
3447
3448         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3449         /// to send to the remote peer in one go.
3450         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3451         /// more info.
3452         pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
3453                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3454                         Some(update_add_htlc) => {
3455                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3456                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3457                         },
3458                         None => Ok(None)
3459                 }
3460         }
3461
3462         /// Begins the shutdown process, getting a message for the remote peer and returning all
3463         /// holding cell HTLCs for payment failure.
3464         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3465                 for htlc in self.pending_outbound_htlcs.iter() {
3466                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3467                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3468                         }
3469                 }
3470                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3471                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3472                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3473                         }
3474                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3475                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3476                         }
3477                 }
3478                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3479                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3480                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3481                 }
3482
3483                 let our_closing_script = self.get_closing_scriptpubkey();
3484
3485                 // From here on out, we may not fail!
3486                 if self.channel_state < ChannelState::FundingSent as u32 {
3487                         self.channel_state = ChannelState::ShutdownComplete as u32;
3488                 } else {
3489                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3490                 }
3491                 self.channel_update_count += 1;
3492
3493                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3494                 // our shutdown until we've committed all of the pending changes.
3495                 self.holding_cell_update_fee = None;
3496                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3497                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3498                         match htlc_update {
3499                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3500                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3501                                         false
3502                                 },
3503                                 _ => true
3504                         }
3505                 });
3506
3507                 Ok((msgs::Shutdown {
3508                         channel_id: self.channel_id,
3509                         scriptpubkey: our_closing_script,
3510                 }, dropped_outbound_htlcs))
3511         }
3512
3513         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3514         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3515         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3516         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3517         /// immediately (others we will have to allow to time out).
3518         pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>) {
3519                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3520
3521                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3522                 // return them to fail the payment.
3523                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3524                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3525                         match htlc_update {
3526                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3527                                         dropped_outbound_htlcs.push((source, payment_hash));
3528                                 },
3529                                 _ => {}
3530                         }
3531                 }
3532
3533                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3534                         //TODO: Do something with the remaining HTLCs
3535                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3536                         //which correspond)
3537                 }
3538
3539                 self.channel_state = ChannelState::ShutdownComplete as u32;
3540                 self.channel_update_count += 1;
3541                 let mut res = Vec::new();
3542                 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3543                 (res, dropped_outbound_htlcs)
3544         }
3545 }
3546
3547 const SERIALIZATION_VERSION: u8 = 1;
3548 const MIN_SERIALIZATION_VERSION: u8 = 1;
3549
3550 impl Writeable for InboundHTLCRemovalReason {
3551         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3552                 match self {
3553                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3554                                 0u8.write(writer)?;
3555                                 error_packet.write(writer)?;
3556                         },
3557                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3558                                 1u8.write(writer)?;
3559                                 onion_hash.write(writer)?;
3560                                 err_code.write(writer)?;
3561                         },
3562                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3563                                 2u8.write(writer)?;
3564                                 payment_preimage.write(writer)?;
3565                         },
3566                 }
3567                 Ok(())
3568         }
3569 }
3570
3571 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3572         fn read(reader: &mut R) -> Result<Self, DecodeError> {
3573                 Ok(match <u8 as Readable<R>>::read(reader)? {
3574                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3575                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3576                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3577                         _ => return Err(DecodeError::InvalidValue),
3578                 })
3579         }
3580 }
3581
3582 impl Writeable for Channel {
3583         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3584                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3585                 // called but include holding cell updates (and obviously we don't modify self).
3586
3587                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3588                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3589
3590                 self.user_id.write(writer)?;
3591                 self.config.write(writer)?;
3592
3593                 self.channel_id.write(writer)?;
3594                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3595                 self.channel_outbound.write(writer)?;
3596                 self.channel_value_satoshis.write(writer)?;
3597
3598                 self.local_keys.write(writer)?;
3599                 self.shutdown_pubkey.write(writer)?;
3600
3601                 self.cur_local_commitment_transaction_number.write(writer)?;
3602                 self.cur_remote_commitment_transaction_number.write(writer)?;
3603                 self.value_to_self_msat.write(writer)?;
3604
3605                 let mut dropped_inbound_htlcs = 0;
3606                 for htlc in self.pending_inbound_htlcs.iter() {
3607                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3608                                 dropped_inbound_htlcs += 1;
3609                         }
3610                 }
3611                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3612                 for htlc in self.pending_inbound_htlcs.iter() {
3613                         htlc.htlc_id.write(writer)?;
3614                         htlc.amount_msat.write(writer)?;
3615                         htlc.cltv_expiry.write(writer)?;
3616                         htlc.payment_hash.write(writer)?;
3617                         match &htlc.state {
3618                                 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3619                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3620                                         1u8.write(writer)?;
3621                                         htlc_state.write(writer)?;
3622                                 },
3623                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3624                                         2u8.write(writer)?;
3625                                         htlc_state.write(writer)?;
3626                                 },
3627                                 &InboundHTLCState::Committed => {
3628                                         3u8.write(writer)?;
3629                                 },
3630                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3631                                         4u8.write(writer)?;
3632                                         removal_reason.write(writer)?;
3633                                 },
3634                         }
3635                 }
3636
3637                 macro_rules! write_option {
3638                         ($thing: expr) => {
3639                                 match &$thing {
3640                                         &None => 0u8.write(writer)?,
3641                                         &Some(ref v) => {
3642                                                 1u8.write(writer)?;
3643                                                 v.write(writer)?;
3644                                         },
3645                                 }
3646                         }
3647                 }
3648
3649                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3650                 for htlc in self.pending_outbound_htlcs.iter() {
3651                         htlc.htlc_id.write(writer)?;
3652                         htlc.amount_msat.write(writer)?;
3653                         htlc.cltv_expiry.write(writer)?;
3654                         htlc.payment_hash.write(writer)?;
3655                         htlc.source.write(writer)?;
3656                         match &htlc.state {
3657                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3658                                         0u8.write(writer)?;
3659                                         onion_packet.write(writer)?;
3660                                 },
3661                                 &OutboundHTLCState::Committed => {
3662                                         1u8.write(writer)?;
3663                                 },
3664                                 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3665                                         2u8.write(writer)?;
3666                                         write_option!(*fail_reason);
3667                                 },
3668                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3669                                         3u8.write(writer)?;
3670                                         write_option!(*fail_reason);
3671                                 },
3672                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3673                                         4u8.write(writer)?;
3674                                         write_option!(*fail_reason);
3675                                 },
3676                         }
3677                 }
3678
3679                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3680                 for update in self.holding_cell_htlc_updates.iter() {
3681                         match update {
3682                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3683                                         0u8.write(writer)?;
3684                                         amount_msat.write(writer)?;
3685                                         cltv_expiry.write(writer)?;
3686                                         payment_hash.write(writer)?;
3687                                         source.write(writer)?;
3688                                         onion_routing_packet.write(writer)?;
3689                                 },
3690                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3691                                         1u8.write(writer)?;
3692                                         payment_preimage.write(writer)?;
3693                                         htlc_id.write(writer)?;
3694                                 },
3695                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3696                                         2u8.write(writer)?;
3697                                         htlc_id.write(writer)?;
3698                                         err_packet.write(writer)?;
3699                                 }
3700                         }
3701                 }
3702
3703                 match self.resend_order {
3704                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3705                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3706                 }
3707
3708                 self.monitor_pending_revoke_and_ack.write(writer)?;
3709                 self.monitor_pending_commitment_signed.write(writer)?;
3710
3711                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3712                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3713                         pending_forward.write(writer)?;
3714                         htlc_id.write(writer)?;
3715                 }
3716
3717                 (self.monitor_pending_failures.len() as u64).write(writer)?;
3718                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3719                         htlc_source.write(writer)?;
3720                         payment_hash.write(writer)?;
3721                         fail_reason.write(writer)?;
3722                 }
3723
3724                 write_option!(self.pending_update_fee);
3725                 write_option!(self.holding_cell_update_fee);
3726
3727                 self.next_local_htlc_id.write(writer)?;
3728                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3729                 self.channel_update_count.write(writer)?;
3730                 self.feerate_per_kw.write(writer)?;
3731
3732                 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3733                 for tx in self.last_local_commitment_txn.iter() {
3734                         if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3735                                 match e {
3736                                         encode::Error::Io(e) => return Err(e),
3737                                         _ => panic!("last_local_commitment_txn must have been well-formed!"),
3738                                 }
3739                         }
3740                 }
3741
3742                 match self.last_sent_closing_fee {
3743                         Some((feerate, fee)) => {
3744                                 1u8.write(writer)?;
3745                                 feerate.write(writer)?;
3746                                 fee.write(writer)?;
3747                         },
3748                         None => 0u8.write(writer)?,
3749                 }
3750
3751                 write_option!(self.funding_tx_confirmed_in);
3752                 write_option!(self.short_channel_id);
3753
3754                 self.last_block_connected.write(writer)?;
3755                 self.funding_tx_confirmations.write(writer)?;
3756
3757                 self.their_dust_limit_satoshis.write(writer)?;
3758                 self.our_dust_limit_satoshis.write(writer)?;
3759                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3760                 self.their_channel_reserve_satoshis.write(writer)?;
3761                 self.their_htlc_minimum_msat.write(writer)?;
3762                 self.our_htlc_minimum_msat.write(writer)?;
3763                 self.their_to_self_delay.write(writer)?;
3764                 self.our_to_self_delay.write(writer)?;
3765                 self.their_max_accepted_htlcs.write(writer)?;
3766                 self.minimum_depth.write(writer)?;
3767
3768                 write_option!(self.their_funding_pubkey);
3769                 write_option!(self.their_revocation_basepoint);
3770                 write_option!(self.their_payment_basepoint);
3771                 write_option!(self.their_delayed_payment_basepoint);
3772                 write_option!(self.their_htlc_basepoint);
3773                 write_option!(self.their_cur_commitment_point);
3774
3775                 write_option!(self.their_prev_commitment_point);
3776                 self.their_node_id.write(writer)?;
3777
3778                 write_option!(self.their_shutdown_scriptpubkey);
3779
3780                 self.channel_monitor.write_for_disk(writer)?;
3781                 Ok(())
3782         }
3783 }
3784
3785 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3786         fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3787                 let _ver: u8 = Readable::read(reader)?;
3788                 let min_ver: u8 = Readable::read(reader)?;
3789                 if min_ver > SERIALIZATION_VERSION {
3790                         return Err(DecodeError::UnknownVersion);
3791                 }
3792
3793                 let user_id = Readable::read(reader)?;
3794                 let config: ChannelConfig = Readable::read(reader)?;
3795
3796                 let channel_id = Readable::read(reader)?;
3797                 let channel_state = Readable::read(reader)?;
3798                 let channel_outbound = Readable::read(reader)?;
3799                 let channel_value_satoshis = Readable::read(reader)?;
3800
3801                 let local_keys = Readable::read(reader)?;
3802                 let shutdown_pubkey = Readable::read(reader)?;
3803
3804                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3805                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3806                 let value_to_self_msat = Readable::read(reader)?;
3807
3808                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3809                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3810                 for _ in 0..pending_inbound_htlc_count {
3811                         pending_inbound_htlcs.push(InboundHTLCOutput {
3812                                 htlc_id: Readable::read(reader)?,
3813                                 amount_msat: Readable::read(reader)?,
3814                                 cltv_expiry: Readable::read(reader)?,
3815                                 payment_hash: Readable::read(reader)?,
3816                                 state: match <u8 as Readable<R>>::read(reader)? {
3817                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3818                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3819                                         3 => InboundHTLCState::Committed,
3820                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3821                                         _ => return Err(DecodeError::InvalidValue),
3822                                 },
3823                         });
3824                 }
3825
3826                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3827                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3828                 for _ in 0..pending_outbound_htlc_count {
3829                         pending_outbound_htlcs.push(OutboundHTLCOutput {
3830                                 htlc_id: Readable::read(reader)?,
3831                                 amount_msat: Readable::read(reader)?,
3832                                 cltv_expiry: Readable::read(reader)?,
3833                                 payment_hash: Readable::read(reader)?,
3834                                 source: Readable::read(reader)?,
3835                                 state: match <u8 as Readable<R>>::read(reader)? {
3836                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3837                                         1 => OutboundHTLCState::Committed,
3838                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
3839                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
3840                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
3841                                         _ => return Err(DecodeError::InvalidValue),
3842                                 },
3843                         });
3844                 }
3845
3846                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3847                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3848                 for _ in 0..holding_cell_htlc_update_count {
3849                         holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3850                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
3851                                         amount_msat: Readable::read(reader)?,
3852                                         cltv_expiry: Readable::read(reader)?,
3853                                         payment_hash: Readable::read(reader)?,
3854                                         source: Readable::read(reader)?,
3855                                         onion_routing_packet: Readable::read(reader)?,
3856                                 },
3857                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3858                                         payment_preimage: Readable::read(reader)?,
3859                                         htlc_id: Readable::read(reader)?,
3860                                 },
3861                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
3862                                         htlc_id: Readable::read(reader)?,
3863                                         err_packet: Readable::read(reader)?,
3864                                 },
3865                                 _ => return Err(DecodeError::InvalidValue),
3866                         });
3867                 }
3868
3869                 let resend_order = match <u8 as Readable<R>>::read(reader)? {
3870                         0 => RAACommitmentOrder::CommitmentFirst,
3871                         1 => RAACommitmentOrder::RevokeAndACKFirst,
3872                         _ => return Err(DecodeError::InvalidValue),
3873                 };
3874
3875                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3876                 let monitor_pending_commitment_signed = Readable::read(reader)?;
3877
3878                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3879                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3880                 for _ in 0..monitor_pending_forwards_count {
3881                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3882                 }
3883
3884                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3885                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3886                 for _ in 0..monitor_pending_failures_count {
3887                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3888                 }
3889
3890                 let pending_update_fee = Readable::read(reader)?;
3891                 let holding_cell_update_fee = Readable::read(reader)?;
3892
3893                 let next_local_htlc_id = Readable::read(reader)?;
3894                 let next_remote_htlc_id = Readable::read(reader)?;
3895                 let channel_update_count = Readable::read(reader)?;
3896                 let feerate_per_kw = Readable::read(reader)?;
3897
3898                 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3899                 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3900                 for _ in 0..last_local_commitment_txn_count {
3901                         last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3902                                 Ok(tx) => tx,
3903                                 Err(_) => return Err(DecodeError::InvalidValue),
3904                         });
3905                 }
3906
3907                 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3908                         0 => None,
3909                         1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3910                         _ => return Err(DecodeError::InvalidValue),
3911                 };
3912
3913                 let funding_tx_confirmed_in = Readable::read(reader)?;
3914                 let short_channel_id = Readable::read(reader)?;
3915
3916                 let last_block_connected = Readable::read(reader)?;
3917                 let funding_tx_confirmations = Readable::read(reader)?;
3918
3919                 let their_dust_limit_satoshis = Readable::read(reader)?;
3920                 let our_dust_limit_satoshis = Readable::read(reader)?;
3921                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3922                 let their_channel_reserve_satoshis = Readable::read(reader)?;
3923                 let their_htlc_minimum_msat = Readable::read(reader)?;
3924                 let our_htlc_minimum_msat = Readable::read(reader)?;
3925                 let their_to_self_delay = Readable::read(reader)?;
3926                 let our_to_self_delay = Readable::read(reader)?;
3927                 let their_max_accepted_htlcs = Readable::read(reader)?;
3928                 let minimum_depth = Readable::read(reader)?;
3929
3930                 let their_funding_pubkey = Readable::read(reader)?;
3931                 let their_revocation_basepoint = Readable::read(reader)?;
3932                 let their_payment_basepoint = Readable::read(reader)?;
3933                 let their_delayed_payment_basepoint = Readable::read(reader)?;
3934                 let their_htlc_basepoint = Readable::read(reader)?;
3935                 let their_cur_commitment_point = Readable::read(reader)?;
3936
3937                 let their_prev_commitment_point = Readable::read(reader)?;
3938                 let their_node_id = Readable::read(reader)?;
3939
3940                 let their_shutdown_scriptpubkey = Readable::read(reader)?;
3941                 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3942                 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3943                 // doing full block connection operations on the internal CHannelMonitor copies
3944                 if monitor_last_block != last_block_connected {
3945                         return Err(DecodeError::InvalidValue);
3946                 }
3947
3948                 Ok(Channel {
3949                         user_id,
3950
3951                         config,
3952                         channel_id,
3953                         channel_state,
3954                         channel_outbound,
3955                         secp_ctx: Secp256k1::new(),
3956                         channel_value_satoshis,
3957
3958                         local_keys,
3959                         shutdown_pubkey,
3960
3961                         cur_local_commitment_transaction_number,
3962                         cur_remote_commitment_transaction_number,
3963                         value_to_self_msat,
3964
3965                         pending_inbound_htlcs,
3966                         pending_outbound_htlcs,
3967                         holding_cell_htlc_updates,
3968
3969                         resend_order,
3970
3971                         monitor_pending_revoke_and_ack,
3972                         monitor_pending_commitment_signed,
3973                         monitor_pending_forwards,
3974                         monitor_pending_failures,
3975
3976                         pending_update_fee,
3977                         holding_cell_update_fee,
3978                         next_local_htlc_id,
3979                         next_remote_htlc_id,
3980                         channel_update_count,
3981                         feerate_per_kw,
3982
3983                         #[cfg(debug_assertions)]
3984                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3985                         #[cfg(debug_assertions)]
3986                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3987
3988                         last_local_commitment_txn,
3989
3990                         last_sent_closing_fee,
3991
3992                         funding_tx_confirmed_in,
3993                         short_channel_id,
3994                         last_block_connected,
3995                         funding_tx_confirmations,
3996
3997                         their_dust_limit_satoshis,
3998                         our_dust_limit_satoshis,
3999                         their_max_htlc_value_in_flight_msat,
4000                         their_channel_reserve_satoshis,
4001                         their_htlc_minimum_msat,
4002                         our_htlc_minimum_msat,
4003                         their_to_self_delay,
4004                         our_to_self_delay,
4005                         their_max_accepted_htlcs,
4006                         minimum_depth,
4007
4008                         their_funding_pubkey,
4009                         their_revocation_basepoint,
4010                         their_payment_basepoint,
4011                         their_delayed_payment_basepoint,
4012                         their_htlc_basepoint,
4013                         their_cur_commitment_point,
4014
4015                         their_prev_commitment_point,
4016                         their_node_id,
4017
4018                         their_shutdown_scriptpubkey,
4019
4020                         channel_monitor,
4021
4022                         logger,
4023                 })
4024         }
4025 }
4026
4027 #[cfg(test)]
4028 mod tests {
4029         use bitcoin::util::bip143;
4030         use bitcoin::consensus::encode::serialize;
4031         use bitcoin::blockdata::script::{Script, Builder};
4032         use bitcoin::blockdata::transaction::Transaction;
4033         use bitcoin::blockdata::opcodes;
4034         use bitcoin_hashes::hex::FromHex;
4035         use hex;
4036         use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4037         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4038         use ln::channel::MAX_FUNDING_SATOSHIS;
4039         use ln::chan_utils;
4040         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4041         use chain::keysinterface::KeysInterface;
4042         use chain::transaction::OutPoint;
4043         use util::config::UserConfig;
4044         use util::test_utils;
4045         use util::logger::Logger;
4046         use secp256k1::{Secp256k1,Message,Signature};
4047         use secp256k1::key::{SecretKey,PublicKey};
4048         use bitcoin_hashes::sha256::Hash as Sha256;
4049         use bitcoin_hashes::sha256d::Hash as Sha256dHash;
4050         use bitcoin_hashes::hash160::Hash as Hash160;
4051         use bitcoin_hashes::Hash;
4052         use std::sync::Arc;
4053
4054         struct TestFeeEstimator {
4055                 fee_est: u64
4056         }
4057         impl FeeEstimator for TestFeeEstimator {
4058                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4059                         self.fee_est
4060                 }
4061         }
4062
4063         #[test]
4064         fn test_max_funding_satoshis() {
4065                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4066                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4067         }
4068
4069         struct Keys {
4070                 chan_keys: ChannelKeys,
4071         }
4072         impl KeysInterface for Keys {
4073                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4074                 fn get_destination_script(&self) -> Script {
4075                         let secp_ctx = Secp256k1::signing_only();
4076                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4077                         let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4078                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4079                 }
4080
4081                 fn get_shutdown_pubkey(&self) -> PublicKey {
4082                         let secp_ctx = Secp256k1::signing_only();
4083                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4084                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4085                 }
4086
4087                 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
4088                 fn get_session_key(&self) -> SecretKey { panic!(); }
4089                 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4090         }
4091
4092         #[test]
4093         fn outbound_commitment_test() {
4094                 // Test vectors from BOLT 3 Appendix C:
4095                 let feeest = TestFeeEstimator{fee_est: 15000};
4096                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4097                 let secp_ctx = Secp256k1::new();
4098
4099                 let chan_keys = ChannelKeys {
4100                         funding_key: SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4101                         payment_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4102                         delayed_payment_base_key: SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4103                         htlc_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4104
4105                         // These aren't set in the test vectors:
4106                         revocation_base_key: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4107                         commitment_seed: [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff],
4108                 };
4109                 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
4110                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4111                 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
4112
4113                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4114                 let mut config = UserConfig::new();
4115                 config.channel_options.announced_channel = false;
4116                 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4117                 chan.their_to_self_delay = 144;
4118                 chan.our_dust_limit_satoshis = 546;
4119
4120                 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4121                 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
4122
4123                 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4124                 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
4125                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4126
4127                 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
4128                 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
4129                                 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4130
4131                 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4132                 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
4133                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4134
4135                 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
4136
4137                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4138                 // derived from a commitment_seed, so instead we copy it here and call
4139                 // build_commitment_transaction.
4140                 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
4141                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4142                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4143                 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
4144                 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
4145
4146                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4147
4148                 macro_rules! test_commitment {
4149                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
4150                                 unsigned_tx = {
4151                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4152                                         let htlcs = res.2.drain(..)
4153                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4154                                                 .collect();
4155                                         (res.0, htlcs)
4156                                 };
4157                                 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4158                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &chan.get_funding_redeemscript(), chan.channel_value_satoshis)[..]).unwrap();
4159                                 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
4160
4161                                 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
4162
4163                                 assert_eq!(serialize(&unsigned_tx.0)[..],
4164                                                 hex::decode($tx_hex).unwrap()[..]);
4165                         };
4166                 }
4167
4168                 macro_rules! test_htlc_output {
4169                         ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4170                                 let remote_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4171
4172                                 let ref htlc = unsigned_tx.1[$htlc_idx];
4173                                 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4174                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4175                                 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4176                                 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4177
4178                                 let mut preimage: Option<PaymentPreimage> = None;
4179                                 if !htlc.offered {
4180                                         for i in 0..5 {
4181                                                 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4182                                                 if out == htlc.payment_hash {
4183                                                         preimage = Some(PaymentPreimage([i; 32]));
4184                                                 }
4185                                         }
4186
4187                                         assert!(preimage.is_some());
4188                                 }
4189
4190                                 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
4191                                 assert_eq!(serialize(&htlc_tx)[..],
4192                                                 hex::decode($tx_hex).unwrap()[..]);
4193                         };
4194                 }
4195
4196                 {
4197                         // simple commitment tx with no HTLCs
4198                         chan.value_to_self_msat = 7000000000;
4199
4200                         test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4201                                          "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4202                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4203                 }
4204
4205                 chan.pending_inbound_htlcs.push({
4206                         let mut out = InboundHTLCOutput{
4207                                 htlc_id: 0,
4208                                 amount_msat: 1000000,
4209                                 cltv_expiry: 500,
4210                                 payment_hash: PaymentHash([0; 32]),
4211                                 state: InboundHTLCState::Committed,
4212                         };
4213                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4214                         out
4215                 });
4216                 chan.pending_inbound_htlcs.push({
4217                         let mut out = InboundHTLCOutput{
4218                                 htlc_id: 1,
4219                                 amount_msat: 2000000,
4220                                 cltv_expiry: 501,
4221                                 payment_hash: PaymentHash([0; 32]),
4222                                 state: InboundHTLCState::Committed,
4223                         };
4224                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4225                         out
4226                 });
4227                 chan.pending_outbound_htlcs.push({
4228                         let mut out = OutboundHTLCOutput{
4229                                 htlc_id: 2,
4230                                 amount_msat: 2000000,
4231                                 cltv_expiry: 502,
4232                                 payment_hash: PaymentHash([0; 32]),
4233                                 state: OutboundHTLCState::Committed,
4234                                 source: HTLCSource::dummy(),
4235                         };
4236                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4237                         out
4238                 });
4239                 chan.pending_outbound_htlcs.push({
4240                         let mut out = OutboundHTLCOutput{
4241                                 htlc_id: 3,
4242                                 amount_msat: 3000000,
4243                                 cltv_expiry: 503,
4244                                 payment_hash: PaymentHash([0; 32]),
4245                                 state: OutboundHTLCState::Committed,
4246                                 source: HTLCSource::dummy(),
4247                         };
4248                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4249                         out
4250                 });
4251                 chan.pending_inbound_htlcs.push({
4252                         let mut out = InboundHTLCOutput{
4253                                 htlc_id: 4,
4254                                 amount_msat: 4000000,
4255                                 cltv_expiry: 504,
4256                                 payment_hash: PaymentHash([0; 32]),
4257                                 state: InboundHTLCState::Committed,
4258                         };
4259                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4260                         out
4261                 });
4262
4263                 {
4264                         // commitment tx with all five HTLCs untrimmed (minimum feerate)
4265                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4266                         chan.feerate_per_kw = 0;
4267
4268                         test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4269                                          "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4270                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4271
4272                         assert_eq!(unsigned_tx.1.len(), 5);
4273
4274                         test_htlc_output!(0,
4275                                           "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4276                                           "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4277                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4278
4279                         test_htlc_output!(1,
4280                                           "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4281                                           "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4282                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4283
4284                         test_htlc_output!(2,
4285                                           "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4286                                           "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4287                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4288
4289                         test_htlc_output!(3,
4290                                           "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4291                                           "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4292                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4293
4294                         test_htlc_output!(4,
4295                                           "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4296                                           "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4297                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4298                 }
4299
4300                 {
4301                         // commitment tx with seven outputs untrimmed (maximum feerate)
4302                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4303                         chan.feerate_per_kw = 647;
4304
4305                         test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4306                                          "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4307                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4308
4309                         assert_eq!(unsigned_tx.1.len(), 5);
4310
4311                         test_htlc_output!(0,
4312                                           "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4313                                           "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4314                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4315
4316                         test_htlc_output!(1,
4317                                           "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4318                                           "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4319                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4320
4321                         test_htlc_output!(2,
4322                                           "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4323                                           "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4324                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4325
4326                         test_htlc_output!(3,
4327                                           "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4328                                           "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4329                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4330
4331                         test_htlc_output!(4,
4332                                           "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4333                                           "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4334                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4335                 }
4336
4337                 {
4338                         // commitment tx with six outputs untrimmed (minimum feerate)
4339                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4340                         chan.feerate_per_kw = 648;
4341
4342                         test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4343                                          "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4344                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4345
4346                         assert_eq!(unsigned_tx.1.len(), 4);
4347
4348                         test_htlc_output!(0,
4349                                           "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4350                                           "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4351                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4352
4353                         test_htlc_output!(1,
4354                                           "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4355                                           "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4356                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4357
4358                         test_htlc_output!(2,
4359                                           "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4360                                           "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4361                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4362
4363                         test_htlc_output!(3,
4364                                           "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4365                                           "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4366                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4367                 }
4368
4369                 {
4370                         // commitment tx with six outputs untrimmed (maximum feerate)
4371                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4372                         chan.feerate_per_kw = 2069;
4373
4374                         test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4375                                          "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4376                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4377
4378                         assert_eq!(unsigned_tx.1.len(), 4);
4379
4380                         test_htlc_output!(0,
4381                                           "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4382                                           "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4383                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4384
4385                         test_htlc_output!(1,
4386                                           "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4387                                           "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4388                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4389
4390                         test_htlc_output!(2,
4391                                           "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4392                                           "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4393                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4394
4395                         test_htlc_output!(3,
4396                                           "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4397                                           "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4398                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4399                 }
4400
4401                 {
4402                         // commitment tx with five outputs untrimmed (minimum feerate)
4403                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4404                         chan.feerate_per_kw = 2070;
4405
4406                         test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4407                                          "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4408                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4409
4410                         assert_eq!(unsigned_tx.1.len(), 3);
4411
4412                         test_htlc_output!(0,
4413                                           "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4414                                           "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4415                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4416
4417                         test_htlc_output!(1,
4418                                           "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4419                                           "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4420                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4421
4422                         test_htlc_output!(2,
4423                                           "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4424                                           "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4425                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4426                 }
4427
4428                 {
4429                         // commitment tx with five outputs untrimmed (maximum feerate)
4430                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4431                         chan.feerate_per_kw = 2194;
4432
4433                         test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4434                                          "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4435                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4436
4437                         assert_eq!(unsigned_tx.1.len(), 3);
4438
4439                         test_htlc_output!(0,
4440                                           "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4441                                           "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4442                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4443
4444                         test_htlc_output!(1,
4445                                           "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4446                                           "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4447                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4448
4449                         test_htlc_output!(2,
4450                                           "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4451                                           "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4452                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4453                 }
4454
4455                 {
4456                         // commitment tx with four outputs untrimmed (minimum feerate)
4457                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4458                         chan.feerate_per_kw = 2195;
4459
4460                         test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4461                                          "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4462                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4463
4464                         assert_eq!(unsigned_tx.1.len(), 2);
4465
4466                         test_htlc_output!(0,
4467                                           "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4468                                           "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4469                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4470
4471                         test_htlc_output!(1,
4472                                           "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4473                                           "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4474                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4475                 }
4476
4477                 {
4478                         // commitment tx with four outputs untrimmed (maximum feerate)
4479                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4480                         chan.feerate_per_kw = 3702;
4481
4482                         test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4483                                          "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4484                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4485
4486                         assert_eq!(unsigned_tx.1.len(), 2);
4487
4488                         test_htlc_output!(0,
4489                                           "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4490                                           "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4491                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4492
4493                         test_htlc_output!(1,
4494                                           "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4495                                           "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4496                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4497                 }
4498
4499                 {
4500                         // commitment tx with three outputs untrimmed (minimum feerate)
4501                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4502                         chan.feerate_per_kw = 3703;
4503
4504                         test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4505                                          "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4506                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4507
4508                         assert_eq!(unsigned_tx.1.len(), 1);
4509
4510                         test_htlc_output!(0,
4511                                           "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4512                                           "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4513                                           "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4514                 }
4515
4516                 {
4517                         // commitment tx with three outputs untrimmed (maximum feerate)
4518                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4519                         chan.feerate_per_kw = 4914;
4520
4521                         test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4522                                          "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4523                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4524
4525                         assert_eq!(unsigned_tx.1.len(), 1);
4526
4527                         test_htlc_output!(0,
4528                                           "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4529                                           "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4530                                           "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4531                 }
4532
4533                 {
4534                         // commitment tx with two outputs untrimmed (minimum feerate)
4535                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4536                         chan.feerate_per_kw = 4915;
4537
4538                         test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4539                                          "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4540                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4541
4542                         assert_eq!(unsigned_tx.1.len(), 0);
4543                 }
4544
4545                 {
4546                         // commitment tx with two outputs untrimmed (maximum feerate)
4547                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4548                         chan.feerate_per_kw = 9651180;
4549
4550                         test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4551                                          "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4552                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4553
4554                         assert_eq!(unsigned_tx.1.len(), 0);
4555                 }
4556
4557                 {
4558                         // commitment tx with one output untrimmed (minimum feerate)
4559                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4560                         chan.feerate_per_kw = 9651181;
4561
4562                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4563                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4564                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4565
4566                         assert_eq!(unsigned_tx.1.len(), 0);
4567                 }
4568
4569                 {
4570                         // commitment tx with fee greater than funder amount
4571                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4572                         chan.feerate_per_kw = 9651936;
4573
4574                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4575                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4576                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4577
4578                         assert_eq!(unsigned_tx.1.len(), 0);
4579                 }
4580         }
4581
4582         #[test]
4583         fn test_per_commitment_secret_gen() {
4584                 // Test vectors from BOLT 3 Appendix D:
4585
4586                 let mut seed = [0; 32];
4587                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4588                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4589                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4590
4591                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4592                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4593                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4594
4595                 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4596                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4597
4598                 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4599                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4600
4601                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4602                 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4603                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4604         }
4605
4606         #[test]
4607         fn test_key_derivation() {
4608                 // Test vectors from BOLT 3 Appendix E:
4609                 let secp_ctx = Secp256k1::new();
4610
4611                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4612                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4613
4614                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4615                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4616
4617                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4618                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4619
4620                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4621                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4622
4623                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4624                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4625
4626                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4627                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4628
4629                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4630                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
4631         }
4632 }