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