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