57da708baf503ce473807c164bb2a5c21af38206
[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::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{Transaction, SigHashType};
12 use bitcoin::util::bip143;
13 use bitcoin::consensus::encode;
14
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
19
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
24
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, InitFeatures};
27 use ln::msgs;
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::{self, ShutdownScript};
30 use ln::channelmanager::{CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
32 use ln::chan_utils;
33 use chain::BestBlock;
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
39 use util::logger::Logger;
40 use util::errors::APIError;
41 use util::config::{UserConfig,ChannelConfig};
42 use util::scid_utils::scid_from_parts;
43
44 use io;
45 use prelude::*;
46 use core::{cmp,mem,fmt};
47 use core::ops::Deref;
48 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
49 use sync::Mutex;
50 use bitcoin::hashes::hex::ToHex;
51
52 #[cfg(test)]
53 pub struct ChannelValueStat {
54         pub value_to_self_msat: u64,
55         pub channel_value_msat: u64,
56         pub channel_reserve_msat: u64,
57         pub pending_outbound_htlcs_amount_msat: u64,
58         pub pending_inbound_htlcs_amount_msat: u64,
59         pub holding_cell_outbound_amount_msat: u64,
60         pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
61         pub counterparty_dust_limit_msat: u64,
62 }
63
64 #[derive(Clone, Copy, PartialEq)]
65 enum FeeUpdateState {
66         // Inbound states mirroring InboundHTLCState
67         RemoteAnnounced,
68         AwaitingRemoteRevokeToAnnounce,
69         // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
70         // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
71         // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
72         // the fee update anywhere, we can simply consider the fee update `Committed` immediately
73         // instead of setting it to AwaitingAnnouncedRemoteRevoke.
74
75         // Outbound state can only be `LocalAnnounced` or `Committed`
76         Outbound,
77 }
78
79 enum InboundHTLCRemovalReason {
80         FailRelay(msgs::OnionErrorPacket),
81         FailMalformed(([u8; 32], u16)),
82         Fulfill(PaymentPreimage),
83 }
84
85 enum InboundHTLCState {
86         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
87         /// update_add_htlc message for this HTLC.
88         RemoteAnnounced(PendingHTLCStatus),
89         /// Included in a received commitment_signed message (implying we've
90         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
91         /// state (see the example below). We have not yet included this HTLC in a
92         /// commitment_signed message because we are waiting on the remote's
93         /// aforementioned state revocation. One reason this missing remote RAA
94         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
95         /// is because every time we create a new "state", i.e. every time we sign a
96         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
97         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
98         /// sent provided the per_commitment_point for our current commitment tx.
99         /// The other reason we should not send a commitment_signed without their RAA
100         /// is because their RAA serves to ACK our previous commitment_signed.
101         ///
102         /// Here's an example of how an HTLC could come to be in this state:
103         /// remote --> update_add_htlc(prev_htlc)   --> local
104         /// remote --> commitment_signed(prev_htlc) --> local
105         /// remote <-- revoke_and_ack               <-- local
106         /// remote <-- commitment_signed(prev_htlc) <-- local
107         /// [note that here, the remote does not respond with a RAA]
108         /// remote --> update_add_htlc(this_htlc)   --> local
109         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
110         /// Now `this_htlc` will be assigned this state. It's unable to be officially
111         /// accepted, i.e. included in a commitment_signed, because we're missing the
112         /// RAA that provides our next per_commitment_point. The per_commitment_point
113         /// is used to derive commitment keys, which are used to construct the
114         /// signatures in a commitment_signed message.
115         /// Implies AwaitingRemoteRevoke.
116         ///
117         /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
118         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
119         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
120         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
121         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
122         /// channel (before it can then get forwarded and/or removed).
123         /// Implies AwaitingRemoteRevoke.
124         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
125         Committed,
126         /// Removed by us and a new commitment_signed was sent (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'll drop it.
129         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
130         /// commitment transaction without it as otherwise we'll have to force-close the channel to
131         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
132         /// anyway). That said, ChannelMonitor does this for us (see
133         /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
134         /// our own local state before then, once we're sure that the next commitment_signed and
135         /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
136         LocalRemoved(InboundHTLCRemovalReason),
137 }
138
139 struct InboundHTLCOutput {
140         htlc_id: u64,
141         amount_msat: u64,
142         cltv_expiry: u32,
143         payment_hash: PaymentHash,
144         state: InboundHTLCState,
145 }
146
147 enum OutboundHTLCState {
148         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
149         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
150         /// we will promote to Committed (note that they may not accept it until the next time we
151         /// revoke, but we don't really care about that:
152         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
153         ///    money back (though we won't), and,
154         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
155         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
156         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
157         ///    we'll never get out of sync).
158         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
159         /// OutboundHTLCOutput's size just for a temporary bit
160         LocalAnnounced(Box<msgs::OnionPacket>),
161         Committed,
162         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
163         /// the change (though they'll need to revoke before we fail the payment).
164         RemoteRemoved(Option<HTLCFailReason>),
165         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
166         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
167         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
168         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
169         /// remote revoke_and_ack on a previous state before we can do so.
170         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
171         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
172         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
173         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
174         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
175         /// revoke_and_ack to drop completely.
176         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
177 }
178
179 struct OutboundHTLCOutput {
180         htlc_id: u64,
181         amount_msat: u64,
182         cltv_expiry: u32,
183         payment_hash: PaymentHash,
184         state: OutboundHTLCState,
185         source: HTLCSource,
186 }
187
188 /// See AwaitingRemoteRevoke ChannelState for more info
189 enum HTLCUpdateAwaitingACK {
190         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
191                 // always outbound
192                 amount_msat: u64,
193                 cltv_expiry: u32,
194                 payment_hash: PaymentHash,
195                 source: HTLCSource,
196                 onion_routing_packet: msgs::OnionPacket,
197         },
198         ClaimHTLC {
199                 payment_preimage: PaymentPreimage,
200                 htlc_id: u64,
201         },
202         FailHTLC {
203                 htlc_id: u64,
204                 err_packet: msgs::OnionErrorPacket,
205         },
206 }
207
208 /// There are a few "states" and then a number of flags which can be applied:
209 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
210 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
211 /// move on to ChannelFunded.
212 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
213 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
214 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
215 enum ChannelState {
216         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
217         OurInitSent = 1 << 0,
218         /// Implies we have received their open_channel/accept_channel message
219         TheirInitSent = 1 << 1,
220         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
221         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
222         /// upon receipt of funding_created, so simply skip this state.
223         FundingCreated = 4,
224         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
225         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
226         /// and our counterparty consider the funding transaction confirmed.
227         FundingSent = 8,
228         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
229         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
230         TheirFundingLocked = 1 << 4,
231         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
232         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
233         OurFundingLocked = 1 << 5,
234         ChannelFunded = 64,
235         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
236         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
237         /// dance.
238         PeerDisconnected = 1 << 7,
239         /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
240         /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
241         /// outbound messages until they've managed to do so.
242         MonitorUpdateFailed = 1 << 8,
243         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
244         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
245         /// messages as then we will be unable to determine which HTLCs they included in their
246         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
247         /// later.
248         /// Flag is set on ChannelFunded.
249         AwaitingRemoteRevoke = 1 << 9,
250         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
251         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
252         /// to respond with our own shutdown message when possible.
253         RemoteShutdownSent = 1 << 10,
254         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
255         /// point, we may not add any new HTLCs to the channel.
256         LocalShutdownSent = 1 << 11,
257         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
258         /// to drop us, but we store this anyway.
259         ShutdownComplete = 4096,
260 }
261 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
262 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
263
264 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
265
266 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
267 /// our counterparty or not. However, we don't want to announce updates right away to avoid
268 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
269 /// our channel_update message and track the current state here.
270 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
271 #[derive(Clone, Copy, PartialEq)]
272 pub(super) enum ChannelUpdateStatus {
273         /// We've announced the channel as enabled and are connected to our peer.
274         Enabled,
275         /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
276         DisabledStaged,
277         /// Our channel is live again, but we haven't announced the channel as enabled yet.
278         EnabledStaged,
279         /// We've announced the channel as disabled.
280         Disabled,
281 }
282
283 /// An enum indicating whether the local or remote side offered a given HTLC.
284 enum HTLCInitiator {
285         LocalOffered,
286         RemoteOffered,
287 }
288
289 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
290 struct HTLCStats {
291         pending_htlcs: u32,
292         pending_htlcs_value_msat: u64,
293         on_counterparty_tx_dust_exposure_msat: u64,
294         on_holder_tx_dust_exposure_msat: u64,
295 }
296
297 /// Used when calculating whether we or the remote can afford an additional HTLC.
298 struct HTLCCandidate {
299         amount_msat: u64,
300         origin: HTLCInitiator,
301 }
302
303 impl HTLCCandidate {
304         fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
305                 Self {
306                         amount_msat,
307                         origin,
308                 }
309         }
310 }
311
312 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
313 /// description
314 enum UpdateFulfillFetch {
315         NewClaim {
316                 monitor_update: ChannelMonitorUpdate,
317                 htlc_value_msat: u64,
318                 msg: Option<msgs::UpdateFulfillHTLC>,
319         },
320         DuplicateClaim {},
321 }
322
323 /// The return type of get_update_fulfill_htlc_and_commit.
324 pub enum UpdateFulfillCommitFetch {
325         /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
326         /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
327         /// previously placed in the holding cell (and has since been removed).
328         NewClaim {
329                 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
330                 monitor_update: ChannelMonitorUpdate,
331                 /// The value of the HTLC which was claimed, in msat.
332                 htlc_value_msat: u64,
333                 /// The update_fulfill message and commitment_signed message (if the claim was not placed
334                 /// in the holding cell).
335                 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
336         },
337         /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
338         /// or has been forgotten (presumably previously claimed).
339         DuplicateClaim {},
340 }
341
342 /// If the majority of the channels funds are to the fundee and the initiator holds only just
343 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
344 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
345 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
346 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
347 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
348 /// by this multiple without hitting this case, before sending.
349 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
350 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
351 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
352 /// leave the channel less usable as we hold a bigger reserve.
353 #[cfg(fuzzing)]
354 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
355 #[cfg(not(fuzzing))]
356 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
357
358 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
359 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
360 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
361 // inbound channel.
362 //
363 // Holder designates channel data owned for the benefice of the user client.
364 // Counterparty designates channel data owned by the another channel participant entity.
365 pub(super) struct Channel<Signer: Sign> {
366         #[cfg(any(test, feature = "_test_utils"))]
367         pub(crate) config: ChannelConfig,
368         #[cfg(not(any(test, feature = "_test_utils")))]
369         config: ChannelConfig,
370
371         user_id: u64,
372
373         channel_id: [u8; 32],
374         channel_state: u32,
375         secp_ctx: Secp256k1<secp256k1::All>,
376         channel_value_satoshis: u64,
377
378         latest_monitor_update_id: u64,
379
380         holder_signer: Signer,
381         shutdown_scriptpubkey: Option<ShutdownScript>,
382         destination_script: Script,
383
384         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
385         // generation start at 0 and count up...this simplifies some parts of implementation at the
386         // cost of others, but should really just be changed.
387
388         cur_holder_commitment_transaction_number: u64,
389         cur_counterparty_commitment_transaction_number: u64,
390         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
391         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
392         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
393         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
394
395         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
396         /// need to ensure we resend them in the order we originally generated them. Note that because
397         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
398         /// sufficient to simply set this to the opposite of any message we are generating as we
399         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
400         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
401         /// send it first.
402         resend_order: RAACommitmentOrder,
403
404         monitor_pending_funding_locked: bool,
405         monitor_pending_revoke_and_ack: bool,
406         monitor_pending_commitment_signed: bool,
407         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
408         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
409
410         // pending_update_fee is filled when sending and receiving update_fee.
411         //
412         // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
413         // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
414         // generating new commitment transactions with exactly the same criteria as inbound/outbound
415         // HTLCs with similar state.
416         pending_update_fee: Option<(u32, FeeUpdateState)>,
417         // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
418         // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
419         // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
420         // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
421         // further `send_update_fee` calls, dropping the previous holding cell update entirely.
422         holding_cell_update_fee: Option<u32>,
423         next_holder_htlc_id: u64,
424         next_counterparty_htlc_id: u64,
425         update_time_counter: u32,
426         feerate_per_kw: u32,
427
428         #[cfg(debug_assertions)]
429         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
430         holder_max_commitment_tx_output: Mutex<(u64, u64)>,
431         #[cfg(debug_assertions)]
432         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
433         counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
434
435         last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
436         target_closing_feerate_sats_per_kw: Option<u32>,
437
438         /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
439         /// update, we need to delay processing it until later. We do that here by simply storing the
440         /// closing_signed message and handling it in `maybe_propose_closing_signed`.
441         pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
442
443         /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
444         /// transaction. These are set once we reach `closing_negotiation_ready`.
445         #[cfg(test)]
446         pub(crate) closing_fee_limits: Option<(u64, u64)>,
447         #[cfg(not(test))]
448         closing_fee_limits: Option<(u64, u64)>,
449
450         /// The hash of the block in which the funding transaction was included.
451         funding_tx_confirmed_in: Option<BlockHash>,
452         funding_tx_confirmation_height: u32,
453         short_channel_id: Option<u64>,
454
455         counterparty_dust_limit_satoshis: u64,
456         #[cfg(test)]
457         pub(super) holder_dust_limit_satoshis: u64,
458         #[cfg(not(test))]
459         holder_dust_limit_satoshis: u64,
460         #[cfg(test)]
461         pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
462         #[cfg(not(test))]
463         counterparty_max_htlc_value_in_flight_msat: u64,
464         //get_holder_max_htlc_value_in_flight_msat(): u64,
465         /// minimum channel reserve for self to maintain - set by them.
466         counterparty_selected_channel_reserve_satoshis: Option<u64>,
467         // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
468         counterparty_htlc_minimum_msat: u64,
469         holder_htlc_minimum_msat: u64,
470         #[cfg(test)]
471         pub counterparty_max_accepted_htlcs: u16,
472         #[cfg(not(test))]
473         counterparty_max_accepted_htlcs: u16,
474         //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
475         minimum_depth: Option<u32>,
476
477         counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
478
479         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
480         funding_transaction: Option<Transaction>,
481
482         counterparty_cur_commitment_point: Option<PublicKey>,
483         counterparty_prev_commitment_point: Option<PublicKey>,
484         counterparty_node_id: PublicKey,
485
486         counterparty_shutdown_scriptpubkey: Option<Script>,
487
488         commitment_secrets: CounterpartyCommitmentSecrets,
489
490         channel_update_status: ChannelUpdateStatus,
491         /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
492         /// not complete within a single timer tick (one minute), we should force-close the channel.
493         /// This prevents us from keeping unusable channels around forever if our counterparty wishes
494         /// to DoS us.
495         /// Note that this field is reset to false on deserialization to give us a chance to connect to
496         /// our peer and start the closing_signed negotiation fresh.
497         closing_signed_in_flight: bool,
498
499         /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
500         /// This can be used to rebroadcast the channel_announcement message later.
501         announcement_sigs: Option<(Signature, Signature)>,
502
503         // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
504         // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
505         // be, by comparing the cached values to the fee of the tranaction generated by
506         // `build_commitment_transaction`.
507         #[cfg(any(test, feature = "fuzztarget"))]
508         next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
509         #[cfg(any(test, feature = "fuzztarget"))]
510         next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
511
512         /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
513         /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
514         /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
515         /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
516         /// message until we receive a channel_reestablish.
517         ///
518         /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
519         pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
520
521         #[cfg(any(test, feature = "fuzztarget"))]
522         // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
523         // corresponding HTLC on the inbound path. If, then, the outbound path channel is
524         // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
525         // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
526         // is fine, but as a sanity check in our failure to generate the second claim, we check here
527         // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
528         historical_inbound_htlc_fulfills: HashSet<u64>,
529 }
530
531 #[cfg(any(test, feature = "fuzztarget"))]
532 struct CommitmentTxInfoCached {
533         fee: u64,
534         total_pending_htlcs: usize,
535         next_holder_htlc_id: u64,
536         next_counterparty_htlc_id: u64,
537         feerate: u32,
538 }
539
540 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
541
542 #[cfg(not(test))]
543 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
544 #[cfg(test)]
545 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
546 #[cfg(not(test))]
547 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
548 #[cfg(test)]
549 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
550
551 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
552
553 /// Maximum `funding_satoshis` value, according to the BOLT #2 specification
554 /// it's 2^24.
555 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
556
557 /// The maximum network dust limit for standard script formats. This currently represents the
558 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
559 /// transaction non-standard and thus refuses to relay it.
560 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
561 /// implementations use this value for their dust limit today.
562 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
563
564 /// The maximum channel dust limit we will accept from our counterparty.
565 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
566
567 /// The dust limit is used for both the commitment transaction outputs as well as the closing
568 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
569 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
570 /// In order to avoid having to concern ourselves with standardness during the closing process, we
571 /// simply require our counterparty to use a dust limit which will leave any segwit output
572 /// standard.
573 /// See https://github.com/lightningnetwork/lightning-rfc/issues/905 for more details.
574 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 354;
575
576 /// Used to return a simple Error back to ChannelManager. Will get converted to a
577 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
578 /// channel_id in ChannelManager.
579 pub(super) enum ChannelError {
580         Ignore(String),
581         Warn(String),
582         Close(String),
583         CloseDelayBroadcast(String),
584 }
585
586 impl fmt::Debug for ChannelError {
587         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
588                 match self {
589                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
590                         &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
591                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
592                         &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
593                 }
594         }
595 }
596
597 macro_rules! secp_check {
598         ($res: expr, $err: expr) => {
599                 match $res {
600                         Ok(thing) => thing,
601                         Err(_) => return Err(ChannelError::Close($err)),
602                 }
603         };
604 }
605
606 impl<Signer: Sign> Channel<Signer> {
607         // Convert constants + channel value to limits:
608         fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
609                 channel_value_satoshis * 1000 / 10 //TODO
610         }
611
612         /// Returns a minimum channel reserve value the remote needs to maintain,
613         /// required by us.
614         ///
615         /// Guaranteed to return a value no larger than channel_value_satoshis
616         pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
617                 let (q, _) = channel_value_satoshis.overflowing_div(100);
618                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
619         }
620
621         // Constructors:
622         pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
623         where K::Target: KeysInterface<Signer = Signer>,
624               F::Target: FeeEstimator,
625         {
626                 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
627                 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
628                 let pubkeys = holder_signer.pubkeys().clone();
629
630                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
631                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
632                 }
633                 let channel_value_msat = channel_value_satoshis * 1000;
634                 if push_msat > channel_value_msat {
635                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
636                 }
637                 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
638                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
639                 }
640                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
641                 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
642                         return Err(APIError::APIMisuseError { err: format!("Holder selected channel  reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
643                 }
644
645                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
646
647                 let mut secp_ctx = Secp256k1::new();
648                 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
649
650                 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
651                         Some(keys_provider.get_shutdown_scriptpubkey())
652                 } else { None };
653
654                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
655                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
656                                 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
657                         }
658                 }
659
660                 Ok(Channel {
661                         user_id,
662                         config: config.channel_options.clone(),
663
664                         channel_id: keys_provider.get_secure_random_bytes(),
665                         channel_state: ChannelState::OurInitSent as u32,
666                         secp_ctx,
667                         channel_value_satoshis,
668
669                         latest_monitor_update_id: 0,
670
671                         holder_signer,
672                         shutdown_scriptpubkey,
673                         destination_script: keys_provider.get_destination_script(),
674
675                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
676                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
677                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
678
679                         pending_inbound_htlcs: Vec::new(),
680                         pending_outbound_htlcs: Vec::new(),
681                         holding_cell_htlc_updates: Vec::new(),
682                         pending_update_fee: None,
683                         holding_cell_update_fee: None,
684                         next_holder_htlc_id: 0,
685                         next_counterparty_htlc_id: 0,
686                         update_time_counter: 1,
687
688                         resend_order: RAACommitmentOrder::CommitmentFirst,
689
690                         monitor_pending_funding_locked: false,
691                         monitor_pending_revoke_and_ack: false,
692                         monitor_pending_commitment_signed: false,
693                         monitor_pending_forwards: Vec::new(),
694                         monitor_pending_failures: Vec::new(),
695
696                         #[cfg(debug_assertions)]
697                         holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
698                         #[cfg(debug_assertions)]
699                         counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
700
701                         last_sent_closing_fee: None,
702                         pending_counterparty_closing_signed: None,
703                         closing_fee_limits: None,
704                         target_closing_feerate_sats_per_kw: None,
705
706                         funding_tx_confirmed_in: None,
707                         funding_tx_confirmation_height: 0,
708                         short_channel_id: None,
709
710                         feerate_per_kw: feerate,
711                         counterparty_dust_limit_satoshis: 0,
712                         holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
713                         counterparty_max_htlc_value_in_flight_msat: 0,
714                         counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
715                         counterparty_htlc_minimum_msat: 0,
716                         holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
717                         counterparty_max_accepted_htlcs: 0,
718                         minimum_depth: None, // Filled in in accept_channel
719
720                         counterparty_forwarding_info: None,
721
722                         channel_transaction_parameters: ChannelTransactionParameters {
723                                 holder_pubkeys: pubkeys,
724                                 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
725                                 is_outbound_from_holder: true,
726                                 counterparty_parameters: None,
727                                 funding_outpoint: None
728                         },
729                         funding_transaction: None,
730
731                         counterparty_cur_commitment_point: None,
732                         counterparty_prev_commitment_point: None,
733                         counterparty_node_id,
734
735                         counterparty_shutdown_scriptpubkey: None,
736
737                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
738
739                         channel_update_status: ChannelUpdateStatus::Enabled,
740                         closing_signed_in_flight: false,
741
742                         announcement_sigs: None,
743
744                         #[cfg(any(test, feature = "fuzztarget"))]
745                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
746                         #[cfg(any(test, feature = "fuzztarget"))]
747                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
748
749                         workaround_lnd_bug_4006: None,
750
751                         #[cfg(any(test, feature = "fuzztarget"))]
752                         historical_inbound_htlc_fulfills: HashSet::new(),
753                 })
754         }
755
756         fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
757                 where F::Target: FeeEstimator
758         {
759                 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
760                 if feerate_per_kw < lower_limit {
761                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
762                 }
763                 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
764                 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
765                 // We generally don't care too much if they set the feerate to something very high, but it
766                 // could result in the channel being useless due to everything being dust.
767                 let upper_limit = cmp::max(250 * 25,
768                         fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
769                 if feerate_per_kw as u64 > upper_limit {
770                         return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
771                 }
772                 Ok(())
773         }
774
775         /// Creates a new channel from a remote sides' request for one.
776         /// Assumes chain_hash has already been checked and corresponds with what we expect!
777         pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, ChannelError>
778                 where K::Target: KeysInterface<Signer = Signer>,
779           F::Target: FeeEstimator
780         {
781                 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
782                 let pubkeys = holder_signer.pubkeys().clone();
783                 let counterparty_pubkeys = ChannelPublicKeys {
784                         funding_pubkey: msg.funding_pubkey,
785                         revocation_basepoint: msg.revocation_basepoint,
786                         payment_point: msg.payment_point,
787                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
788                         htlc_basepoint: msg.htlc_basepoint
789                 };
790                 let mut local_config = (*config).channel_options.clone();
791
792                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
793                         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)));
794                 }
795
796                 // Check sanity of message fields:
797                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
798                         return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
799                 }
800                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
801                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
802                 }
803                 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
804                 if msg.push_msat > funding_value {
805                         return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
806                 }
807                 if msg.dust_limit_satoshis > msg.funding_satoshis {
808                         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)));
809                 }
810                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
811                         return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
812                 }
813                 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
814                 if msg.htlc_minimum_msat >= full_channel_value_msat {
815                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
816                 }
817                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
818
819                 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
820                 if msg.to_self_delay > max_counterparty_selected_contest_delay {
821                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_counterparty_selected_contest_delay, msg.to_self_delay)));
822                 }
823                 if msg.max_accepted_htlcs < 1 {
824                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
825                 }
826                 if msg.max_accepted_htlcs > MAX_HTLCS {
827                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
828                 }
829
830                 // Now check against optional parameters as set by config...
831                 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
832                         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)));
833                 }
834                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
835                         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)));
836                 }
837                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
838                         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)));
839                 }
840                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
841                         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)));
842                 }
843                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
844                         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)));
845                 }
846                 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
847                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
848                 }
849                 if msg.dust_limit_satoshis >  MAX_CHAN_DUST_LIMIT_SATOSHIS {
850                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
851                 }
852
853                 // Convert things into internal flags and prep our state:
854
855                 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
856                 if config.peer_channel_config_limits.force_announced_channel_preference {
857                         if local_config.announced_channel != announce {
858                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
859                         }
860                 }
861                 // we either accept their preference or the preferences match
862                 local_config.announced_channel = announce;
863
864                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
865
866                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
867                 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
868                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
869                 }
870                 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
871                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
872                 }
873                 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
874                         return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", msg.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
875                 }
876
877                 // check if the funder's amount for the initial commitment tx is sufficient
878                 // for full fee payment
879                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
880                 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
881                 if funders_amount_msat < lower_limit {
882                         return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
883                 }
884
885                 let to_local_msat = msg.push_msat;
886                 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
887                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
888                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
889                 }
890
891                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
892                         match &msg.shutdown_scriptpubkey {
893                                 &OptionalField::Present(ref script) => {
894                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
895                                         if script.len() == 0 {
896                                                 None
897                                         } else {
898                                                 if !script::is_bolt2_compliant(&script, their_features) {
899                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
900                                                 }
901                                                 Some(script.clone())
902                                         }
903                                 },
904                                 // 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
905                                 &OptionalField::Absent => {
906                                         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()));
907                                 }
908                         }
909                 } else { None };
910
911                 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
912                         Some(keys_provider.get_shutdown_scriptpubkey())
913                 } else { None };
914
915                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
916                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
917                                 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
918                         }
919                 }
920
921                 let mut secp_ctx = Secp256k1::new();
922                 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
923
924                 let chan = Channel {
925                         user_id,
926                         config: local_config,
927
928                         channel_id: msg.temporary_channel_id,
929                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
930                         secp_ctx,
931
932                         latest_monitor_update_id: 0,
933
934                         holder_signer,
935                         shutdown_scriptpubkey,
936                         destination_script: keys_provider.get_destination_script(),
937
938                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
939                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
940                         value_to_self_msat: msg.push_msat,
941
942                         pending_inbound_htlcs: Vec::new(),
943                         pending_outbound_htlcs: Vec::new(),
944                         holding_cell_htlc_updates: Vec::new(),
945                         pending_update_fee: None,
946                         holding_cell_update_fee: None,
947                         next_holder_htlc_id: 0,
948                         next_counterparty_htlc_id: 0,
949                         update_time_counter: 1,
950
951                         resend_order: RAACommitmentOrder::CommitmentFirst,
952
953                         monitor_pending_funding_locked: false,
954                         monitor_pending_revoke_and_ack: false,
955                         monitor_pending_commitment_signed: false,
956                         monitor_pending_forwards: Vec::new(),
957                         monitor_pending_failures: Vec::new(),
958
959                         #[cfg(debug_assertions)]
960                         holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
961                         #[cfg(debug_assertions)]
962                         counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
963
964                         last_sent_closing_fee: None,
965                         pending_counterparty_closing_signed: None,
966                         closing_fee_limits: None,
967                         target_closing_feerate_sats_per_kw: None,
968
969                         funding_tx_confirmed_in: None,
970                         funding_tx_confirmation_height: 0,
971                         short_channel_id: None,
972
973                         feerate_per_kw: msg.feerate_per_kw,
974                         channel_value_satoshis: msg.funding_satoshis,
975                         counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
976                         holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
977                         counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
978                         counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
979                         counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
980                         holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
981                         counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
982                         minimum_depth: Some(config.own_channel_config.minimum_depth),
983
984                         counterparty_forwarding_info: None,
985
986                         channel_transaction_parameters: ChannelTransactionParameters {
987                                 holder_pubkeys: pubkeys,
988                                 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
989                                 is_outbound_from_holder: false,
990                                 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
991                                         selected_contest_delay: msg.to_self_delay,
992                                         pubkeys: counterparty_pubkeys,
993                                 }),
994                                 funding_outpoint: None
995                         },
996                         funding_transaction: None,
997
998                         counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
999                         counterparty_prev_commitment_point: None,
1000                         counterparty_node_id,
1001
1002                         counterparty_shutdown_scriptpubkey,
1003
1004                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1005
1006                         channel_update_status: ChannelUpdateStatus::Enabled,
1007                         closing_signed_in_flight: false,
1008
1009                         announcement_sigs: None,
1010
1011                         #[cfg(any(test, feature = "fuzztarget"))]
1012                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1013                         #[cfg(any(test, feature = "fuzztarget"))]
1014                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1015
1016                         workaround_lnd_bug_4006: None,
1017
1018                         #[cfg(any(test, feature = "fuzztarget"))]
1019                         historical_inbound_htlc_fulfills: HashSet::new(),
1020                 };
1021
1022                 Ok(chan)
1023         }
1024
1025         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1026         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1027         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1028         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1029         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1030         /// an HTLC to a).
1031         /// @local is used only to convert relevant internal structures which refer to remote vs local
1032         /// to decide value of outputs and direction of HTLCs.
1033         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1034         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1035         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1036         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1037         /// which peer generated this transaction and "to whom" this transaction flows.
1038         /// Returns (the transaction info, the number of HTLC outputs which were present in the
1039         /// transaction, the list of HTLCs which were not ignored when building the transaction).
1040         /// Note that below-dust HTLCs are included in the fourth return value, but not the third, and
1041         /// sources are provided only for outbound HTLCs in the fourth return value.
1042         #[inline]
1043         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> (CommitmentTransaction, u32, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
1044                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1045                 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1046                 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1047
1048                 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1049                 let mut remote_htlc_total_msat = 0;
1050                 let mut local_htlc_total_msat = 0;
1051                 let mut value_to_self_msat_offset = 0;
1052
1053                 let mut feerate_per_kw = self.feerate_per_kw;
1054                 if let Some((feerate, update_state)) = self.pending_update_fee {
1055                         if match update_state {
1056                                 // Note that these match the inclusion criteria when scanning
1057                                 // pending_inbound_htlcs below.
1058                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1059                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1060                                 FeeUpdateState::Outbound => { assert!(self.is_outbound());  generated_by_local },
1061                         } {
1062                                 feerate_per_kw = feerate;
1063                         }
1064                 }
1065
1066                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1067                         commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1068                         get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1069                         log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1070
1071                 macro_rules! get_htlc_in_commitment {
1072                         ($htlc: expr, $offered: expr) => {
1073                                 HTLCOutputInCommitment {
1074                                         offered: $offered,
1075                                         amount_msat: $htlc.amount_msat,
1076                                         cltv_expiry: $htlc.cltv_expiry,
1077                                         payment_hash: $htlc.payment_hash,
1078                                         transaction_output_index: None
1079                                 }
1080                         }
1081                 }
1082
1083                 macro_rules! add_htlc_output {
1084                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1085                                 if $outbound == local { // "offered HTLC output"
1086                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1087                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1088                                                 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);
1089                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1090                                         } else {
1091                                                 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);
1092                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1093                                         }
1094                                 } else {
1095                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1096                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1097                                                 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);
1098                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1099                                         } else {
1100                                                 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);
1101                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1102                                         }
1103                                 }
1104                         }
1105                 }
1106
1107                 for ref htlc in self.pending_inbound_htlcs.iter() {
1108                         let (include, state_name) = match htlc.state {
1109                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1110                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1111                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1112                                 InboundHTLCState::Committed => (true, "Committed"),
1113                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1114                         };
1115
1116                         if include {
1117                                 add_htlc_output!(htlc, false, None, state_name);
1118                                 remote_htlc_total_msat += htlc.amount_msat;
1119                         } else {
1120                                 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);
1121                                 match &htlc.state {
1122                                         &InboundHTLCState::LocalRemoved(ref reason) => {
1123                                                 if generated_by_local {
1124                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1125                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
1126                                                         }
1127                                                 }
1128                                         },
1129                                         _ => {},
1130                                 }
1131                         }
1132                 }
1133
1134                 for ref htlc in self.pending_outbound_htlcs.iter() {
1135                         let (include, state_name) = match htlc.state {
1136                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1137                                 OutboundHTLCState::Committed => (true, "Committed"),
1138                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1139                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1140                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1141                         };
1142
1143                         if include {
1144                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1145                                 local_htlc_total_msat += htlc.amount_msat;
1146                         } else {
1147                                 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);
1148                                 match htlc.state {
1149                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1150                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
1151                                         },
1152                                         OutboundHTLCState::RemoteRemoved(None) => {
1153                                                 if !generated_by_local {
1154                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
1155                                                 }
1156                                         },
1157                                         _ => {},
1158                                 }
1159                         }
1160                 }
1161
1162                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1163                 assert!(value_to_self_msat >= 0);
1164                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1165                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1166                 // "violate" their reserve value by couting those against it. Thus, we have to convert
1167                 // everything to i64 before subtracting as otherwise we can overflow.
1168                 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;
1169                 assert!(value_to_remote_msat >= 0);
1170
1171                 #[cfg(debug_assertions)]
1172                 {
1173                         // Make sure that the to_self/to_remote is always either past the appropriate
1174                         // channel_reserve *or* it is making progress towards it.
1175                         let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1176                                 self.holder_max_commitment_tx_output.lock().unwrap()
1177                         } else {
1178                                 self.counterparty_max_commitment_tx_output.lock().unwrap()
1179                         };
1180                         debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis.unwrap() as i64);
1181                         broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1182                         debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
1183                         broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1184                 }
1185
1186                 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (included_non_dust_htlcs.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1187                 let (value_to_self, value_to_remote) = if self.is_outbound() {
1188                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1189                 } else {
1190                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1191                 };
1192
1193                 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1194                 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1195                 let (funding_pubkey_a, funding_pubkey_b) = if local {
1196                         (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
1197                 } else {
1198                         (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
1199                 };
1200
1201                 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1202                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1203                 } else {
1204                         value_to_a = 0;
1205                 }
1206
1207                 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1208                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1209                 } else {
1210                         value_to_b = 0;
1211                 }
1212
1213                 let num_nondust_htlcs = included_non_dust_htlcs.len();
1214
1215                 let channel_parameters =
1216                         if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1217                         else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1218                 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1219                                                                              value_to_a as u64,
1220                                                                              value_to_b as u64,
1221                                                                              false,
1222                                                                              funding_pubkey_a,
1223                                                                              funding_pubkey_b,
1224                                                                              keys.clone(),
1225                                                                              feerate_per_kw,
1226                                                                              &mut included_non_dust_htlcs,
1227                                                                              &channel_parameters
1228                 );
1229                 let mut htlcs_included = included_non_dust_htlcs;
1230                 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1231                 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1232                 htlcs_included.append(&mut included_dust_htlcs);
1233
1234                 (tx, feerate_per_kw, num_nondust_htlcs, htlcs_included)
1235         }
1236
1237         #[inline]
1238         fn get_closing_scriptpubkey(&self) -> Script {
1239                 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1240                 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1241                 // outside of those situations will fail.
1242                 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1243         }
1244
1245         #[inline]
1246         fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1247                 let mut ret =
1248                 (4 +                                           // version
1249                  1 +                                           // input count
1250                  36 +                                          // prevout
1251                  1 +                                           // script length (0)
1252                  4 +                                           // sequence
1253                  1 +                                           // output count
1254                  4                                             // lock time
1255                  )*4 +                                         // * 4 for non-witness parts
1256                 2 +                                            // witness marker and flag
1257                 1 +                                            // witness element count
1258                 4 +                                            // 4 element lengths (2 sigs, multisig dummy, and witness script)
1259                 self.get_funding_redeemscript().len() as u64 + // funding witness script
1260                 2*(1 + 71);                                    // two signatures + sighash type flags
1261                 if let Some(spk) = a_scriptpubkey {
1262                         ret += ((8+1) +                            // output values and script length
1263                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1264                 }
1265                 if let Some(spk) = b_scriptpubkey {
1266                         ret += ((8+1) +                            // output values and script length
1267                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1268                 }
1269                 ret
1270         }
1271
1272         #[inline]
1273         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
1274                 assert!(self.pending_inbound_htlcs.is_empty());
1275                 assert!(self.pending_outbound_htlcs.is_empty());
1276                 assert!(self.pending_update_fee.is_none());
1277
1278                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1279                 let mut value_to_holder: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1280                 let mut value_to_counterparty: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1281
1282                 if value_to_holder < 0 {
1283                         assert!(self.is_outbound());
1284                         total_fee_satoshis += (-value_to_holder) as u64;
1285                 } else if value_to_counterparty < 0 {
1286                         assert!(!self.is_outbound());
1287                         total_fee_satoshis += (-value_to_counterparty) as u64;
1288                 }
1289
1290                 if skip_remote_output || value_to_counterparty as u64 <= self.holder_dust_limit_satoshis {
1291                         value_to_counterparty = 0;
1292                 }
1293
1294                 if value_to_holder as u64 <= self.holder_dust_limit_satoshis {
1295                         value_to_holder = 0;
1296                 }
1297
1298                 assert!(self.shutdown_scriptpubkey.is_some());
1299                 let holder_shutdown_script = self.get_closing_scriptpubkey();
1300                 let counterparty_shutdown_script = self.counterparty_shutdown_scriptpubkey.clone().unwrap();
1301                 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
1302
1303                 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
1304                 (closing_transaction, total_fee_satoshis)
1305         }
1306
1307         fn funding_outpoint(&self) -> OutPoint {
1308                 self.channel_transaction_parameters.funding_outpoint.unwrap()
1309         }
1310
1311         #[inline]
1312         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1313         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1314         /// our counterparty!)
1315         /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1316         /// TODO Some magic rust shit to compile-time check this?
1317         fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1318                 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1319                 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1320                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1321                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1322
1323                 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys".to_owned()))
1324         }
1325
1326         #[inline]
1327         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1328         /// will sign and send to our counterparty.
1329         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1330         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1331                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1332                 //may see payments to it!
1333                 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1334                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1335                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1336
1337                 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &self.counterparty_cur_commitment_point.unwrap(), &counterparty_pubkeys.delayed_payment_basepoint, &counterparty_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint), "Remote tx keys generation got bogus keys".to_owned()))
1338         }
1339
1340         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1341         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1342         /// Panics if called before accept_channel/new_from_req
1343         pub fn get_funding_redeemscript(&self) -> Script {
1344                 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1345         }
1346
1347         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1348                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1349                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1350                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1351                 // either.
1352                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1353                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1354                 }
1355                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1356
1357                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1358
1359                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1360                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1361                 // these, but for now we just have to treat them as normal.
1362
1363                 let mut pending_idx = core::usize::MAX;
1364                 let mut htlc_value_msat = 0;
1365                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1366                         if htlc.htlc_id == htlc_id_arg {
1367                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1368                                 match htlc.state {
1369                                         InboundHTLCState::Committed => {},
1370                                         InboundHTLCState::LocalRemoved(ref reason) => {
1371                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1372                                                 } else {
1373                                                         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()));
1374                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1375                                                 }
1376                                                 return UpdateFulfillFetch::DuplicateClaim {};
1377                                         },
1378                                         _ => {
1379                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1380                                                 // Don't return in release mode here so that we can update channel_monitor
1381                                         }
1382                                 }
1383                                 pending_idx = idx;
1384                                 htlc_value_msat = htlc.amount_msat;
1385                                 break;
1386                         }
1387                 }
1388                 if pending_idx == core::usize::MAX {
1389                         #[cfg(any(test, feature = "fuzztarget"))]
1390                         // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1391                         // this is simply a duplicate claim, not previously failed and we lost funds.
1392                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1393                         return UpdateFulfillFetch::DuplicateClaim {};
1394                 }
1395
1396                 // Now update local state:
1397                 //
1398                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1399                 // can claim it even if the channel hits the chain before we see their next commitment.
1400                 self.latest_monitor_update_id += 1;
1401                 let monitor_update = ChannelMonitorUpdate {
1402                         update_id: self.latest_monitor_update_id,
1403                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1404                                 payment_preimage: payment_preimage_arg.clone(),
1405                         }],
1406                 };
1407
1408                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1409                         for pending_update in self.holding_cell_htlc_updates.iter() {
1410                                 match pending_update {
1411                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1412                                                 if htlc_id_arg == htlc_id {
1413                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
1414                                                         self.latest_monitor_update_id -= 1;
1415                                                         #[cfg(any(test, feature = "fuzztarget"))]
1416                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1417                                                         return UpdateFulfillFetch::DuplicateClaim {};
1418                                                 }
1419                                         },
1420                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1421                                                 if htlc_id_arg == htlc_id {
1422                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1423                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1424                                                         // rare enough it may not be worth the complexity burden.
1425                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1426                                                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1427                                                 }
1428                                         },
1429                                         _ => {}
1430                                 }
1431                         }
1432                         log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1433                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1434                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1435                         });
1436                         #[cfg(any(test, feature = "fuzztarget"))]
1437                         self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1438                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1439                 }
1440                 #[cfg(any(test, feature = "fuzztarget"))]
1441                 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1442
1443                 {
1444                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1445                         if let InboundHTLCState::Committed = htlc.state {
1446                         } else {
1447                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1448                                 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1449                         }
1450                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1451                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1452                 }
1453
1454                 UpdateFulfillFetch::NewClaim {
1455                         monitor_update,
1456                         htlc_value_msat,
1457                         msg: Some(msgs::UpdateFulfillHTLC {
1458                                 channel_id: self.channel_id(),
1459                                 htlc_id: htlc_id_arg,
1460                                 payment_preimage: payment_preimage_arg,
1461                         }),
1462                 }
1463         }
1464
1465         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<UpdateFulfillCommitFetch, (ChannelError, ChannelMonitorUpdate)> where L::Target: Logger {
1466                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1467                         UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1468                                 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1469                                         Err(e) => return Err((e, monitor_update)),
1470                                         Ok(res) => res
1471                                 };
1472                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1473                                 // strictly increasing by one, so decrement it here.
1474                                 self.latest_monitor_update_id = monitor_update.update_id;
1475                                 monitor_update.updates.append(&mut additional_update.updates);
1476                                 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1477                         },
1478                         UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1479                                 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1480                         UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1481                 }
1482         }
1483
1484         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1485         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1486         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1487         /// before we fail backwards.
1488         /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1489         /// Ok(_) if debug assertions are turned on or preconditions are met.
1490         pub fn get_update_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> where L::Target: Logger {
1491                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1492                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1493                 }
1494                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1495
1496                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1497                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1498                 // these, but for now we just have to treat them as normal.
1499
1500                 let mut pending_idx = core::usize::MAX;
1501                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1502                         if htlc.htlc_id == htlc_id_arg {
1503                                 match htlc.state {
1504                                         InboundHTLCState::Committed => {},
1505                                         InboundHTLCState::LocalRemoved(ref reason) => {
1506                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1507                                                 } else {
1508                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1509                                                 }
1510                                                 return Ok(None);
1511                                         },
1512                                         _ => {
1513                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1514                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1515                                         }
1516                                 }
1517                                 pending_idx = idx;
1518                         }
1519                 }
1520                 if pending_idx == core::usize::MAX {
1521                         #[cfg(any(test, feature = "fuzztarget"))]
1522                         // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1523                         // is simply a duplicate fail, not previously failed and we failed-back too early.
1524                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1525                         return Ok(None);
1526                 }
1527
1528                 // Now update local state:
1529                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1530                         for pending_update in self.holding_cell_htlc_updates.iter() {
1531                                 match pending_update {
1532                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1533                                                 if htlc_id_arg == htlc_id {
1534                                                         #[cfg(any(test, feature = "fuzztarget"))]
1535                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1536                                                         return Ok(None);
1537                                                 }
1538                                         },
1539                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1540                                                 if htlc_id_arg == htlc_id {
1541                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1542                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1543                                                 }
1544                                         },
1545                                         _ => {}
1546                                 }
1547                         }
1548                         log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1549                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1550                                 htlc_id: htlc_id_arg,
1551                                 err_packet,
1552                         });
1553                         return Ok(None);
1554                 }
1555
1556                 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1557                 {
1558                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1559                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1560                 }
1561
1562                 Ok(Some(msgs::UpdateFailHTLC {
1563                         channel_id: self.channel_id(),
1564                         htlc_id: htlc_id_arg,
1565                         reason: err_packet
1566                 }))
1567         }
1568
1569         // Message handlers:
1570
1571         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: &InitFeatures) -> Result<(), ChannelError> {
1572                 // Check sanity of message fields:
1573                 if !self.is_outbound() {
1574                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1575                 }
1576                 if self.channel_state != ChannelState::OurInitSent as u32 {
1577                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1578                 }
1579                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1580                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1581                 }
1582                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1583                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1584                 }
1585                 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1586                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? channel_reserve_satoshis was ({}). dust_limit is ({})", msg.channel_reserve_satoshis, self.holder_dust_limit_satoshis)));
1587                 }
1588                 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1589                 if msg.dust_limit_satoshis > remote_reserve {
1590                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1591                 }
1592                 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1593                 if msg.htlc_minimum_msat >= full_channel_value_msat {
1594                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1595                 }
1596                 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1597                 if msg.to_self_delay > max_delay_acceptable {
1598                         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)));
1599                 }
1600                 if msg.max_accepted_htlcs < 1 {
1601                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1602                 }
1603                 if msg.max_accepted_htlcs > MAX_HTLCS {
1604                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1605                 }
1606
1607                 // Now check against optional parameters as set by config...
1608                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1609                         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)));
1610                 }
1611                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1612                         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)));
1613                 }
1614                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1615                         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)));
1616                 }
1617                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1618                         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)));
1619                 }
1620                 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1621                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1622                 }
1623                 if msg.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
1624                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1625                 }
1626                 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1627                         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)));
1628                 }
1629                 if msg.minimum_depth == 0 {
1630                         // Note that if this changes we should update the serialization minimum version to
1631                         // indicate to older clients that they don't understand some features of the current
1632                         // channel.
1633                         return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1634                 }
1635
1636                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1637                         match &msg.shutdown_scriptpubkey {
1638                                 &OptionalField::Present(ref script) => {
1639                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1640                                         if script.len() == 0 {
1641                                                 None
1642                                         } else {
1643                                                 if !script::is_bolt2_compliant(&script, their_features) {
1644                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
1645                                                 }
1646                                                 Some(script.clone())
1647                                         }
1648                                 },
1649                                 // 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
1650                                 &OptionalField::Absent => {
1651                                         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()));
1652                                 }
1653                         }
1654                 } else { None };
1655
1656                 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1657                 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1658                 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1659                 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1660                 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1661                 self.minimum_depth = Some(msg.minimum_depth);
1662
1663                 let counterparty_pubkeys = ChannelPublicKeys {
1664                         funding_pubkey: msg.funding_pubkey,
1665                         revocation_basepoint: msg.revocation_basepoint,
1666                         payment_point: msg.payment_point,
1667                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1668                         htlc_basepoint: msg.htlc_basepoint
1669                 };
1670
1671                 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1672                         selected_contest_delay: msg.to_self_delay,
1673                         pubkeys: counterparty_pubkeys,
1674                 });
1675
1676                 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1677                 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1678
1679                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1680
1681                 Ok(())
1682         }
1683
1684         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1685                 let funding_script = self.get_funding_redeemscript();
1686
1687                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1688                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).0;
1689                 {
1690                         let trusted_tx = initial_commitment_tx.trust();
1691                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1692                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1693                         // They sign the holder commitment transaction...
1694                         log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1695                                 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1696                                 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1697                                 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1698                         secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1699                 }
1700
1701                 let counterparty_keys = self.build_remote_transaction_keys()?;
1702                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1703
1704                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1705                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1706                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1707                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1708
1709                 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1710                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1711
1712                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1713                 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1714         }
1715
1716         fn counterparty_funding_pubkey(&self) -> &PublicKey {
1717                 &self.get_counterparty_pubkeys().funding_pubkey
1718         }
1719
1720         pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, best_block: BestBlock, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError> where L::Target: Logger {
1721                 if self.is_outbound() {
1722                         return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1723                 }
1724                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1725                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1726                         // remember the channel, so it's safe to just send an error_message here and drop the
1727                         // channel.
1728                         return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1729                 }
1730                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1731                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1732                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1733                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1734                 }
1735
1736                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1737                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1738                 // This is an externally observable change before we finish all our checks.  In particular
1739                 // funding_created_signature may fail.
1740                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1741
1742                 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1743                         Ok(res) => res,
1744                         Err(ChannelError::Close(e)) => {
1745                                 self.channel_transaction_parameters.funding_outpoint = None;
1746                                 return Err(ChannelError::Close(e));
1747                         },
1748                         Err(e) => {
1749                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
1750                                 // to make sure we don't continue with an inconsistent state.
1751                                 panic!("unexpected error type from funding_created_signature {:?}", e);
1752                         }
1753                 };
1754
1755                 let holder_commitment_tx = HolderCommitmentTransaction::new(
1756                         initial_commitment_tx,
1757                         msg.signature,
1758                         Vec::new(),
1759                         &self.get_holder_pubkeys().funding_pubkey,
1760                         self.counterparty_funding_pubkey()
1761                 );
1762
1763                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1764                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1765
1766                 // Now that we're past error-generating stuff, update our local state:
1767
1768                 let funding_redeemscript = self.get_funding_redeemscript();
1769                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1770                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1771                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1772                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1773                                                           shutdown_script, self.get_holder_selected_contest_delay(),
1774                                                           &self.destination_script, (funding_txo, funding_txo_script.clone()),
1775                                                           &self.channel_transaction_parameters,
1776                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
1777                                                           obscure_factor,
1778                                                           holder_commitment_tx, best_block);
1779
1780                 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_commitment_txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1781
1782                 self.channel_state = ChannelState::FundingSent as u32;
1783                 self.channel_id = funding_txo.to_channel_id();
1784                 self.cur_counterparty_commitment_transaction_number -= 1;
1785                 self.cur_holder_commitment_transaction_number -= 1;
1786
1787                 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1788
1789                 Ok((msgs::FundingSigned {
1790                         channel_id: self.channel_id,
1791                         signature
1792                 }, channel_monitor))
1793         }
1794
1795         /// Handles a funding_signed message from the remote end.
1796         /// If this call is successful, broadcast the funding transaction (and not before!)
1797         pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, best_block: BestBlock, logger: &L) -> Result<(ChannelMonitor<Signer>, Transaction), ChannelError> where L::Target: Logger {
1798                 if !self.is_outbound() {
1799                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1800                 }
1801                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1802                         return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1803                 }
1804                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1805                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1806                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1807                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1808                 }
1809
1810                 let funding_script = self.get_funding_redeemscript();
1811
1812                 let counterparty_keys = self.build_remote_transaction_keys()?;
1813                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1814                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1815                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1816
1817                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1818                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1819
1820                 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1821                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).0;
1822                 {
1823                         let trusted_tx = initial_commitment_tx.trust();
1824                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1825                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1826                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1827                         if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1828                                 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1829                         }
1830                 }
1831
1832                 let holder_commitment_tx = HolderCommitmentTransaction::new(
1833                         initial_commitment_tx,
1834                         msg.signature,
1835                         Vec::new(),
1836                         &self.get_holder_pubkeys().funding_pubkey,
1837                         self.counterparty_funding_pubkey()
1838                 );
1839
1840                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1841                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1842
1843
1844                 let funding_redeemscript = self.get_funding_redeemscript();
1845                 let funding_txo = self.get_funding_txo().unwrap();
1846                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1847                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1848                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1849                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1850                                                           shutdown_script, self.get_holder_selected_contest_delay(),
1851                                                           &self.destination_script, (funding_txo, funding_txo_script),
1852                                                           &self.channel_transaction_parameters,
1853                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
1854                                                           obscure_factor,
1855                                                           holder_commitment_tx, best_block);
1856
1857                 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_bitcoin_tx.txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1858
1859                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1860                 self.channel_state = ChannelState::FundingSent as u32;
1861                 self.cur_holder_commitment_transaction_number -= 1;
1862                 self.cur_counterparty_commitment_transaction_number -= 1;
1863
1864                 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1865
1866                 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1867         }
1868
1869         pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1870                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1871                         self.workaround_lnd_bug_4006 = Some(msg.clone());
1872                         return Err(ChannelError::Ignore("Peer sent funding_locked when we needed a channel_reestablish. The peer is likely lnd, see https://github.com/lightningnetwork/lnd/issues/4006".to_owned()));
1873                 }
1874
1875                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1876
1877                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1878                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1879                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1880                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1881                         self.update_time_counter += 1;
1882                 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1883                                  // Note that funding_signed/funding_created will have decremented both by 1!
1884                                  self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1885                                  self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1886                                 // If we reconnected before sending our funding locked they may still resend theirs:
1887                                 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1888                                                       (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1889                         if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1890                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1891                         }
1892                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1893                         return Ok(());
1894                 } else {
1895                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1896                 }
1897
1898                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1899                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1900
1901                 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1902
1903                 Ok(())
1904         }
1905
1906         /// Returns a HTLCStats about inbound pending htlcs
1907         fn get_inbound_pending_htlc_stats(&self) -> HTLCStats {
1908                 let mut stats = HTLCStats {
1909                         pending_htlcs: self.pending_inbound_htlcs.len() as u32,
1910                         pending_htlcs_value_msat: 0,
1911                         on_counterparty_tx_dust_exposure_msat: 0,
1912                         on_holder_tx_dust_exposure_msat: 0,
1913                 };
1914
1915                 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1916                 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1917                 for ref htlc in self.pending_inbound_htlcs.iter() {
1918                         stats.pending_htlcs_value_msat += htlc.amount_msat;
1919                         if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
1920                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1921                         }
1922                         if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
1923                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1924                         }
1925                 }
1926                 stats
1927         }
1928
1929         /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
1930         fn get_outbound_pending_htlc_stats(&self) -> HTLCStats {
1931                 let mut stats = HTLCStats {
1932                         pending_htlcs: self.pending_outbound_htlcs.len() as u32,
1933                         pending_htlcs_value_msat: 0,
1934                         on_counterparty_tx_dust_exposure_msat: 0,
1935                         on_holder_tx_dust_exposure_msat: 0,
1936                 };
1937
1938                 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1939                 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1940                 for ref htlc in self.pending_outbound_htlcs.iter() {
1941                         stats.pending_htlcs_value_msat += htlc.amount_msat;
1942                         if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
1943                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1944                         }
1945                         if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
1946                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1947                         }
1948                 }
1949
1950                 for update in self.holding_cell_htlc_updates.iter() {
1951                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1952                                 stats.pending_htlcs += 1;
1953                                 stats.pending_htlcs_value_msat += amount_msat;
1954                                 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
1955                                         stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
1956                                 }
1957                                 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
1958                                         stats.on_holder_tx_dust_exposure_msat += amount_msat;
1959                                 }
1960                         }
1961                 }
1962                 stats
1963         }
1964
1965         /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1966         /// Doesn't bother handling the
1967         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1968         /// corner case properly.
1969         pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1970                 // Note that we have to handle overflow due to the above case.
1971                 (
1972                         cmp::max(self.channel_value_satoshis as i64 * 1000
1973                                 - self.value_to_self_msat as i64
1974                                 - self.get_inbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1975                                 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1976                         0) as u64,
1977                         cmp::max(self.value_to_self_msat as i64
1978                                 - self.get_outbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1979                                 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1980                         0) as u64
1981                 )
1982         }
1983
1984         pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1985                 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1986                 self.counterparty_selected_channel_reserve_satoshis)
1987         }
1988
1989         // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1990         // Note that num_htlcs should not include dust HTLCs.
1991         fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1992                 // Note that we need to divide before multiplying to round properly,
1993                 // since the lowest denomination of bitcoin on-chain is the satoshi.
1994                 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1995         }
1996
1997         // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1998         // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1999         // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2000         // are excluded.
2001         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2002                 assert!(self.is_outbound());
2003
2004                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2005                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2006
2007                 let mut addl_htlcs = 0;
2008                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2009                 match htlc.origin {
2010                         HTLCInitiator::LocalOffered => {
2011                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2012                                         addl_htlcs += 1;
2013                                 }
2014                         },
2015                         HTLCInitiator::RemoteOffered => {
2016                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2017                                         addl_htlcs += 1;
2018                                 }
2019                         }
2020                 }
2021
2022                 let mut included_htlcs = 0;
2023                 for ref htlc in self.pending_inbound_htlcs.iter() {
2024                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2025                                 continue
2026                         }
2027                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2028                         // transaction including this HTLC if it times out before they RAA.
2029                         included_htlcs += 1;
2030                 }
2031
2032                 for ref htlc in self.pending_outbound_htlcs.iter() {
2033                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2034                                 continue
2035                         }
2036                         match htlc.state {
2037                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2038                                 OutboundHTLCState::Committed => included_htlcs += 1,
2039                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2040                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2041                                 // transaction won't be generated until they send us their next RAA, which will mean
2042                                 // dropping any HTLCs in this state.
2043                                 _ => {},
2044                         }
2045                 }
2046
2047                 for htlc in self.holding_cell_htlc_updates.iter() {
2048                         match htlc {
2049                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2050                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
2051                                                 continue
2052                                         }
2053                                         included_htlcs += 1
2054                                 },
2055                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2056                                          // ack we're guaranteed to never include them in commitment txs anymore.
2057                         }
2058                 }
2059
2060                 let num_htlcs = included_htlcs + addl_htlcs;
2061                 let res = self.commit_tx_fee_msat(num_htlcs);
2062                 #[cfg(any(test, feature = "fuzztarget"))]
2063                 {
2064                         let mut fee = res;
2065                         if fee_spike_buffer_htlc.is_some() {
2066                                 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2067                         }
2068                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2069                                 + self.holding_cell_htlc_updates.len();
2070                         let commitment_tx_info = CommitmentTxInfoCached {
2071                                 fee,
2072                                 total_pending_htlcs,
2073                                 next_holder_htlc_id: match htlc.origin {
2074                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2075                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2076                                 },
2077                                 next_counterparty_htlc_id: match htlc.origin {
2078                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2079                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2080                                 },
2081                                 feerate: self.feerate_per_kw,
2082                         };
2083                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2084                 }
2085                 res
2086         }
2087
2088         // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2089         // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2090         // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2091         // excluded.
2092         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2093                 assert!(!self.is_outbound());
2094
2095                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2096                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2097
2098                 let mut addl_htlcs = 0;
2099                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2100                 match htlc.origin {
2101                         HTLCInitiator::LocalOffered => {
2102                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2103                                         addl_htlcs += 1;
2104                                 }
2105                         },
2106                         HTLCInitiator::RemoteOffered => {
2107                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2108                                         addl_htlcs += 1;
2109                                 }
2110                         }
2111                 }
2112
2113                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2114                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2115                 // committed outbound HTLCs, see below.
2116                 let mut included_htlcs = 0;
2117                 for ref htlc in self.pending_inbound_htlcs.iter() {
2118                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2119                                 continue
2120                         }
2121                         included_htlcs += 1;
2122                 }
2123
2124                 for ref htlc in self.pending_outbound_htlcs.iter() {
2125                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2126                                 continue
2127                         }
2128                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2129                         // i.e. if they've responded to us with an RAA after announcement.
2130                         match htlc.state {
2131                                 OutboundHTLCState::Committed => included_htlcs += 1,
2132                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2133                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2134                                 _ => {},
2135                         }
2136                 }
2137
2138                 let num_htlcs = included_htlcs + addl_htlcs;
2139                 let res = self.commit_tx_fee_msat(num_htlcs);
2140                 #[cfg(any(test, feature = "fuzztarget"))]
2141                 {
2142                         let mut fee = res;
2143                         if fee_spike_buffer_htlc.is_some() {
2144                                 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2145                         }
2146                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2147                         let commitment_tx_info = CommitmentTxInfoCached {
2148                                 fee,
2149                                 total_pending_htlcs,
2150                                 next_holder_htlc_id: match htlc.origin {
2151                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2152                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2153                                 },
2154                                 next_counterparty_htlc_id: match htlc.origin {
2155                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2156                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2157                                 },
2158                                 feerate: self.feerate_per_kw,
2159                         };
2160                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2161                 }
2162                 res
2163         }
2164
2165         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>
2166         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2167                 // We can't accept HTLCs sent after we've sent a shutdown.
2168                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2169                 if local_sent_shutdown {
2170                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x4000|8);
2171                 }
2172                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2173                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2174                 if remote_sent_shutdown {
2175                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2176                 }
2177                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2178                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2179                 }
2180                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2181                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2182                 }
2183                 if msg.amount_msat == 0 {
2184                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2185                 }
2186                 if msg.amount_msat < self.holder_htlc_minimum_msat {
2187                         return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.holder_htlc_minimum_msat, msg.amount_msat)));
2188                 }
2189
2190                 let inbound_stats = self.get_inbound_pending_htlc_stats();
2191                 let outbound_stats = self.get_outbound_pending_htlc_stats();
2192                 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2193                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2194                 }
2195                 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2196                 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2197                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2198                 }
2199                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2200                 // the reserve_satoshis we told them to always have as direct payment so that they lose
2201                 // something if we punish them for broadcasting an old state).
2202                 // Note that we don't really care about having a small/no to_remote output in our local
2203                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2204                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2205                 // present in the next commitment transaction we send them (at least for fulfilled ones,
2206                 // failed ones won't modify value_to_self).
2207                 // Note that we will send HTLCs which another instance of rust-lightning would think
2208                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2209                 // Channel state once they will not be present in the next received commitment
2210                 // transaction).
2211                 let mut removed_outbound_total_msat = 0;
2212                 for ref htlc in self.pending_outbound_htlcs.iter() {
2213                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2214                                 removed_outbound_total_msat += htlc.amount_msat;
2215                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2216                                 removed_outbound_total_msat += htlc.amount_msat;
2217                         }
2218                 }
2219
2220                 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2221                 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2222                         let on_counterparty_tx_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + msg.amount_msat;
2223                         if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2224                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2225                                         on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2226                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2227                         }
2228                 }
2229
2230                 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2231                 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2232                         let on_holder_tx_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + msg.amount_msat;
2233                         if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2234                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2235                                         on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2236                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2237                         }
2238                 }
2239
2240                 let pending_value_to_self_msat =
2241                         self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2242                 let pending_remote_value_msat =
2243                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2244                 if pending_remote_value_msat < msg.amount_msat {
2245                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2246                 }
2247
2248                 // Check that the remote can afford to pay for this HTLC on-chain at the current
2249                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2250                 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2251                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2252                         self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2253                 };
2254                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2255                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2256                 };
2257
2258                 let chan_reserve_msat =
2259                         Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2260                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2261                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2262                 }
2263
2264                 if !self.is_outbound() {
2265                         // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2266                         // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2267                         // receiver's side, only on the sender's.
2268                         // Note that when we eventually remove support for fee updates and switch to anchor output
2269                         // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2270                         // the extra htlc when calculating the next remote commitment transaction fee as we should
2271                         // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2272                         // sensitive to fee spikes.
2273                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2274                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2275                         if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2276                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2277                                 // the HTLC, i.e. its status is already set to failing.
2278                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2279                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2280                         }
2281                 } else {
2282                         // Check that they won't violate our local required channel reserve by adding this HTLC.
2283                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2284                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2285                         if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2286                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2287                         }
2288                 }
2289                 if self.next_counterparty_htlc_id != msg.htlc_id {
2290                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2291                 }
2292                 if msg.cltv_expiry >= 500000000 {
2293                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2294                 }
2295
2296                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2297                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2298                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2299                         }
2300                 }
2301
2302                 // Now update local state:
2303                 self.next_counterparty_htlc_id += 1;
2304                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2305                         htlc_id: msg.htlc_id,
2306                         amount_msat: msg.amount_msat,
2307                         payment_hash: msg.payment_hash,
2308                         cltv_expiry: msg.cltv_expiry,
2309                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2310                 });
2311                 Ok(())
2312         }
2313
2314         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2315         #[inline]
2316         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2317                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2318                         if htlc.htlc_id == htlc_id {
2319                                 match check_preimage {
2320                                         None => {},
2321                                         Some(payment_hash) =>
2322                                                 if payment_hash != htlc.payment_hash {
2323                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2324                                                 }
2325                                 };
2326                                 match htlc.state {
2327                                         OutboundHTLCState::LocalAnnounced(_) =>
2328                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2329                                         OutboundHTLCState::Committed => {
2330                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2331                                         },
2332                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2333                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2334                                 }
2335                                 return Ok(htlc);
2336                         }
2337                 }
2338                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2339         }
2340
2341         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2342                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2343                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2344                 }
2345                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2346                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2347                 }
2348
2349                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2350                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2351         }
2352
2353         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2354                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2355                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2356                 }
2357                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2358                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2359                 }
2360
2361                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2362                 Ok(())
2363         }
2364
2365         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2366                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2367                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2368                 }
2369                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2370                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2371                 }
2372
2373                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2374                 Ok(())
2375         }
2376
2377         pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2378                 where L::Target: Logger
2379         {
2380                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2381                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2382                 }
2383                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2384                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2385                 }
2386                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2387                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2388                 }
2389
2390                 let funding_script = self.get_funding_redeemscript();
2391
2392                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2393
2394                 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid, feerate_per_kw) = {
2395                         let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2396                         let commitment_txid = {
2397                                 let trusted_tx = commitment_tx.0.trust();
2398                                 let bitcoin_tx = trusted_tx.built_transaction();
2399                                 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2400
2401                                 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2402                                         log_bytes!(msg.signature.serialize_compact()[..]),
2403                                         log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2404                                         log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2405                                 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2406                                         return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2407                                 }
2408                                 bitcoin_tx.txid
2409                         };
2410                         let htlcs_cloned: Vec<_> = commitment_tx.3.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2411                         (commitment_tx.2, htlcs_cloned, commitment_tx.0, commitment_txid, commitment_tx.1)
2412                 };
2413
2414                 // If our counterparty updated the channel fee in this commitment transaction, check that
2415                 // they can actually afford the new fee now.
2416                 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2417                         update_state == FeeUpdateState::RemoteAnnounced
2418                 } else { false };
2419                 if update_fee { debug_assert!(!self.is_outbound()); }
2420                 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2421                 if update_fee {
2422                         let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2423                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2424                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2425                         }
2426                 }
2427                 #[cfg(any(test, feature = "fuzztarget"))]
2428                 {
2429                         if self.is_outbound() {
2430                                 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2431                                 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2432                                 if let Some(info) = projected_commit_tx_info {
2433                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2434                                                 + self.holding_cell_htlc_updates.len();
2435                                         if info.total_pending_htlcs == total_pending_htlcs
2436                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
2437                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2438                                                 && info.feerate == self.feerate_per_kw {
2439                                                         assert_eq!(total_fee, info.fee / 1000);
2440                                                 }
2441                                 }
2442                         }
2443                 }
2444
2445                 if msg.htlc_signatures.len() != num_htlcs {
2446                         return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2447                 }
2448
2449                 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2450                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2451                 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2452                         if let Some(_) = htlc.transaction_output_index {
2453                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2454                                         self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2455                                         &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2456
2457                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2458                                 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2459                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2460                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2461                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2462                                 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2463                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2464                                 }
2465                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2466                         } else {
2467                                 htlcs_and_sigs.push((htlc, None, source));
2468                         }
2469                 }
2470
2471                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2472                         commitment_tx,
2473                         msg.signature,
2474                         msg.htlc_signatures.clone(),
2475                         &self.get_holder_pubkeys().funding_pubkey,
2476                         self.counterparty_funding_pubkey()
2477                 );
2478
2479                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2480                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
2481                         .map_err(|_| (None, ChannelError::Close("Failed to validate our commitment".to_owned())))?;
2482                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2483
2484                 // Update state now that we've passed all the can-fail calls...
2485                 let mut need_commitment = false;
2486                 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2487                         if *update_state == FeeUpdateState::RemoteAnnounced {
2488                                 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2489                                 need_commitment = true;
2490                         }
2491                 }
2492
2493                 self.latest_monitor_update_id += 1;
2494                 let mut monitor_update = ChannelMonitorUpdate {
2495                         update_id: self.latest_monitor_update_id,
2496                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2497                                 commitment_tx: holder_commitment_tx,
2498                                 htlc_outputs: htlcs_and_sigs
2499                         }]
2500                 };
2501
2502                 for htlc in self.pending_inbound_htlcs.iter_mut() {
2503                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2504                                 Some(forward_info.clone())
2505                         } else { None };
2506                         if let Some(forward_info) = new_forward {
2507                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2508                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2509                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2510                                 need_commitment = true;
2511                         }
2512                 }
2513                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2514                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2515                                 Some(fail_reason.take())
2516                         } else { None } {
2517                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2518                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2519                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2520                                 need_commitment = true;
2521                         }
2522                 }
2523
2524                 self.cur_holder_commitment_transaction_number -= 1;
2525                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2526                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2527                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2528
2529                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2530                         // In case we initially failed monitor updating without requiring a response, we need
2531                         // to make sure the RAA gets sent first.
2532                         self.monitor_pending_revoke_and_ack = true;
2533                         if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2534                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2535                                 // the corresponding HTLC status updates so that get_last_commitment_update
2536                                 // includes the right HTLCs.
2537                                 self.monitor_pending_commitment_signed = true;
2538                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2539                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2540                                 // strictly increasing by one, so decrement it here.
2541                                 self.latest_monitor_update_id = monitor_update.update_id;
2542                                 monitor_update.updates.append(&mut additional_update.updates);
2543                         }
2544                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2545                                 log_bytes!(self.channel_id));
2546                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2547                 }
2548
2549                 let commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2550                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2551                         // we'll send one right away when we get the revoke_and_ack when we
2552                         // free_holding_cell_htlcs().
2553                         let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2554                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2555                         // strictly increasing by one, so decrement it here.
2556                         self.latest_monitor_update_id = monitor_update.update_id;
2557                         monitor_update.updates.append(&mut additional_update.updates);
2558                         Some(msg)
2559                 } else { None };
2560
2561                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2562                         log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2563
2564                 Ok((msgs::RevokeAndACK {
2565                         channel_id: self.channel_id,
2566                         per_commitment_secret,
2567                         next_per_commitment_point,
2568                 }, commitment_signed, monitor_update))
2569         }
2570
2571         /// Public version of the below, checking relevant preconditions first.
2572         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2573         /// returns `(None, Vec::new())`.
2574         pub fn maybe_free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2575                 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2576                    (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2577                         self.free_holding_cell_htlcs(logger)
2578                 } else { Ok((None, Vec::new())) }
2579         }
2580
2581         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2582         /// fulfilling or failing the last pending HTLC)
2583         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2584                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2585                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2586                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2587                                 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2588
2589                         let mut monitor_update = ChannelMonitorUpdate {
2590                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2591                                 updates: Vec::new(),
2592                         };
2593
2594                         let mut htlc_updates = Vec::new();
2595                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2596                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2597                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2598                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2599                         let mut htlcs_to_fail = Vec::new();
2600                         for htlc_update in htlc_updates.drain(..) {
2601                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
2602                                 // fee races with adding too many outputs which push our total payments just over
2603                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
2604                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2605                                 // to rebalance channels.
2606                                 match &htlc_update {
2607                                         &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2608                                                 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2609                                                         Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2610                                                         Err(e) => {
2611                                                                 match e {
2612                                                                         ChannelError::Ignore(ref msg) => {
2613                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2614                                                                                         log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2615                                                                                 // If we fail to send here, then this HTLC should
2616                                                                                 // be failed backwards. Failing to send here
2617                                                                                 // indicates that this HTLC may keep being put back
2618                                                                                 // into the holding cell without ever being
2619                                                                                 // successfully forwarded/failed/fulfilled, causing
2620                                                                                 // our counterparty to eventually close on us.
2621                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
2622                                                                         },
2623                                                                         _ => {
2624                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2625                                                                         },
2626                                                                 }
2627                                                         }
2628                                                 }
2629                                         },
2630                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2631                                                 // If an HTLC claim was previously added to the holding cell (via
2632                                                 // `get_update_fulfill_htlc`, then generating the claim message itself must
2633                                                 // not fail - any in between attempts to claim the HTLC will have resulted
2634                                                 // in it hitting the holding cell again and we cannot change the state of a
2635                                                 // holding cell HTLC from fulfill to anything else.
2636                                                 let (update_fulfill_msg_option, mut additional_monitor_update) =
2637                                                         if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2638                                                                 (msg, monitor_update)
2639                                                         } else { unreachable!() };
2640                                                 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2641                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
2642                                         },
2643                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2644                                                 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2645                                                         Ok(update_fail_msg_option) => {
2646                                                                 // If an HTLC failure was previously added to the holding cell (via
2647                                                                 // `get_update_fail_htlc`) then generating the fail message itself
2648                                                                 // must not fail - we should never end up in a state where we
2649                                                                 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2650                                                                 // we didn't wait for a full revocation before failing.
2651                                                                 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2652                                                         },
2653                                                         Err(e) => {
2654                                                                 if let ChannelError::Ignore(_) = e {}
2655                                                                 else {
2656                                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2657                                                                 }
2658                                                         }
2659                                                 }
2660                                         },
2661                                 }
2662                         }
2663                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2664                                 return Ok((None, htlcs_to_fail));
2665                         }
2666                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
2667                                 assert!(self.is_outbound());
2668                                 self.pending_update_fee = Some((feerate, FeeUpdateState::Outbound));
2669                                 Some(msgs::UpdateFee {
2670                                         channel_id: self.channel_id,
2671                                         feerate_per_kw: feerate as u32,
2672                                 })
2673                         } else {
2674                                 None
2675                         };
2676
2677                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2678                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2679                         // but we want them to be strictly increasing by one, so reset it here.
2680                         self.latest_monitor_update_id = monitor_update.update_id;
2681                         monitor_update.updates.append(&mut additional_update.updates);
2682
2683                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2684                                 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2685                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2686
2687                         Ok((Some((msgs::CommitmentUpdate {
2688                                 update_add_htlcs,
2689                                 update_fulfill_htlcs,
2690                                 update_fail_htlcs,
2691                                 update_fail_malformed_htlcs: Vec::new(),
2692                                 update_fee,
2693                                 commitment_signed,
2694                         }, monitor_update)), htlcs_to_fail))
2695                 } else {
2696                         Ok((None, Vec::new()))
2697                 }
2698         }
2699
2700         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2701         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2702         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2703         /// generating an appropriate error *after* the channel state has been updated based on the
2704         /// revoke_and_ack message.
2705         pub fn revoke_and_ack<L: Deref>(&mut self, msg: &msgs::RevokeAndACK, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2706                 where L::Target: Logger,
2707         {
2708                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2709                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2710                 }
2711                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2712                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2713                 }
2714                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2715                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2716                 }
2717
2718                 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
2719
2720                 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2721                         if PublicKey::from_secret_key(&self.secp_ctx, &secret) != counterparty_prev_commitment_point {
2722                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2723                         }
2724                 }
2725
2726                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2727                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
2728                         // haven't given them a new commitment transaction to broadcast). We should probably
2729                         // take advantage of this by updating our channel monitor, sending them an error, and
2730                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2731                         // lot of work, and there's some chance this is all a misunderstanding anyway.
2732                         // We have to do *something*, though, since our signer may get mad at us for otherwise
2733                         // jumping a remote commitment number, so best to just force-close and move on.
2734                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2735                 }
2736
2737                 #[cfg(any(test, feature = "fuzztarget"))]
2738                 {
2739                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2740                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2741                 }
2742
2743                 self.holder_signer.validate_counterparty_revocation(
2744                         self.cur_counterparty_commitment_transaction_number + 1,
2745                         &secret
2746                 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
2747
2748                 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2749                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2750                 self.latest_monitor_update_id += 1;
2751                 let mut monitor_update = ChannelMonitorUpdate {
2752                         update_id: self.latest_monitor_update_id,
2753                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2754                                 idx: self.cur_counterparty_commitment_transaction_number + 1,
2755                                 secret: msg.per_commitment_secret,
2756                         }],
2757                 };
2758
2759                 // Update state now that we've passed all the can-fail calls...
2760                 // (note that we may still fail to generate the new commitment_signed message, but that's
2761                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2762                 // channel based on that, but stepping stuff here should be safe either way.
2763                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2764                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2765                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2766                 self.cur_counterparty_commitment_transaction_number -= 1;
2767
2768                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2769                 let mut to_forward_infos = Vec::new();
2770                 let mut revoked_htlcs = Vec::new();
2771                 let mut update_fail_htlcs = Vec::new();
2772                 let mut update_fail_malformed_htlcs = Vec::new();
2773                 let mut require_commitment = false;
2774                 let mut value_to_self_msat_diff: i64 = 0;
2775
2776                 {
2777                         // Take references explicitly so that we can hold multiple references to self.
2778                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2779                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2780
2781                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2782                         pending_inbound_htlcs.retain(|htlc| {
2783                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2784                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2785                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2786                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2787                                         }
2788                                         false
2789                                 } else { true }
2790                         });
2791                         pending_outbound_htlcs.retain(|htlc| {
2792                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2793                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2794                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2795                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2796                                         } else {
2797                                                 // They fulfilled, so we sent them money
2798                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2799                                         }
2800                                         false
2801                                 } else { true }
2802                         });
2803                         for htlc in pending_inbound_htlcs.iter_mut() {
2804                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2805                                         true
2806                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2807                                         true
2808                                 } else { false };
2809                                 if swap {
2810                                         let mut state = InboundHTLCState::Committed;
2811                                         mem::swap(&mut state, &mut htlc.state);
2812
2813                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2814                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2815                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2816                                                 require_commitment = true;
2817                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2818                                                 match forward_info {
2819                                                         PendingHTLCStatus::Fail(fail_msg) => {
2820                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2821                                                                 require_commitment = true;
2822                                                                 match fail_msg {
2823                                                                         HTLCFailureMsg::Relay(msg) => {
2824                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2825                                                                                 update_fail_htlcs.push(msg)
2826                                                                         },
2827                                                                         HTLCFailureMsg::Malformed(msg) => {
2828                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2829                                                                                 update_fail_malformed_htlcs.push(msg)
2830                                                                         },
2831                                                                 }
2832                                                         },
2833                                                         PendingHTLCStatus::Forward(forward_info) => {
2834                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2835                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2836                                                                 htlc.state = InboundHTLCState::Committed;
2837                                                         }
2838                                                 }
2839                                         }
2840                                 }
2841                         }
2842                         for htlc in pending_outbound_htlcs.iter_mut() {
2843                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2844                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2845                                         htlc.state = OutboundHTLCState::Committed;
2846                                 }
2847                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2848                                         Some(fail_reason.take())
2849                                 } else { None } {
2850                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2851                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2852                                         require_commitment = true;
2853                                 }
2854                         }
2855                 }
2856                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2857
2858                 if let Some((feerate, update_state)) = self.pending_update_fee {
2859                         match update_state {
2860                                 FeeUpdateState::Outbound => {
2861                                         debug_assert!(self.is_outbound());
2862                                         log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
2863                                         self.feerate_per_kw = feerate;
2864                                         self.pending_update_fee = None;
2865                                 },
2866                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
2867                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
2868                                         debug_assert!(!self.is_outbound());
2869                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
2870                                         require_commitment = true;
2871                                         self.feerate_per_kw = feerate;
2872                                         self.pending_update_fee = None;
2873                                 },
2874                         }
2875                 }
2876
2877                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2878                         // We can't actually generate a new commitment transaction (incl by freeing holding
2879                         // cells) while we can't update the monitor, so we just return what we have.
2880                         if require_commitment {
2881                                 self.monitor_pending_commitment_signed = true;
2882                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2883                                 // which does not update state, but we're definitely now awaiting a remote revoke
2884                                 // before we can step forward any more, so set it here.
2885                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2886                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2887                                 // strictly increasing by one, so decrement it here.
2888                                 self.latest_monitor_update_id = monitor_update.update_id;
2889                                 monitor_update.updates.append(&mut additional_update.updates);
2890                         }
2891                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2892                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2893                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2894                         return Ok((None, Vec::new(), Vec::new(), monitor_update, Vec::new()))
2895                 }
2896
2897                 match self.free_holding_cell_htlcs(logger)? {
2898                         (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2899                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2900                                 for fail_msg in update_fail_htlcs.drain(..) {
2901                                         commitment_update.update_fail_htlcs.push(fail_msg);
2902                                 }
2903                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2904                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2905                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2906                                 }
2907
2908                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2909                                 // strictly increasing by one, so decrement it here.
2910                                 self.latest_monitor_update_id = monitor_update.update_id;
2911                                 monitor_update.updates.append(&mut additional_update.updates);
2912
2913                                 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2914                         },
2915                         (None, htlcs_to_fail) => {
2916                                 if require_commitment {
2917                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2918
2919                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2920                                         // strictly increasing by one, so decrement it here.
2921                                         self.latest_monitor_update_id = monitor_update.update_id;
2922                                         monitor_update.updates.append(&mut additional_update.updates);
2923
2924                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2925                                                 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2926                                         Ok((Some(msgs::CommitmentUpdate {
2927                                                 update_add_htlcs: Vec::new(),
2928                                                 update_fulfill_htlcs: Vec::new(),
2929                                                 update_fail_htlcs,
2930                                                 update_fail_malformed_htlcs,
2931                                                 update_fee: None,
2932                                                 commitment_signed
2933                                         }), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2934                                 } else {
2935                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2936                                         Ok((None, to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2937                                 }
2938                         }
2939                 }
2940         }
2941
2942         /// Adds a pending update to this channel. See the doc for send_htlc for
2943         /// further details on the optionness of the return value.
2944         /// You MUST call send_commitment prior to any other calls on this Channel
2945         fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2946                 if !self.is_outbound() {
2947                         panic!("Cannot send fee from inbound channel");
2948                 }
2949                 if !self.is_usable() {
2950                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2951                 }
2952                 if !self.is_live() {
2953                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2954                 }
2955
2956                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
2957                         self.holding_cell_update_fee = Some(feerate_per_kw);
2958                         return None;
2959                 }
2960
2961                 debug_assert!(self.pending_update_fee.is_none());
2962                 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
2963
2964                 Some(msgs::UpdateFee {
2965                         channel_id: self.channel_id,
2966                         feerate_per_kw,
2967                 })
2968         }
2969
2970         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 {
2971                 match self.send_update_fee(feerate_per_kw) {
2972                         Some(update_fee) => {
2973                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2974                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2975                         },
2976                         None => Ok(None)
2977                 }
2978         }
2979
2980         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2981         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2982         /// resent.
2983         /// No further message handling calls may be made until a channel_reestablish dance has
2984         /// completed.
2985         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L)  where L::Target: Logger {
2986                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2987                 if self.channel_state < ChannelState::FundingSent as u32 {
2988                         self.channel_state = ChannelState::ShutdownComplete as u32;
2989                         return;
2990                 }
2991                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2992                 // will be retransmitted.
2993                 self.last_sent_closing_fee = None;
2994                 self.pending_counterparty_closing_signed = None;
2995                 self.closing_fee_limits = None;
2996
2997                 let mut inbound_drop_count = 0;
2998                 self.pending_inbound_htlcs.retain(|htlc| {
2999                         match htlc.state {
3000                                 InboundHTLCState::RemoteAnnounced(_) => {
3001                                         // They sent us an update_add_htlc but we never got the commitment_signed.
3002                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
3003                                         // this HTLC accordingly
3004                                         inbound_drop_count += 1;
3005                                         false
3006                                 },
3007                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3008                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
3009                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3010                                         // in response to it yet, so don't touch it.
3011                                         true
3012                                 },
3013                                 InboundHTLCState::Committed => true,
3014                                 InboundHTLCState::LocalRemoved(_) => {
3015                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3016                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
3017                                         // (that we missed). Keep this around for now and if they tell us they missed
3018                                         // the commitment_signed we can re-transmit the update then.
3019                                         true
3020                                 },
3021                         }
3022                 });
3023                 self.next_counterparty_htlc_id -= inbound_drop_count;
3024
3025                 if let Some((_, update_state)) = self.pending_update_fee {
3026                         if update_state == FeeUpdateState::RemoteAnnounced {
3027                                 debug_assert!(!self.is_outbound());
3028                                 self.pending_update_fee = None;
3029                         }
3030                 }
3031
3032                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3033                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3034                                 // They sent us an update to remove this but haven't yet sent the corresponding
3035                                 // commitment_signed, we need to move it back to Committed and they can re-send
3036                                 // the update upon reconnection.
3037                                 htlc.state = OutboundHTLCState::Committed;
3038                         }
3039                 }
3040
3041                 self.channel_state |= ChannelState::PeerDisconnected as u32;
3042                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3043         }
3044
3045         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3046         /// updates are partially paused.
3047         /// This must be called immediately after the call which generated the ChannelMonitor update
3048         /// which failed. The messages which were generated from that call which generated the
3049         /// monitor update failure must *not* have been sent to the remote end, and must instead
3050         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3051         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)>) {
3052                 self.monitor_pending_revoke_and_ack |= resend_raa;
3053                 self.monitor_pending_commitment_signed |= resend_commitment;
3054                 self.monitor_pending_forwards.append(&mut pending_forwards);
3055                 self.monitor_pending_failures.append(&mut pending_fails);
3056                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3057         }
3058
3059         /// Indicates that the latest ChannelMonitor update has been committed by the client
3060         /// successfully and we should restore normal operation. Returns messages which should be sent
3061         /// to the remote side.
3062         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)>, Option<Transaction>, Option<msgs::FundingLocked>) where L::Target: Logger {
3063                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3064                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3065
3066                 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
3067                         self.funding_transaction.take()
3068                 } else { None };
3069
3070                 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3071                 // we assume the user never directly broadcasts the funding transaction and waits for us to
3072                 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
3073                 // channel which failed to persist the monitor on funding_created, and we got the funding
3074                 // transaction confirmed before the monitor was persisted.
3075                 let funding_locked = if self.monitor_pending_funding_locked {
3076                         assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3077                         self.monitor_pending_funding_locked = false;
3078                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3079                         Some(msgs::FundingLocked {
3080                                 channel_id: self.channel_id(),
3081                                 next_per_commitment_point,
3082                         })
3083                 } else { None };
3084
3085                 let mut forwards = Vec::new();
3086                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
3087                 let mut failures = Vec::new();
3088                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
3089
3090                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3091                         self.monitor_pending_revoke_and_ack = false;
3092                         self.monitor_pending_commitment_signed = false;
3093                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
3094                 }
3095
3096                 let raa = if self.monitor_pending_revoke_and_ack {
3097                         Some(self.get_last_revoke_and_ack())
3098                 } else { None };
3099                 let commitment_update = if self.monitor_pending_commitment_signed {
3100                         Some(self.get_last_commitment_update(logger))
3101                 } else { None };
3102
3103                 self.monitor_pending_revoke_and_ack = false;
3104                 self.monitor_pending_commitment_signed = false;
3105                 let order = self.resend_order.clone();
3106                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3107                         log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3108                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3109                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3110                 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
3111         }
3112
3113         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3114                 where F::Target: FeeEstimator
3115         {
3116                 if self.is_outbound() {
3117                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3118                 }
3119                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3120                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3121                 }
3122                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3123                 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate();
3124
3125                 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3126                 self.update_time_counter += 1;
3127                 // If the feerate has increased over the previous dust buffer (note that
3128                 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3129                 // won't be pushed over our dust exposure limit by the feerate increase.
3130                 if feerate_over_dust_buffer {
3131                         let inbound_stats = self.get_inbound_pending_htlc_stats();
3132                         let outbound_stats = self.get_outbound_pending_htlc_stats();
3133                         let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3134                         let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3135                         if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3136                                 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our own transactions (totaling {} msat)",
3137                                         msg.feerate_per_kw, holder_tx_dust_exposure)));
3138                         }
3139                         if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3140                                 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our counterparty's transactions (totaling {} msat)",
3141                                         msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3142                         }
3143                 }
3144                 Ok(())
3145         }
3146
3147         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3148                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3149                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3150                 msgs::RevokeAndACK {
3151                         channel_id: self.channel_id,
3152                         per_commitment_secret,
3153                         next_per_commitment_point,
3154                 }
3155         }
3156
3157         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3158                 let mut update_add_htlcs = Vec::new();
3159                 let mut update_fulfill_htlcs = Vec::new();
3160                 let mut update_fail_htlcs = Vec::new();
3161                 let mut update_fail_malformed_htlcs = Vec::new();
3162
3163                 for htlc in self.pending_outbound_htlcs.iter() {
3164                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3165                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
3166                                         channel_id: self.channel_id(),
3167                                         htlc_id: htlc.htlc_id,
3168                                         amount_msat: htlc.amount_msat,
3169                                         payment_hash: htlc.payment_hash,
3170                                         cltv_expiry: htlc.cltv_expiry,
3171                                         onion_routing_packet: (**onion_packet).clone(),
3172                                 });
3173                         }
3174                 }
3175
3176                 for htlc in self.pending_inbound_htlcs.iter() {
3177                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3178                                 match reason {
3179                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3180                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3181                                                         channel_id: self.channel_id(),
3182                                                         htlc_id: htlc.htlc_id,
3183                                                         reason: err_packet.clone()
3184                                                 });
3185                                         },
3186                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3187                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3188                                                         channel_id: self.channel_id(),
3189                                                         htlc_id: htlc.htlc_id,
3190                                                         sha256_of_onion: sha256_of_onion.clone(),
3191                                                         failure_code: failure_code.clone(),
3192                                                 });
3193                                         },
3194                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3195                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3196                                                         channel_id: self.channel_id(),
3197                                                         htlc_id: htlc.htlc_id,
3198                                                         payment_preimage: payment_preimage.clone(),
3199                                                 });
3200                                         },
3201                                 }
3202                         }
3203                 }
3204
3205                 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3206                         Some(msgs::UpdateFee {
3207                                 channel_id: self.channel_id(),
3208                                 feerate_per_kw: self.pending_update_fee.unwrap().0,
3209                         })
3210                 } else { None };
3211
3212                 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3213                                 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3214                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3215                 msgs::CommitmentUpdate {
3216                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3217                         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,
3218                 }
3219         }
3220
3221         /// May panic if some calls other than message-handling calls (which will all Err immediately)
3222         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3223         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, Vec<(HTLCSource, PaymentHash)>, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
3224                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3225                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3226                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
3227                         // just close here instead of trying to recover.
3228                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3229                 }
3230
3231                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3232                         msg.next_local_commitment_number == 0 {
3233                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3234                 }
3235
3236                 if msg.next_remote_commitment_number > 0 {
3237                         match msg.data_loss_protect {
3238                                 OptionalField::Present(ref data_loss) => {
3239                                         let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3240                                         let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3241                                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3242                                         if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3243                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3244                                         }
3245                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3246                                                 return Err(ChannelError::CloseDelayBroadcast(
3247                                                         "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()
3248                                                 ));
3249                                         }
3250                                 },
3251                                 OptionalField::Absent => {}
3252                         }
3253                 }
3254
3255                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3256                 // remaining cases either succeed or ErrorMessage-fail).
3257                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3258
3259                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3260                         assert!(self.shutdown_scriptpubkey.is_some());
3261                         Some(msgs::Shutdown {
3262                                 channel_id: self.channel_id,
3263                                 scriptpubkey: self.get_closing_scriptpubkey(),
3264                         })
3265                 } else { None };
3266
3267                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3268                         // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3269                         if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3270                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3271                                 if msg.next_remote_commitment_number != 0 {
3272                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3273                                 }
3274                                 // Short circuit the whole handler as there is nothing we can resend them
3275                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3276                         }
3277
3278                         // We have OurFundingLocked set!
3279                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3280                         return Ok((Some(msgs::FundingLocked {
3281                                 channel_id: self.channel_id(),
3282                                 next_per_commitment_point,
3283                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3284                 }
3285
3286                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3287                         // Remote isn't waiting on any RevokeAndACK from us!
3288                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3289                         None
3290                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3291                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3292                                 self.monitor_pending_revoke_and_ack = true;
3293                                 None
3294                         } else {
3295                                 Some(self.get_last_revoke_and_ack())
3296                         }
3297                 } else {
3298                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3299                 };
3300
3301                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3302                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3303                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3304                 // the corresponding revoke_and_ack back yet.
3305                 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
3306
3307                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3308                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3309                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3310                         Some(msgs::FundingLocked {
3311                                 channel_id: self.channel_id(),
3312                                 next_per_commitment_point,
3313                         })
3314                 } else { None };
3315
3316                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3317                         if required_revoke.is_some() {
3318                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3319                         } else {
3320                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3321                         }
3322
3323                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3324                                 // We're up-to-date and not waiting on a remote revoke (if we are our
3325                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3326                                 // have received some updates while we were disconnected. Free the holding cell
3327                                 // now!
3328                                 match self.free_holding_cell_htlcs(logger) {
3329                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3330                                         Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
3331                                                 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3332                                         Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3333                                                 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3334                                         },
3335                                         Ok((None, htlcs_to_fail)) => {
3336                                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3337                                         },
3338                                 }
3339                         } else {
3340                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3341                         }
3342                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3343                         if required_revoke.is_some() {
3344                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3345                         } else {
3346                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3347                         }
3348
3349                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3350                                 self.monitor_pending_commitment_signed = true;
3351                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3352                         }
3353
3354                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3355                 } else {
3356                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3357                 }
3358         }
3359
3360         /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
3361         /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
3362         /// at which point they will be recalculated.
3363         fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &F) -> (u64, u64)
3364                 where F::Target: FeeEstimator
3365         {
3366                 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
3367
3368                 // Propose a range from our current Background feerate to our Normal feerate plus our
3369                 // force_close_avoidance_max_fee_satoshis.
3370                 // If we fail to come to consensus, we'll have to force-close.
3371                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3372                 let normal_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3373                 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
3374
3375                 // The spec requires that (when the channel does not have anchors) we only send absolute
3376                 // channel fees no greater than the absolute channel fee on the current commitment
3377                 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
3378                 // very good reason to apply such a limit in any case. We don't bother doing so, risking
3379                 // some force-closure by old nodes, but we wanted to close the channel anyway.
3380
3381                 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
3382                         let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
3383                         proposed_feerate = cmp::max(proposed_feerate, min_feerate);
3384                         proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
3385                 }
3386
3387                 // Note that technically we could end up with a lower minimum fee if one sides' balance is
3388                 // below our dust limit, causing the output to disappear. We don't bother handling this
3389                 // case, however, as this should only happen if a channel is closed before any (material)
3390                 // payments have been made on it. This may cause slight fee overpayment and/or failure to
3391                 // come to consensus with our counterparty on appropriate fees, however it should be a
3392                 // relatively rare case. We can revisit this later, though note that in order to determine
3393                 // if the funders' output is dust we have to know the absolute fee we're going to use.
3394                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3395                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3396                 let proposed_max_total_fee_satoshis = if self.is_outbound() {
3397                                 // We always add force_close_avoidance_max_fee_satoshis to our normal
3398                                 // feerate-calculated fee, but allow the max to be overridden if we're using a
3399                                 // target feerate-calculated fee.
3400                                 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.force_close_avoidance_max_fee_satoshis,
3401                                         proposed_max_feerate as u64 * tx_weight / 1000)
3402                         } else {
3403                                 self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000
3404                         };
3405
3406                 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
3407                 self.closing_fee_limits.clone().unwrap()
3408         }
3409
3410         /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
3411         /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
3412         /// this point if we're the funder we should send the initial closing_signed, and in any case
3413         /// shutdown should complete within a reasonable timeframe.
3414         fn closing_negotiation_ready(&self) -> bool {
3415                 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
3416                         self.channel_state &
3417                                 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
3418                                  ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)
3419                                 == BOTH_SIDES_SHUTDOWN_MASK &&
3420                         self.pending_update_fee.is_none()
3421         }
3422
3423         /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
3424         /// an Err if no progress is being made and the channel should be force-closed instead.
3425         /// Should be called on a one-minute timer.
3426         pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
3427                 if self.closing_negotiation_ready() {
3428                         if self.closing_signed_in_flight {
3429                                 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
3430                         } else {
3431                                 self.closing_signed_in_flight = true;
3432                         }
3433                 }
3434                 Ok(())
3435         }
3436
3437         pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(&mut self, fee_estimator: &F, logger: &L)
3438                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3439                 where F::Target: FeeEstimator, L::Target: Logger
3440         {
3441                 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
3442                         return Ok((None, None));
3443                 }
3444
3445                 if !self.is_outbound() {
3446                         if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
3447                                 return self.closing_signed(fee_estimator, &msg);
3448                         }
3449                         return Ok((None, None));
3450                 }
3451
3452                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3453
3454                 assert!(self.shutdown_scriptpubkey.is_some());
3455                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
3456                 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
3457                         our_min_fee, our_max_fee, total_fee_satoshis);
3458
3459                 let sig = self.holder_signer
3460                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3461                         .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
3462
3463                 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
3464                 Ok((Some(msgs::ClosingSigned {
3465                         channel_id: self.channel_id,
3466                         fee_satoshis: total_fee_satoshis,
3467                         signature: sig,
3468                         fee_range: Some(msgs::ClosingSignedFeeRange {
3469                                 min_fee_satoshis: our_min_fee,
3470                                 max_fee_satoshis: our_max_fee,
3471                         }),
3472                 }), None))
3473         }
3474
3475         pub fn shutdown<K: Deref>(
3476                 &mut self, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3477         ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3478         where K::Target: KeysInterface<Signer = Signer>
3479         {
3480                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3481                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3482                 }
3483                 if self.channel_state < ChannelState::FundingSent as u32 {
3484                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
3485                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3486                         // can do that via error message without getting a connection fail anyway...
3487                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3488                 }
3489                 for htlc in self.pending_inbound_htlcs.iter() {
3490                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3491                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3492                         }
3493                 }
3494                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3495
3496                 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
3497                         return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3498                 }
3499
3500                 if self.counterparty_shutdown_scriptpubkey.is_some() {
3501                         if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3502                                 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3503                         }
3504                 } else {
3505                         self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3506                 }
3507
3508                 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
3509                 // immediately after the commitment dance, but we can send a Shutdown because we won't send
3510                 // any further commitment updates after we set LocalShutdownSent.
3511                 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3512
3513                 let update_shutdown_script = match self.shutdown_scriptpubkey {
3514                         Some(_) => false,
3515                         None => {
3516                                 assert!(send_shutdown);
3517                                 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3518                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
3519                                         return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
3520                                 }
3521                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3522                                 true
3523                         },
3524                 };
3525
3526                 // From here on out, we may not fail!
3527
3528                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3529                 self.update_time_counter += 1;
3530
3531                 let monitor_update = if update_shutdown_script {
3532                         self.latest_monitor_update_id += 1;
3533                         Some(ChannelMonitorUpdate {
3534                                 update_id: self.latest_monitor_update_id,
3535                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3536                                         scriptpubkey: self.get_closing_scriptpubkey(),
3537                                 }],
3538                         })
3539                 } else { None };
3540                 let shutdown = if send_shutdown {
3541                         Some(msgs::Shutdown {
3542                                 channel_id: self.channel_id,
3543                                 scriptpubkey: self.get_closing_scriptpubkey(),
3544                         })
3545                 } else { None };
3546
3547                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3548                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3549                 // cell HTLCs and return them to fail the payment.
3550                 self.holding_cell_update_fee = None;
3551                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3552                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3553                         match htlc_update {
3554                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3555                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3556                                         false
3557                                 },
3558                                 _ => true
3559                         }
3560                 });
3561
3562                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3563                 self.update_time_counter += 1;
3564
3565                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
3566         }
3567
3568         fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
3569                 let mut tx = closing_tx.trust().built_transaction().clone();
3570
3571                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3572
3573                 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3574                 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3575                 if funding_key[..] < counterparty_funding_key[..] {
3576                         tx.input[0].witness.push(sig.serialize_der().to_vec());
3577                         tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3578                 } else {
3579                         tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3580                         tx.input[0].witness.push(sig.serialize_der().to_vec());
3581                 }
3582                 tx.input[0].witness[1].push(SigHashType::All as u8);
3583                 tx.input[0].witness[2].push(SigHashType::All as u8);
3584
3585                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3586                 tx
3587         }
3588
3589         pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3590                 where F::Target: FeeEstimator
3591         {
3592                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3593                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3594                 }
3595                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3596                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3597                 }
3598                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3599                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3600                 }
3601                 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3602                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3603                 }
3604
3605                 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
3606                         return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
3607                 }
3608
3609                 if self.channel_state & ChannelState::MonitorUpdateFailed as u32 != 0 {
3610                         self.pending_counterparty_closing_signed = Some(msg.clone());
3611                         return Ok((None, None));
3612                 }
3613
3614                 let funding_redeemscript = self.get_funding_redeemscript();
3615                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3616                 if used_total_fee != msg.fee_satoshis {
3617                         return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee other than the value they can claim. Fee in message: {}. Actual closing tx fee: {}", msg.fee_satoshis, used_total_fee)));
3618                 }
3619                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3620
3621                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3622                         Ok(_) => {},
3623                         Err(_e) => {
3624                                 // The remote end may have decided to revoke their output due to inconsistent dust
3625                                 // limits, so check for that case by re-checking the signature here.
3626                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3627                                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3628                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3629                         },
3630                 };
3631
3632                 assert!(self.shutdown_scriptpubkey.is_some());
3633                 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
3634                         if last_fee == msg.fee_satoshis {
3635                                 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3636                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3637                                 self.update_time_counter += 1;
3638                                 return Ok((None, Some(tx)));
3639                         }
3640                 }
3641
3642                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3643
3644                 macro_rules! propose_fee {
3645                         ($new_fee: expr) => {
3646                                 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
3647                                         (closing_tx, $new_fee)
3648                                 } else {
3649                                         self.build_closing_transaction($new_fee, false)
3650                                 };
3651
3652                                 let sig = self.holder_signer
3653                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3654                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3655
3656                                 let signed_tx = if $new_fee == msg.fee_satoshis {
3657                                         self.channel_state = ChannelState::ShutdownComplete as u32;
3658                                         self.update_time_counter += 1;
3659                                         let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
3660                                         Some(tx)
3661                                 } else { None };
3662
3663                                 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
3664                                 return Ok((Some(msgs::ClosingSigned {
3665                                         channel_id: self.channel_id,
3666                                         fee_satoshis: used_fee,
3667                                         signature: sig,
3668                                         fee_range: Some(msgs::ClosingSignedFeeRange {
3669                                                 min_fee_satoshis: our_min_fee,
3670                                                 max_fee_satoshis: our_max_fee,
3671                                         }),
3672                                 }), signed_tx))
3673                         }
3674                 }
3675
3676                 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
3677                         if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
3678                                 return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in their desired range of {} sat - {} sat", msg.fee_satoshis, min_fee_satoshis, max_fee_satoshis)));
3679                         }
3680                         if max_fee_satoshis < our_min_fee {
3681                                 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's max fee ({} sat) was smaller than our min fee ({} sat)", max_fee_satoshis, our_min_fee)));
3682                         }
3683                         if min_fee_satoshis > our_max_fee {
3684                                 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's min fee ({} sat) was greater than our max fee ({} sat)", min_fee_satoshis, our_max_fee)));
3685                         }
3686
3687                         if !self.is_outbound() {
3688                                 // They have to pay, so pick the highest fee in the overlapping range.
3689                                 // We should never set an upper bound aside from their full balance
3690                                 debug_assert_eq!(our_max_fee, self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000);
3691                                 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
3692                         } else {
3693                                 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
3694                                         return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in our desired range of {} sat - {} sat after we informed them of our range.",
3695                                                 msg.fee_satoshis, our_min_fee, our_max_fee)));
3696                                 }
3697                                 // The proposed fee is in our acceptable range, accept it and broadcast!
3698                                 propose_fee!(msg.fee_satoshis);
3699                         }
3700                 } else {
3701                         // Old fee style negotiation. We don't bother to enforce whether they are complying
3702                         // with the "making progress" requirements, we just comply and hope for the best.
3703                         if let Some((last_fee, _)) = self.last_sent_closing_fee {
3704                                 if msg.fee_satoshis > last_fee {
3705                                         if msg.fee_satoshis < our_max_fee {
3706                                                 propose_fee!(msg.fee_satoshis);
3707                                         } else if last_fee < our_max_fee {
3708                                                 propose_fee!(our_max_fee);
3709                                         } else {
3710                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) higher than our max fee ({} sat)", msg.fee_satoshis, our_max_fee)));
3711                                         }
3712                                 } else {
3713                                         if msg.fee_satoshis > our_min_fee {
3714                                                 propose_fee!(msg.fee_satoshis);
3715                                         } else if last_fee > our_min_fee {
3716                                                 propose_fee!(our_min_fee);
3717                                         } else {
3718                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) lower than our min fee ({} sat)", msg.fee_satoshis, our_min_fee)));
3719                                         }
3720                                 }
3721                         } else {
3722                                 if msg.fee_satoshis < our_min_fee {
3723                                         propose_fee!(our_min_fee);
3724                                 } else if msg.fee_satoshis > our_max_fee {
3725                                         propose_fee!(our_max_fee);
3726                                 } else {
3727                                         propose_fee!(msg.fee_satoshis);
3728                                 }
3729                         }
3730                 }
3731         }
3732
3733         // Public utilities:
3734
3735         pub fn channel_id(&self) -> [u8; 32] {
3736                 self.channel_id
3737         }
3738
3739         pub fn minimum_depth(&self) -> Option<u32> {
3740                 self.minimum_depth
3741         }
3742
3743         /// Gets the "user_id" value passed into the construction of this channel. It has no special
3744         /// meaning and exists only to allow users to have a persistent identifier of a channel.
3745         pub fn get_user_id(&self) -> u64 {
3746                 self.user_id
3747         }
3748
3749         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3750         /// is_usable() returns true).
3751         /// Allowed in any state (including after shutdown)
3752         pub fn get_short_channel_id(&self) -> Option<u64> {
3753                 self.short_channel_id
3754         }
3755
3756         /// Returns the funding_txo we either got from our peer, or were given by
3757         /// get_outbound_funding_created.
3758         pub fn get_funding_txo(&self) -> Option<OutPoint> {
3759                 self.channel_transaction_parameters.funding_outpoint
3760         }
3761
3762         fn get_holder_selected_contest_delay(&self) -> u16 {
3763                 self.channel_transaction_parameters.holder_selected_contest_delay
3764         }
3765
3766         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3767                 &self.channel_transaction_parameters.holder_pubkeys
3768         }
3769
3770         pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3771                 self.channel_transaction_parameters.counterparty_parameters
3772                         .as_ref().map(|params| params.selected_contest_delay)
3773         }
3774
3775         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3776                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3777         }
3778
3779         /// Allowed in any state (including after shutdown)
3780         pub fn get_counterparty_node_id(&self) -> PublicKey {
3781                 self.counterparty_node_id
3782         }
3783
3784         /// Allowed in any state (including after shutdown)
3785         #[cfg(test)]
3786         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3787                 self.holder_htlc_minimum_msat
3788         }
3789
3790         /// Allowed in any state (including after shutdown)
3791         pub fn get_announced_htlc_max_msat(&self) -> u64 {
3792                 return cmp::min(
3793                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3794                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
3795                         // channel might have been used to route very small values (either by honest users or as DoS).
3796                         self.channel_value_satoshis * 1000 * 9 / 10,
3797
3798                         Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3799                 );
3800         }
3801
3802         /// Allowed in any state (including after shutdown)
3803         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3804                 self.counterparty_htlc_minimum_msat
3805         }
3806
3807         pub fn get_value_satoshis(&self) -> u64 {
3808                 self.channel_value_satoshis
3809         }
3810
3811         pub fn get_fee_proportional_millionths(&self) -> u32 {
3812                 self.config.forwarding_fee_proportional_millionths
3813         }
3814
3815         pub fn get_cltv_expiry_delta(&self) -> u16 {
3816                 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3817         }
3818
3819         pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
3820                 self.config.max_dust_htlc_exposure_msat
3821         }
3822
3823         pub fn get_feerate(&self) -> u32 {
3824                 self.feerate_per_kw
3825         }
3826
3827         pub fn get_dust_buffer_feerate(&self) -> u32 {
3828                 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
3829                 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
3830                 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
3831                 // more dust balance if the feerate increases when we have several HTLCs pending
3832                 // which are near the dust limit.
3833                 let mut feerate_per_kw = self.feerate_per_kw;
3834                 // If there's a pending update fee, use it to ensure we aren't under-estimating
3835                 // potential feerate updates coming soon.
3836                 if let Some((feerate, _)) = self.pending_update_fee {
3837                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
3838                 }
3839                 cmp::max(2530, feerate_per_kw * 1250 / 1000)
3840         }
3841
3842         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3843                 self.cur_holder_commitment_transaction_number + 1
3844         }
3845
3846         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3847                 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3848         }
3849
3850         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3851                 self.cur_counterparty_commitment_transaction_number + 2
3852         }
3853
3854         #[cfg(test)]
3855         pub fn get_signer(&self) -> &Signer {
3856                 &self.holder_signer
3857         }
3858
3859         #[cfg(test)]
3860         pub fn get_value_stat(&self) -> ChannelValueStat {
3861                 ChannelValueStat {
3862                         value_to_self_msat: self.value_to_self_msat,
3863                         channel_value_msat: self.channel_value_satoshis * 1000,
3864                         channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3865                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3866                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3867                         holding_cell_outbound_amount_msat: {
3868                                 let mut res = 0;
3869                                 for h in self.holding_cell_htlc_updates.iter() {
3870                                         match h {
3871                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3872                                                         res += amount_msat;
3873                                                 }
3874                                                 _ => {}
3875                                         }
3876                                 }
3877                                 res
3878                         },
3879                         counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3880                         counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3881                 }
3882         }
3883
3884         /// Allowed in any state (including after shutdown)
3885         pub fn get_update_time_counter(&self) -> u32 {
3886                 self.update_time_counter
3887         }
3888
3889         pub fn get_latest_monitor_update_id(&self) -> u64 {
3890                 self.latest_monitor_update_id
3891         }
3892
3893         pub fn should_announce(&self) -> bool {
3894                 self.config.announced_channel
3895         }
3896
3897         pub fn is_outbound(&self) -> bool {
3898                 self.channel_transaction_parameters.is_outbound_from_holder
3899         }
3900
3901         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3902         /// Allowed in any state (including after shutdown)
3903         pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3904                 self.config.forwarding_fee_base_msat
3905         }
3906
3907         /// Returns true if we've ever received a message from the remote end for this Channel
3908         pub fn have_received_message(&self) -> bool {
3909                 self.channel_state > (ChannelState::OurInitSent as u32)
3910         }
3911
3912         /// Returns true if this channel is fully established and not known to be closing.
3913         /// Allowed in any state (including after shutdown)
3914         pub fn is_usable(&self) -> bool {
3915                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3916                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3917         }
3918
3919         /// Returns true if this channel is currently available for use. This is a superset of
3920         /// is_usable() and considers things like the channel being temporarily disabled.
3921         /// Allowed in any state (including after shutdown)
3922         pub fn is_live(&self) -> bool {
3923                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3924         }
3925
3926         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3927         /// Allowed in any state (including after shutdown)
3928         pub fn is_awaiting_monitor_update(&self) -> bool {
3929                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3930         }
3931
3932         /// Returns true if funding_created was sent/received.
3933         pub fn is_funding_initiated(&self) -> bool {
3934                 self.channel_state >= ChannelState::FundingSent as u32
3935         }
3936
3937         /// Returns true if our peer has either initiated or agreed to shut down the channel.
3938         pub fn received_shutdown(&self) -> bool {
3939                 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
3940         }
3941
3942         /// Returns true if we either initiated or agreed to shut down the channel.
3943         pub fn sent_shutdown(&self) -> bool {
3944                 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
3945         }
3946
3947         /// Returns true if this channel is fully shut down. True here implies that no further actions
3948         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3949         /// will be handled appropriately by the chain monitor.
3950         pub fn is_shutdown(&self) -> bool {
3951                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
3952                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3953                         true
3954                 } else { false }
3955         }
3956
3957         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3958                 self.channel_update_status
3959         }
3960
3961         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3962                 self.channel_update_status = status;
3963         }
3964
3965         fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3966                 if self.funding_tx_confirmation_height == 0 {
3967                         return None;
3968                 }
3969
3970                 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3971                 if funding_tx_confirmations <= 0 {
3972                         self.funding_tx_confirmation_height = 0;
3973                 }
3974
3975                 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3976                         return None;
3977                 }
3978
3979                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3980                 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3981                         self.channel_state |= ChannelState::OurFundingLocked as u32;
3982                         true
3983                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3984                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3985                         self.update_time_counter += 1;
3986                         true
3987                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3988                         // We got a reorg but not enough to trigger a force close, just ignore.
3989                         false
3990                 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3991                         panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3992                 } else {
3993                         // We got a reorg but not enough to trigger a force close, just ignore.
3994                         false
3995                 };
3996
3997                 if need_commitment_update {
3998                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3999                                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4000                                 return Some(msgs::FundingLocked {
4001                                         channel_id: self.channel_id,
4002                                         next_per_commitment_point,
4003                                 });
4004                         } else {
4005                                 self.monitor_pending_funding_locked = true;
4006                         }
4007                 }
4008                 None
4009         }
4010
4011         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
4012         /// In the first case, we store the confirmation height and calculating the short channel id.
4013         /// In the second, we simply return an Err indicating we need to be force-closed now.
4014         pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
4015                         -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
4016                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4017                 for &(index_in_block, tx) in txdata.iter() {
4018                         if let Some(funding_txo) = self.get_funding_txo() {
4019                                 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
4020                                 // whether they've sent a funding_locked or not), check if we should send one.
4021                                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
4022                                         if tx.txid() == funding_txo.txid {
4023                                                 let txo_idx = funding_txo.index as usize;
4024                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
4025                                                                 tx.output[txo_idx].value != self.channel_value_satoshis {
4026                                                         if self.is_outbound() {
4027                                                                 // If we generated the funding transaction and it doesn't match what it
4028                                                                 // should, the client is really broken and we should just panic and
4029                                                                 // tell them off. That said, because hash collisions happen with high
4030                                                                 // probability in fuzztarget mode, if we're fuzzing we just close the
4031                                                                 // channel and move on.
4032                                                                 #[cfg(not(feature = "fuzztarget"))]
4033                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4034                                                         }
4035                                                         self.update_time_counter += 1;
4036                                                         return Err(msgs::ErrorMessage {
4037                                                                 channel_id: self.channel_id(),
4038                                                                 data: "funding tx had wrong script/value or output index".to_owned()
4039                                                         });
4040                                                 } else {
4041                                                         if self.is_outbound() {
4042                                                                 for input in tx.input.iter() {
4043                                                                         if input.witness.is_empty() {
4044                                                                                 // We generated a malleable funding transaction, implying we've
4045                                                                                 // just exposed ourselves to funds loss to our counterparty.
4046                                                                                 #[cfg(not(feature = "fuzztarget"))]
4047                                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4048                                                                         }
4049                                                                 }
4050                                                         }
4051                                                         self.funding_tx_confirmation_height = height;
4052                                                         self.funding_tx_confirmed_in = Some(*block_hash);
4053                                                         self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
4054                                                                 Ok(scid) => Some(scid),
4055                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
4056                                                         }
4057                                                 }
4058                                         }
4059                                         // If we allow 1-conf funding, we may need to check for funding_locked here and
4060                                         // send it immediately instead of waiting for a best_block_updated call (which
4061                                         // may have already happened for this block).
4062                                         if let Some(funding_locked) = self.check_get_funding_locked(height) {
4063                                                 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4064                                                 return Ok(Some(funding_locked));
4065                                         }
4066                                 }
4067                                 for inp in tx.input.iter() {
4068                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
4069                                                 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(self.channel_id()));
4070                                                 return Err(msgs::ErrorMessage {
4071                                                         channel_id: self.channel_id(),
4072                                                         data: "Commitment or closing transaction was confirmed on chain.".to_owned()
4073                                                 });
4074                                         }
4075                                 }
4076                         }
4077                 }
4078                 Ok(None)
4079         }
4080
4081         /// When a new block is connected, we check the height of the block against outbound holding
4082         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
4083         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
4084         /// handled by the ChannelMonitor.
4085         ///
4086         /// If we return Err, the channel may have been closed, at which point the standard
4087         /// requirements apply - no calls may be made except those explicitly stated to be allowed
4088         /// post-shutdown.
4089         ///
4090         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
4091         /// back.
4092         pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
4093                         -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
4094                 let mut timed_out_htlcs = Vec::new();
4095                 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
4096                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4097                         match htlc_update {
4098                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
4099                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
4100                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
4101                                                 false
4102                                         } else { true }
4103                                 },
4104                                 _ => true
4105                         }
4106                 });
4107
4108                 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
4109
4110                 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4111                         log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4112                         return Ok((Some(funding_locked), timed_out_htlcs));
4113                 }
4114
4115                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4116                 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
4117                    (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
4118                         let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4119                         if self.funding_tx_confirmation_height == 0 {
4120                                 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
4121                                 // zero if it has been reorged out, however in either case, our state flags
4122                                 // indicate we've already sent a funding_locked
4123                                 funding_tx_confirmations = 0;
4124                         }
4125
4126                         // If we've sent funding_locked (or have both sent and received funding_locked), and
4127                         // the funding transaction's confirmation count has dipped below minimum_depth / 2,
4128                         // close the channel and hope we can get the latest state on chain (because presumably
4129                         // the funding transaction is at least still in the mempool of most nodes).
4130                         if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
4131                                 return Err(msgs::ErrorMessage {
4132                                         channel_id: self.channel_id(),
4133                                         data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
4134                                 });
4135                         }
4136                 }
4137
4138                 Ok((None, timed_out_htlcs))
4139         }
4140
4141         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4142         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4143         /// before the channel has reached funding_locked and we can just wait for more blocks.
4144         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
4145                 if self.funding_tx_confirmation_height != 0 {
4146                         // We handle the funding disconnection by calling best_block_updated with a height one
4147                         // below where our funding was connected, implying a reorg back to conf_height - 1.
4148                         let reorg_height = self.funding_tx_confirmation_height - 1;
4149                         // We use the time field to bump the current time we set on channel updates if its
4150                         // larger. If we don't know that time has moved forward, we can just set it to the last
4151                         // time we saw and it will be ignored.
4152                         let best_time = self.update_time_counter;
4153                         match self.best_block_updated(reorg_height, best_time, logger) {
4154                                 Ok((funding_locked, timed_out_htlcs)) => {
4155                                         assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
4156                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4157                                         Ok(())
4158                                 },
4159                                 Err(e) => Err(e)
4160                         }
4161                 } else {
4162                         // We never learned about the funding confirmation anyway, just ignore
4163                         Ok(())
4164                 }
4165         }
4166
4167         // Methods to get unprompted messages to send to the remote end (or where we already returned
4168         // something in the handler for the message that prompted this message):
4169
4170         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
4171                 if !self.is_outbound() {
4172                         panic!("Tried to open a channel for an inbound channel?");
4173                 }
4174                 if self.channel_state != ChannelState::OurInitSent as u32 {
4175                         panic!("Cannot generate an open_channel after we've moved forward");
4176                 }
4177
4178                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4179                         panic!("Tried to send an open_channel for a channel that has already advanced");
4180                 }
4181
4182                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4183                 let keys = self.get_holder_pubkeys();
4184
4185                 msgs::OpenChannel {
4186                         chain_hash,
4187                         temporary_channel_id: self.channel_id,
4188                         funding_satoshis: self.channel_value_satoshis,
4189                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
4190                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
4191                         max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4192                         channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4193                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
4194                         feerate_per_kw: self.feerate_per_kw as u32,
4195                         to_self_delay: self.get_holder_selected_contest_delay(),
4196                         max_accepted_htlcs: OUR_MAX_HTLCS,
4197                         funding_pubkey: keys.funding_pubkey,
4198                         revocation_basepoint: keys.revocation_basepoint,
4199                         payment_point: keys.payment_point,
4200                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
4201                         htlc_basepoint: keys.htlc_basepoint,
4202                         first_per_commitment_point,
4203                         channel_flags: if self.config.announced_channel {1} else {0},
4204                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4205                                 Some(script) => script.clone().into_inner(),
4206                                 None => Builder::new().into_script(),
4207                         }),
4208                 }
4209         }
4210
4211         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
4212                 if self.is_outbound() {
4213                         panic!("Tried to send accept_channel for an outbound channel?");
4214                 }
4215                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
4216                         panic!("Tried to send accept_channel after channel had moved forward");
4217                 }
4218                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4219                         panic!("Tried to send an accept_channel for a channel that has already advanced");
4220                 }
4221
4222                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4223                 let keys = self.get_holder_pubkeys();
4224
4225                 msgs::AcceptChannel {
4226                         temporary_channel_id: self.channel_id,
4227                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
4228                         max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4229                         channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4230                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
4231                         minimum_depth: self.minimum_depth.unwrap(),
4232                         to_self_delay: self.get_holder_selected_contest_delay(),
4233                         max_accepted_htlcs: OUR_MAX_HTLCS,
4234                         funding_pubkey: keys.funding_pubkey,
4235                         revocation_basepoint: keys.revocation_basepoint,
4236                         payment_point: keys.payment_point,
4237                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
4238                         htlc_basepoint: keys.htlc_basepoint,
4239                         first_per_commitment_point,
4240                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4241                                 Some(script) => script.clone().into_inner(),
4242                                 None => Builder::new().into_script(),
4243                         }),
4244                 }
4245         }
4246
4247         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
4248         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
4249                 let counterparty_keys = self.build_remote_transaction_keys()?;
4250                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
4251                 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
4252                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
4253         }
4254
4255         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
4256         /// a funding_created message for the remote peer.
4257         /// Panics if called at some time other than immediately after initial handshake, if called twice,
4258         /// or if called on an inbound channel.
4259         /// Note that channel_id changes during this call!
4260         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
4261         /// If an Err is returned, it is a ChannelError::Close.
4262         pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
4263                 if !self.is_outbound() {
4264                         panic!("Tried to create outbound funding_created message on an inbound channel!");
4265                 }
4266                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
4267                         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)");
4268                 }
4269                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
4270                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
4271                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4272                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
4273                 }
4274
4275                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
4276                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
4277
4278                 let signature = match self.get_outbound_funding_created_signature(logger) {
4279                         Ok(res) => res,
4280                         Err(e) => {
4281                                 log_error!(logger, "Got bad signatures: {:?}!", e);
4282                                 self.channel_transaction_parameters.funding_outpoint = None;
4283                                 return Err(e);
4284                         }
4285                 };
4286
4287                 let temporary_channel_id = self.channel_id;
4288
4289                 // Now that we're past error-generating stuff, update our local state:
4290
4291                 self.channel_state = ChannelState::FundingCreated as u32;
4292                 self.channel_id = funding_txo.to_channel_id();
4293                 self.funding_transaction = Some(funding_transaction);
4294
4295                 Ok(msgs::FundingCreated {
4296                         temporary_channel_id,
4297                         funding_txid: funding_txo.txid,
4298                         funding_output_index: funding_txo.index,
4299                         signature
4300                 })
4301         }
4302
4303         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4304         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4305         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4306         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4307         /// Will only fail if we're not in a state where channel_announcement may be sent (including
4308         /// closing).
4309         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4310         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4311         ///
4312         /// This will only return ChannelError::Ignore upon failure.
4313         pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4314                 if !self.config.announced_channel {
4315                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4316                 }
4317                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4318                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4319                 }
4320                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4321                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4322                 }
4323
4324                 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4325
4326                 let msg = msgs::UnsignedChannelAnnouncement {
4327                         features: ChannelFeatures::known(),
4328                         chain_hash,
4329                         short_channel_id: self.get_short_channel_id().unwrap(),
4330                         node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4331                         node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4332                         bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4333                         bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4334                         excess_data: Vec::new(),
4335                 };
4336
4337                 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4338                         .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4339
4340                 Ok((msg, sig))
4341         }
4342
4343         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4344         /// available.
4345         fn sign_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, msghash: secp256k1::Message, announcement: msgs::UnsignedChannelAnnouncement, our_bitcoin_sig: Signature) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4346                 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4347                         let were_node_one = announcement.node_id_1 == our_node_id;
4348
4349                         let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4350                         Ok(msgs::ChannelAnnouncement {
4351                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4352                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4353                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4354                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4355                                 contents: announcement,
4356                         })
4357                 } else {
4358                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4359                 }
4360         }
4361
4362         /// Processes an incoming announcement_signatures message, providing a fully-signed
4363         /// channel_announcement message which we can broadcast and storing our counterparty's
4364         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4365         pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4366                 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4367
4368                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4369
4370                 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4371                         return Err(ChannelError::Close(format!(
4372                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4373                                  &announcement, self.get_counterparty_node_id())));
4374                 }
4375                 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4376                         return Err(ChannelError::Close(format!(
4377                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4378                                 &announcement, self.counterparty_funding_pubkey())));
4379                 }
4380
4381                 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4382
4383                 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4384         }
4385
4386         /// Gets a signed channel_announcement for this channel, if we previously received an
4387         /// announcement_signatures from our counterparty.
4388         pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4389                 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4390                         Ok(res) => res,
4391                         Err(_) => return None,
4392                 };
4393                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4394                 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4395                         Ok(res) => Some(res),
4396                         Err(_) => None,
4397                 }
4398         }
4399
4400         /// May panic if called on a channel that wasn't immediately-previously
4401         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4402         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4403                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4404                 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4405                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4406                 // current to_remote balances. However, it no longer has any use, and thus is now simply
4407                 // set to a dummy (but valid, as required by the spec) public key.
4408                 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4409                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4410                 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4411                 let mut pk = [2; 33]; pk[1] = 0xff;
4412                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4413                 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4414                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4415                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), log_bytes!(self.channel_id()));
4416                         OptionalField::Present(DataLossProtect {
4417                                 your_last_per_commitment_secret: remote_last_secret,
4418                                 my_current_per_commitment_point: dummy_pubkey
4419                         })
4420                 } else {
4421                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4422                         OptionalField::Present(DataLossProtect {
4423                                 your_last_per_commitment_secret: [0;32],
4424                                 my_current_per_commitment_point: dummy_pubkey,
4425                         })
4426                 };
4427                 msgs::ChannelReestablish {
4428                         channel_id: self.channel_id(),
4429                         // The protocol has two different commitment number concepts - the "commitment
4430                         // transaction number", which starts from 0 and counts up, and the "revocation key
4431                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4432                         // commitment transaction numbers by the index which will be used to reveal the
4433                         // revocation key for that commitment transaction, which means we have to convert them
4434                         // to protocol-level commitment numbers here...
4435
4436                         // next_local_commitment_number is the next commitment_signed number we expect to
4437                         // receive (indicating if they need to resend one that we missed).
4438                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4439                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4440                         // receive, however we track it by the next commitment number for a remote transaction
4441                         // (which is one further, as they always revoke previous commitment transaction, not
4442                         // the one we send) so we have to decrement by 1. Note that if
4443                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4444                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4445                         // overflow here.
4446                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4447                         data_loss_protect,
4448                 }
4449         }
4450
4451
4452         // Send stuff to our remote peers:
4453
4454         /// Adds a pending outbound HTLC to this channel, note that you probably want
4455         /// send_htlc_and_commit instead cause you'll want both messages at once.
4456         ///
4457         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4458         /// the wire:
4459         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4460         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4461         ///   awaiting ACK.
4462         /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4463         ///   may not yet have sent the previous commitment update messages and will need to regenerate
4464         ///   them.
4465         ///
4466         /// You MUST call send_commitment prior to calling any other methods on this Channel!
4467         ///
4468         /// If an Err is returned, it's a ChannelError::Ignore!
4469         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> {
4470                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4471                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4472                 }
4473                 let channel_total_msat = self.channel_value_satoshis * 1000;
4474                 if amount_msat > channel_total_msat {
4475                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4476                 }
4477
4478                 if amount_msat == 0 {
4479                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4480                 }
4481
4482                 if amount_msat < self.counterparty_htlc_minimum_msat {
4483                         return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4484                 }
4485
4486                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4487                         // Note that this should never really happen, if we're !is_live() on receipt of an
4488                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4489                         // the user to send directly into a !is_live() channel. However, if we
4490                         // disconnected during the time the previous hop was doing the commitment dance we may
4491                         // end up getting here after the forwarding delay. In any case, returning an
4492                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4493                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4494                 }
4495
4496                 let inbound_stats = self.get_inbound_pending_htlc_stats();
4497                 let outbound_stats = self.get_outbound_pending_htlc_stats();
4498                 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
4499                         return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4500                 }
4501                 // Check their_max_htlc_value_in_flight_msat
4502                 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4503                         return Err(ChannelError::Ignore(format!("Cannot send value that would put us over the max HTLC value in flight our peer will accept ({})", self.counterparty_max_htlc_value_in_flight_msat)));
4504                 }
4505
4506                 if !self.is_outbound() {
4507                         // Check that we won't violate the remote channel reserve by adding this HTLC.
4508                         let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4509                         let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4510                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4511                         let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4512                         if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4513                                 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4514                         }
4515                 }
4516
4517                 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
4518                 if amount_msat / 1000 < exposure_dust_limit_success_sats {
4519                         let on_counterparty_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + amount_msat;
4520                         if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4521                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
4522                                         on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4523                         }
4524                 }
4525
4526                 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
4527                 if amount_msat / 1000 <  exposure_dust_limit_timeout_sats {
4528                         let on_holder_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + amount_msat;
4529                         if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4530                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
4531                                         on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4532                         }
4533                 }
4534
4535                 let pending_value_to_self_msat = self.value_to_self_msat - outbound_stats.pending_htlcs_value_msat;
4536                 if pending_value_to_self_msat < amount_msat {
4537                         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)));
4538                 }
4539
4540                 // `2 *` and extra HTLC are for the fee spike buffer.
4541                 let commit_tx_fee_msat = if self.is_outbound() {
4542                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4543                         FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4544                 } else { 0 };
4545                 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4546                         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, commit_tx_fee_msat)));
4547                 }
4548
4549                 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4550                 // reserve for the remote to have something to claim if we misbehave)
4551                 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4552                 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4553                         return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4554                 }
4555
4556                 // Now update local state:
4557                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4558                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4559                                 amount_msat,
4560                                 payment_hash,
4561                                 cltv_expiry,
4562                                 source,
4563                                 onion_routing_packet,
4564                         });
4565                         return Ok(None);
4566                 }
4567
4568                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4569                         htlc_id: self.next_holder_htlc_id,
4570                         amount_msat,
4571                         payment_hash: payment_hash.clone(),
4572                         cltv_expiry,
4573                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4574                         source,
4575                 });
4576
4577                 let res = msgs::UpdateAddHTLC {
4578                         channel_id: self.channel_id,
4579                         htlc_id: self.next_holder_htlc_id,
4580                         amount_msat,
4581                         payment_hash,
4582                         cltv_expiry,
4583                         onion_routing_packet,
4584                 };
4585                 self.next_holder_htlc_id += 1;
4586
4587                 Ok(Some(res))
4588         }
4589
4590         /// Creates a signed commitment transaction to send to the remote peer.
4591         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4592         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4593         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4594         pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4595                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4596                         panic!("Cannot create commitment tx until channel is fully established");
4597                 }
4598                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4599                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
4600                 }
4601                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4602                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4603                 }
4604                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4605                         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");
4606                 }
4607                 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
4608                 for htlc in self.pending_outbound_htlcs.iter() {
4609                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4610                                 have_updates = true;
4611                         }
4612                         if have_updates { break; }
4613                 }
4614                 for htlc in self.pending_inbound_htlcs.iter() {
4615                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4616                                 have_updates = true;
4617                         }
4618                         if have_updates { break; }
4619                 }
4620                 if !have_updates {
4621                         panic!("Cannot create commitment tx until we have some updates to send");
4622                 }
4623                 self.send_commitment_no_status_check(logger)
4624         }
4625         /// Only fails in case of bad keys
4626         fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4627                 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
4628                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4629                 // fail to generate this, we still are at least at a position where upgrading their status
4630                 // is acceptable.
4631                 for htlc in self.pending_inbound_htlcs.iter_mut() {
4632                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4633                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4634                         } else { None };
4635                         if let Some(state) = new_state {
4636                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4637                                 htlc.state = state;
4638                         }
4639                 }
4640                 for htlc in self.pending_outbound_htlcs.iter_mut() {
4641                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4642                                 Some(fail_reason.take())
4643                         } else { None } {
4644                                 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4645                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4646                         }
4647                 }
4648                 if let Some((feerate, update_state)) = self.pending_update_fee {
4649                         if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
4650                                 debug_assert!(!self.is_outbound());
4651                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4652                                 self.feerate_per_kw = feerate;
4653                                 self.pending_update_fee = None;
4654                         }
4655                 }
4656                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4657
4658                 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4659                         Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4660                                 // Update state now that we've passed all the can-fail calls...
4661                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4662                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4663                                 (res, counterparty_commitment_tx, htlcs_no_ref)
4664                         },
4665                         Err(e) => return Err(e),
4666                 };
4667
4668                 self.latest_monitor_update_id += 1;
4669                 let monitor_update = ChannelMonitorUpdate {
4670                         update_id: self.latest_monitor_update_id,
4671                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4672                                 commitment_txid: counterparty_commitment_txid,
4673                                 htlc_outputs: htlcs.clone(),
4674                                 commitment_number: self.cur_counterparty_commitment_transaction_number,
4675                                 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4676                         }]
4677                 };
4678                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4679                 Ok((res, monitor_update))
4680         }
4681
4682         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4683         /// when we shouldn't change HTLC/channel state.
4684         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4685                 let counterparty_keys = self.build_remote_transaction_keys()?;
4686                 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
4687                 let feerate_per_kw = counterparty_commitment_tx.1;
4688                 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4689                 let (signature, htlc_signatures);
4690
4691                 #[cfg(any(test, feature = "fuzztarget"))]
4692                 {
4693                         if !self.is_outbound() {
4694                                 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4695                                 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4696                                 if let Some(info) = projected_commit_tx_info {
4697                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4698                                         if info.total_pending_htlcs == total_pending_htlcs
4699                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
4700                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4701                                                 && info.feerate == self.feerate_per_kw {
4702                                                         let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.2);
4703                                                         assert_eq!(actual_fee, info.fee);
4704                                                 }
4705                                 }
4706                         }
4707                 }
4708
4709                 {
4710                         let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.3.len());
4711                         for &(ref htlc, _) in counterparty_commitment_tx.3.iter() {
4712                                 htlcs.push(htlc);
4713                         }
4714
4715                         let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4716                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4717                         signature = res.0;
4718                         htlc_signatures = res.1;
4719
4720                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4721                                 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4722                                 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4723                                 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4724
4725                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4726                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4727                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
4728                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4729                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4730                                         log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4731                         }
4732                 }
4733
4734                 Ok((msgs::CommitmentSigned {
4735                         channel_id: self.channel_id,
4736                         signature,
4737                         htlc_signatures,
4738                 }, (counterparty_commitment_txid, counterparty_commitment_tx.3)))
4739         }
4740
4741         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4742         /// to send to the remote peer in one go.
4743         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4744         /// more info.
4745         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 {
4746                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4747                         Some(update_add_htlc) => {
4748                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4749                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4750                         },
4751                         None => Ok(None)
4752                 }
4753         }
4754
4755         /// Get forwarding information for the counterparty.
4756         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4757                 self.counterparty_forwarding_info.clone()
4758         }
4759
4760         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4761                 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4762                         return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4763                 }
4764                 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4765                         fee_base_msat: msg.contents.fee_base_msat,
4766                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4767                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
4768                 });
4769
4770                 Ok(())
4771         }
4772
4773         /// Begins the shutdown process, getting a message for the remote peer and returning all
4774         /// holding cell HTLCs for payment failure.
4775         pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures, target_feerate_sats_per_kw: Option<u32>)
4776         -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
4777         where K::Target: KeysInterface<Signer = Signer> {
4778                 for htlc in self.pending_outbound_htlcs.iter() {
4779                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4780                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4781                         }
4782                 }
4783                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4784                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4785                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4786                         }
4787                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4788                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4789                         }
4790                 }
4791                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4792                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4793                         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()});
4794                 }
4795
4796                 let update_shutdown_script = match self.shutdown_scriptpubkey {
4797                         Some(_) => false,
4798                         None => {
4799                                 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
4800                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
4801                                         return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
4802                                 }
4803                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4804                                 true
4805                         },
4806                 };
4807
4808                 // From here on out, we may not fail!
4809                 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
4810                 if self.channel_state < ChannelState::FundingSent as u32 {
4811                         self.channel_state = ChannelState::ShutdownComplete as u32;
4812                 } else {
4813                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
4814                 }
4815                 self.update_time_counter += 1;
4816
4817                 let monitor_update = if update_shutdown_script {
4818                         self.latest_monitor_update_id += 1;
4819                         Some(ChannelMonitorUpdate {
4820                                 update_id: self.latest_monitor_update_id,
4821                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4822                                         scriptpubkey: self.get_closing_scriptpubkey(),
4823                                 }],
4824                         })
4825                 } else { None };
4826                 let shutdown = msgs::Shutdown {
4827                         channel_id: self.channel_id,
4828                         scriptpubkey: self.get_closing_scriptpubkey(),
4829                 };
4830
4831                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4832                 // our shutdown until we've committed all of the pending changes.
4833                 self.holding_cell_update_fee = None;
4834                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4835                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4836                         match htlc_update {
4837                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4838                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4839                                         false
4840                                 },
4841                                 _ => true
4842                         }
4843                 });
4844
4845                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4846         }
4847
4848         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4849         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4850         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4851         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4852         /// immediately (others we will have to allow to time out).
4853         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4854                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4855                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4856                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4857                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4858                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4859
4860                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4861                 // return them to fail the payment.
4862                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4863                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4864                         match htlc_update {
4865                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4866                                         dropped_outbound_htlcs.push((source, payment_hash));
4867                                 },
4868                                 _ => {}
4869                         }
4870                 }
4871                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4872                         // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4873                         // returning a channel monitor update here would imply a channel monitor update before
4874                         // we even registered the channel monitor to begin with, which is invalid.
4875                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
4876                         // funding transaction, don't return a funding txo (which prevents providing the
4877                         // monitor update to the user, even if we return one).
4878                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4879                         if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4880                                 self.latest_monitor_update_id += 1;
4881                                 Some((funding_txo, ChannelMonitorUpdate {
4882                                         update_id: self.latest_monitor_update_id,
4883                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4884                                 }))
4885                         } else { None }
4886                 } else { None };
4887
4888                 self.channel_state = ChannelState::ShutdownComplete as u32;
4889                 self.update_time_counter += 1;
4890                 (monitor_update, dropped_outbound_htlcs)
4891         }
4892 }
4893
4894 const SERIALIZATION_VERSION: u8 = 2;
4895 const MIN_SERIALIZATION_VERSION: u8 = 1;
4896
4897 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4898         (0, FailRelay),
4899         (1, FailMalformed),
4900         (2, Fulfill),
4901 );
4902
4903 impl Writeable for ChannelUpdateStatus {
4904         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4905                 // We only care about writing out the current state as it was announced, ie only either
4906                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4907                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4908                 match self {
4909                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4910                         ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4911                         ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4912                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4913                 }
4914                 Ok(())
4915         }
4916 }
4917
4918 impl Readable for ChannelUpdateStatus {
4919         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4920                 Ok(match <u8 as Readable>::read(reader)? {
4921                         0 => ChannelUpdateStatus::Enabled,
4922                         1 => ChannelUpdateStatus::Disabled,
4923                         _ => return Err(DecodeError::InvalidValue),
4924                 })
4925         }
4926 }
4927
4928 impl<Signer: Sign> Writeable for Channel<Signer> {
4929         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4930                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4931                 // called.
4932
4933                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4934
4935                 self.user_id.write(writer)?;
4936
4937                 // Write out the old serialization for the config object. This is read by version-1
4938                 // deserializers, but we will read the version in the TLV at the end instead.
4939                 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4940                 self.config.cltv_expiry_delta.write(writer)?;
4941                 self.config.announced_channel.write(writer)?;
4942                 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4943
4944                 self.channel_id.write(writer)?;
4945                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4946                 self.channel_value_satoshis.write(writer)?;
4947
4948                 self.latest_monitor_update_id.write(writer)?;
4949
4950                 let mut key_data = VecWriter(Vec::new());
4951                 self.holder_signer.write(&mut key_data)?;
4952                 assert!(key_data.0.len() < core::usize::MAX);
4953                 assert!(key_data.0.len() < core::u32::MAX as usize);
4954                 (key_data.0.len() as u32).write(writer)?;
4955                 writer.write_all(&key_data.0[..])?;
4956
4957                 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4958                 // deserialized from that format.
4959                 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4960                         Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4961                         None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4962                 }
4963                 self.destination_script.write(writer)?;
4964
4965                 self.cur_holder_commitment_transaction_number.write(writer)?;
4966                 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4967                 self.value_to_self_msat.write(writer)?;
4968
4969                 let mut dropped_inbound_htlcs = 0;
4970                 for htlc in self.pending_inbound_htlcs.iter() {
4971                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4972                                 dropped_inbound_htlcs += 1;
4973                         }
4974                 }
4975                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4976                 for htlc in self.pending_inbound_htlcs.iter() {
4977                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4978                                 continue; // Drop
4979                         }
4980                         htlc.htlc_id.write(writer)?;
4981                         htlc.amount_msat.write(writer)?;
4982                         htlc.cltv_expiry.write(writer)?;
4983                         htlc.payment_hash.write(writer)?;
4984                         match &htlc.state {
4985                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4986                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4987                                         1u8.write(writer)?;
4988                                         htlc_state.write(writer)?;
4989                                 },
4990                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4991                                         2u8.write(writer)?;
4992                                         htlc_state.write(writer)?;
4993                                 },
4994                                 &InboundHTLCState::Committed => {
4995                                         3u8.write(writer)?;
4996                                 },
4997                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4998                                         4u8.write(writer)?;
4999                                         removal_reason.write(writer)?;
5000                                 },
5001                         }
5002                 }
5003
5004                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
5005                 for htlc in self.pending_outbound_htlcs.iter() {
5006                         htlc.htlc_id.write(writer)?;
5007                         htlc.amount_msat.write(writer)?;
5008                         htlc.cltv_expiry.write(writer)?;
5009                         htlc.payment_hash.write(writer)?;
5010                         htlc.source.write(writer)?;
5011                         match &htlc.state {
5012                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
5013                                         0u8.write(writer)?;
5014                                         onion_packet.write(writer)?;
5015                                 },
5016                                 &OutboundHTLCState::Committed => {
5017                                         1u8.write(writer)?;
5018                                 },
5019                                 &OutboundHTLCState::RemoteRemoved(_) => {
5020                                         // Treat this as a Committed because we haven't received the CS - they'll
5021                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
5022                                         1u8.write(writer)?;
5023                                 },
5024                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
5025                                         3u8.write(writer)?;
5026                                         fail_reason.write(writer)?;
5027                                 },
5028                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
5029                                         4u8.write(writer)?;
5030                                         fail_reason.write(writer)?;
5031                                 },
5032                         }
5033                 }
5034
5035                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
5036                 for update in self.holding_cell_htlc_updates.iter() {
5037                         match update {
5038                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
5039                                         0u8.write(writer)?;
5040                                         amount_msat.write(writer)?;
5041                                         cltv_expiry.write(writer)?;
5042                                         payment_hash.write(writer)?;
5043                                         source.write(writer)?;
5044                                         onion_routing_packet.write(writer)?;
5045                                 },
5046                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
5047                                         1u8.write(writer)?;
5048                                         payment_preimage.write(writer)?;
5049                                         htlc_id.write(writer)?;
5050                                 },
5051                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
5052                                         2u8.write(writer)?;
5053                                         htlc_id.write(writer)?;
5054                                         err_packet.write(writer)?;
5055                                 }
5056                         }
5057                 }
5058
5059                 match self.resend_order {
5060                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
5061                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
5062                 }
5063
5064                 self.monitor_pending_funding_locked.write(writer)?;
5065                 self.monitor_pending_revoke_and_ack.write(writer)?;
5066                 self.monitor_pending_commitment_signed.write(writer)?;
5067
5068                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
5069                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
5070                         pending_forward.write(writer)?;
5071                         htlc_id.write(writer)?;
5072                 }
5073
5074                 (self.monitor_pending_failures.len() as u64).write(writer)?;
5075                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
5076                         htlc_source.write(writer)?;
5077                         payment_hash.write(writer)?;
5078                         fail_reason.write(writer)?;
5079                 }
5080
5081                 if self.is_outbound() {
5082                         self.pending_update_fee.map(|(a, _)| a).write(writer)?;
5083                 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
5084                         Some(feerate).write(writer)?;
5085                 } else {
5086                         // As for inbound HTLCs, if the update was only announced and never committed in a
5087                         // commitment_signed, drop it.
5088                         None::<u32>.write(writer)?;
5089                 }
5090                 self.holding_cell_update_fee.write(writer)?;
5091
5092                 self.next_holder_htlc_id.write(writer)?;
5093                 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
5094                 self.update_time_counter.write(writer)?;
5095                 self.feerate_per_kw.write(writer)?;
5096
5097                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5098                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5099                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5100                 // consider the stale state on reload.
5101                 0u8.write(writer)?;
5102
5103                 self.funding_tx_confirmed_in.write(writer)?;
5104                 self.funding_tx_confirmation_height.write(writer)?;
5105                 self.short_channel_id.write(writer)?;
5106
5107                 self.counterparty_dust_limit_satoshis.write(writer)?;
5108                 self.holder_dust_limit_satoshis.write(writer)?;
5109                 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
5110
5111                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5112                 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
5113
5114                 self.counterparty_htlc_minimum_msat.write(writer)?;
5115                 self.holder_htlc_minimum_msat.write(writer)?;
5116                 self.counterparty_max_accepted_htlcs.write(writer)?;
5117
5118                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5119                 self.minimum_depth.unwrap_or(0).write(writer)?;
5120
5121                 match &self.counterparty_forwarding_info {
5122                         Some(info) => {
5123                                 1u8.write(writer)?;
5124                                 info.fee_base_msat.write(writer)?;
5125                                 info.fee_proportional_millionths.write(writer)?;
5126                                 info.cltv_expiry_delta.write(writer)?;
5127                         },
5128                         None => 0u8.write(writer)?
5129                 }
5130
5131                 self.channel_transaction_parameters.write(writer)?;
5132                 self.funding_transaction.write(writer)?;
5133
5134                 self.counterparty_cur_commitment_point.write(writer)?;
5135                 self.counterparty_prev_commitment_point.write(writer)?;
5136                 self.counterparty_node_id.write(writer)?;
5137
5138                 self.counterparty_shutdown_scriptpubkey.write(writer)?;
5139
5140                 self.commitment_secrets.write(writer)?;
5141
5142                 self.channel_update_status.write(writer)?;
5143
5144                 #[cfg(any(test, feature = "fuzztarget"))]
5145                 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
5146                 #[cfg(any(test, feature = "fuzztarget"))]
5147                 for htlc in self.historical_inbound_htlc_fulfills.iter() {
5148                         htlc.write(writer)?;
5149                 }
5150
5151                 write_tlv_fields!(writer, {
5152                         (0, self.announcement_sigs, option),
5153                         // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
5154                         // default value instead of being Option<>al. Thus, to maintain compatibility we write
5155                         // them twice, once with their original default values above, and once as an option
5156                         // here. On the read side, old versions will simply ignore the odd-type entries here,
5157                         // and new versions map the default values to None and allow the TLV entries here to
5158                         // override that.
5159                         (1, self.minimum_depth, option),
5160                         (3, self.counterparty_selected_channel_reserve_satoshis, option),
5161                         (5, self.config, required),
5162                         (7, self.shutdown_scriptpubkey, option),
5163                         (9, self.target_closing_feerate_sats_per_kw, option),
5164                 });
5165
5166                 Ok(())
5167         }
5168 }
5169
5170 const MAX_ALLOC_SIZE: usize = 64*1024;
5171 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
5172                 where K::Target: KeysInterface<Signer = Signer> {
5173         fn read<R : io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
5174                 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5175
5176                 let user_id = Readable::read(reader)?;
5177
5178                 let mut config = Some(ChannelConfig::default());
5179                 if ver == 1 {
5180                         // Read the old serialization of the ChannelConfig from version 0.0.98.
5181                         config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
5182                         config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
5183                         config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5184                         config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5185                 } else {
5186                         // Read the 8 bytes of backwards-compatibility ChannelConfig data.
5187                         let mut _val: u64 = Readable::read(reader)?;
5188                 }
5189
5190                 let channel_id = Readable::read(reader)?;
5191                 let channel_state = Readable::read(reader)?;
5192                 let channel_value_satoshis = Readable::read(reader)?;
5193
5194                 let latest_monitor_update_id = Readable::read(reader)?;
5195
5196                 let keys_len: u32 = Readable::read(reader)?;
5197                 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
5198                 while keys_data.len() != keys_len as usize {
5199                         // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
5200                         let mut data = [0; 1024];
5201                         let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
5202                         reader.read_exact(read_slice)?;
5203                         keys_data.extend_from_slice(read_slice);
5204                 }
5205                 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
5206
5207                 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
5208                 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
5209                         Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
5210                         Err(_) => None,
5211                 };
5212                 let destination_script = Readable::read(reader)?;
5213
5214                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
5215                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
5216                 let value_to_self_msat = Readable::read(reader)?;
5217
5218                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
5219                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5220                 for _ in 0..pending_inbound_htlc_count {
5221                         pending_inbound_htlcs.push(InboundHTLCOutput {
5222                                 htlc_id: Readable::read(reader)?,
5223                                 amount_msat: Readable::read(reader)?,
5224                                 cltv_expiry: Readable::read(reader)?,
5225                                 payment_hash: Readable::read(reader)?,
5226                                 state: match <u8 as Readable>::read(reader)? {
5227                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
5228                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
5229                                         3 => InboundHTLCState::Committed,
5230                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
5231                                         _ => return Err(DecodeError::InvalidValue),
5232                                 },
5233                         });
5234                 }
5235
5236                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
5237                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5238                 for _ in 0..pending_outbound_htlc_count {
5239                         pending_outbound_htlcs.push(OutboundHTLCOutput {
5240                                 htlc_id: Readable::read(reader)?,
5241                                 amount_msat: Readable::read(reader)?,
5242                                 cltv_expiry: Readable::read(reader)?,
5243                                 payment_hash: Readable::read(reader)?,
5244                                 source: Readable::read(reader)?,
5245                                 state: match <u8 as Readable>::read(reader)? {
5246                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
5247                                         1 => OutboundHTLCState::Committed,
5248                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
5249                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
5250                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
5251                                         _ => return Err(DecodeError::InvalidValue),
5252                                 },
5253                         });
5254                 }
5255
5256                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
5257                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
5258                 for _ in 0..holding_cell_htlc_update_count {
5259                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
5260                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
5261                                         amount_msat: Readable::read(reader)?,
5262                                         cltv_expiry: Readable::read(reader)?,
5263                                         payment_hash: Readable::read(reader)?,
5264                                         source: Readable::read(reader)?,
5265                                         onion_routing_packet: Readable::read(reader)?,
5266                                 },
5267                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
5268                                         payment_preimage: Readable::read(reader)?,
5269                                         htlc_id: Readable::read(reader)?,
5270                                 },
5271                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
5272                                         htlc_id: Readable::read(reader)?,
5273                                         err_packet: Readable::read(reader)?,
5274                                 },
5275                                 _ => return Err(DecodeError::InvalidValue),
5276                         });
5277                 }
5278
5279                 let resend_order = match <u8 as Readable>::read(reader)? {
5280                         0 => RAACommitmentOrder::CommitmentFirst,
5281                         1 => RAACommitmentOrder::RevokeAndACKFirst,
5282                         _ => return Err(DecodeError::InvalidValue),
5283                 };
5284
5285                 let monitor_pending_funding_locked = Readable::read(reader)?;
5286                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
5287                 let monitor_pending_commitment_signed = Readable::read(reader)?;
5288
5289                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
5290                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
5291                 for _ in 0..monitor_pending_forwards_count {
5292                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
5293                 }
5294
5295                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
5296                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
5297                 for _ in 0..monitor_pending_failures_count {
5298                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
5299                 }
5300
5301                 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
5302
5303                 let holding_cell_update_fee = Readable::read(reader)?;
5304
5305                 let next_holder_htlc_id = Readable::read(reader)?;
5306                 let next_counterparty_htlc_id = Readable::read(reader)?;
5307                 let update_time_counter = Readable::read(reader)?;
5308                 let feerate_per_kw = Readable::read(reader)?;
5309
5310                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5311                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5312                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5313                 // consider the stale state on reload.
5314                 match <u8 as Readable>::read(reader)? {
5315                         0 => {},
5316                         1 => {
5317                                 let _: u32 = Readable::read(reader)?;
5318                                 let _: u64 = Readable::read(reader)?;
5319                                 let _: Signature = Readable::read(reader)?;
5320                         },
5321                         _ => return Err(DecodeError::InvalidValue),
5322                 }
5323
5324                 let funding_tx_confirmed_in = Readable::read(reader)?;
5325                 let funding_tx_confirmation_height = Readable::read(reader)?;
5326                 let short_channel_id = Readable::read(reader)?;
5327
5328                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
5329                 let holder_dust_limit_satoshis = Readable::read(reader)?;
5330                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
5331                 let mut counterparty_selected_channel_reserve_satoshis = None;
5332                 if ver == 1 {
5333                         // Read the old serialization from version 0.0.98.
5334                         counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
5335                 } else {
5336                         // Read the 8 bytes of backwards-compatibility data.
5337                         let _dummy: u64 = Readable::read(reader)?;
5338                 }
5339                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
5340                 let holder_htlc_minimum_msat = Readable::read(reader)?;
5341                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
5342
5343                 let mut minimum_depth = None;
5344                 if ver == 1 {
5345                         // Read the old serialization from version 0.0.98.
5346                         minimum_depth = Some(Readable::read(reader)?);
5347                 } else {
5348                         // Read the 4 bytes of backwards-compatibility data.
5349                         let _dummy: u32 = Readable::read(reader)?;
5350                 }
5351
5352                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5353                         0 => None,
5354                         1 => Some(CounterpartyForwardingInfo {
5355                                 fee_base_msat: Readable::read(reader)?,
5356                                 fee_proportional_millionths: Readable::read(reader)?,
5357                                 cltv_expiry_delta: Readable::read(reader)?,
5358                         }),
5359                         _ => return Err(DecodeError::InvalidValue),
5360                 };
5361
5362                 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
5363                 let funding_transaction = Readable::read(reader)?;
5364
5365                 let counterparty_cur_commitment_point = Readable::read(reader)?;
5366
5367                 let counterparty_prev_commitment_point = Readable::read(reader)?;
5368                 let counterparty_node_id = Readable::read(reader)?;
5369
5370                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5371                 let commitment_secrets = Readable::read(reader)?;
5372
5373                 let channel_update_status = Readable::read(reader)?;
5374
5375                 #[cfg(any(test, feature = "fuzztarget"))]
5376                 let mut historical_inbound_htlc_fulfills = HashSet::new();
5377                 #[cfg(any(test, feature = "fuzztarget"))]
5378                 {
5379                         let htlc_fulfills_len: u64 = Readable::read(reader)?;
5380                         for _ in 0..htlc_fulfills_len {
5381                                 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5382                         }
5383                 }
5384
5385                 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
5386                         Some((feerate, if channel_parameters.is_outbound_from_holder {
5387                                 FeeUpdateState::Outbound
5388                         } else {
5389                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
5390                         }))
5391                 } else {
5392                         None
5393                 };
5394
5395                 let mut announcement_sigs = None;
5396                 let mut target_closing_feerate_sats_per_kw = None;
5397                 read_tlv_fields!(reader, {
5398                         (0, announcement_sigs, option),
5399                         (1, minimum_depth, option),
5400                         (3, counterparty_selected_channel_reserve_satoshis, option),
5401                         (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5402                         (7, shutdown_scriptpubkey, option),
5403                         (9, target_closing_feerate_sats_per_kw, option),
5404                 });
5405
5406                 let mut secp_ctx = Secp256k1::new();
5407                 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5408
5409                 Ok(Channel {
5410                         user_id,
5411
5412                         config: config.unwrap(),
5413                         channel_id,
5414                         channel_state,
5415                         secp_ctx,
5416                         channel_value_satoshis,
5417
5418                         latest_monitor_update_id,
5419
5420                         holder_signer,
5421                         shutdown_scriptpubkey,
5422                         destination_script,
5423
5424                         cur_holder_commitment_transaction_number,
5425                         cur_counterparty_commitment_transaction_number,
5426                         value_to_self_msat,
5427
5428                         pending_inbound_htlcs,
5429                         pending_outbound_htlcs,
5430                         holding_cell_htlc_updates,
5431
5432                         resend_order,
5433
5434                         monitor_pending_funding_locked,
5435                         monitor_pending_revoke_and_ack,
5436                         monitor_pending_commitment_signed,
5437                         monitor_pending_forwards,
5438                         monitor_pending_failures,
5439
5440                         pending_update_fee,
5441                         holding_cell_update_fee,
5442                         next_holder_htlc_id,
5443                         next_counterparty_htlc_id,
5444                         update_time_counter,
5445                         feerate_per_kw,
5446
5447                         #[cfg(debug_assertions)]
5448                         holder_max_commitment_tx_output: Mutex::new((0, 0)),
5449                         #[cfg(debug_assertions)]
5450                         counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5451
5452                         last_sent_closing_fee: None,
5453                         pending_counterparty_closing_signed: None,
5454                         closing_fee_limits: None,
5455                         target_closing_feerate_sats_per_kw,
5456
5457                         funding_tx_confirmed_in,
5458                         funding_tx_confirmation_height,
5459                         short_channel_id,
5460
5461                         counterparty_dust_limit_satoshis,
5462                         holder_dust_limit_satoshis,
5463                         counterparty_max_htlc_value_in_flight_msat,
5464                         counterparty_selected_channel_reserve_satoshis,
5465                         counterparty_htlc_minimum_msat,
5466                         holder_htlc_minimum_msat,
5467                         counterparty_max_accepted_htlcs,
5468                         minimum_depth,
5469
5470                         counterparty_forwarding_info,
5471
5472                         channel_transaction_parameters: channel_parameters,
5473                         funding_transaction,
5474
5475                         counterparty_cur_commitment_point,
5476                         counterparty_prev_commitment_point,
5477                         counterparty_node_id,
5478
5479                         counterparty_shutdown_scriptpubkey,
5480
5481                         commitment_secrets,
5482
5483                         channel_update_status,
5484                         closing_signed_in_flight: false,
5485
5486                         announcement_sigs,
5487
5488                         #[cfg(any(test, feature = "fuzztarget"))]
5489                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5490                         #[cfg(any(test, feature = "fuzztarget"))]
5491                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5492
5493                         workaround_lnd_bug_4006: None,
5494
5495                         #[cfg(any(test, feature = "fuzztarget"))]
5496                         historical_inbound_htlc_fulfills,
5497                 })
5498         }
5499 }
5500
5501 #[cfg(test)]
5502 mod tests {
5503         use bitcoin::util::bip143;
5504         use bitcoin::consensus::encode::serialize;
5505         use bitcoin::blockdata::script::{Script, Builder};
5506         use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5507         use bitcoin::blockdata::constants::genesis_block;
5508         use bitcoin::blockdata::opcodes;
5509         use bitcoin::network::constants::Network;
5510         use bitcoin::hashes::hex::FromHex;
5511         use hex;
5512         use ln::{PaymentPreimage, PaymentHash};
5513         use ln::channelmanager::HTLCSource;
5514         use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5515         use ln::channel::MAX_FUNDING_SATOSHIS;
5516         use ln::features::InitFeatures;
5517         use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5518         use ln::script::ShutdownScript;
5519         use ln::chan_utils;
5520         use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5521         use chain::BestBlock;
5522         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5523         use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5524         use chain::transaction::OutPoint;
5525         use util::config::UserConfig;
5526         use util::enforcing_trait_impls::EnforcingSigner;
5527         use util::errors::APIError;
5528         use util::test_utils;
5529         use util::test_utils::OnGetShutdownScriptpubkey;
5530         use util::logger::Logger;
5531         use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5532         use bitcoin::secp256k1::ffi::Signature as FFISignature;
5533         use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5534         use bitcoin::secp256k1::recovery::RecoverableSignature;
5535         use bitcoin::hashes::sha256::Hash as Sha256;
5536         use bitcoin::hashes::Hash;
5537         use bitcoin::hash_types::{Txid, WPubkeyHash};
5538         use core::num::NonZeroU8;
5539         use sync::Arc;
5540         use prelude::*;
5541
5542         struct TestFeeEstimator {
5543                 fee_est: u32
5544         }
5545         impl FeeEstimator for TestFeeEstimator {
5546                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5547                         self.fee_est
5548                 }
5549         }
5550
5551         #[test]
5552         fn test_max_funding_satoshis() {
5553                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5554                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5555         }
5556
5557         struct Keys {
5558                 signer: InMemorySigner,
5559         }
5560         impl KeysInterface for Keys {
5561                 type Signer = InMemorySigner;
5562
5563                 fn get_node_secret(&self) -> SecretKey { panic!(); }
5564                 fn get_destination_script(&self) -> Script {
5565                         let secp_ctx = Secp256k1::signing_only();
5566                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5567                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5568                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5569                 }
5570
5571                 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5572                         let secp_ctx = Secp256k1::signing_only();
5573                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5574                         ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5575                 }
5576
5577                 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5578                         self.signer.clone()
5579                 }
5580                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5581                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5582                 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5583         }
5584
5585         fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5586                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5587         }
5588
5589         #[test]
5590         fn upfront_shutdown_script_incompatibility() {
5591                 let features = InitFeatures::known().clear_shutdown_anysegwit();
5592                 let non_v0_segwit_shutdown_script =
5593                         ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
5594
5595                 let seed = [42; 32];
5596                 let network = Network::Testnet;
5597                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5598                 keys_provider.expect(OnGetShutdownScriptpubkey {
5599                         returns: non_v0_segwit_shutdown_script.clone(),
5600                 });
5601
5602                 let fee_estimator = TestFeeEstimator { fee_est: 253 };
5603                 let secp_ctx = Secp256k1::new();
5604                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5605                 let config = UserConfig::default();
5606                 match Channel::<EnforcingSigner>::new_outbound(&&fee_estimator, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config) {
5607                         Err(APIError::IncompatibleShutdownScript { script }) => {
5608                                 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
5609                         },
5610                         Err(e) => panic!("Unexpected error: {:?}", e),
5611                         Ok(_) => panic!("Expected error"),
5612                 }
5613         }
5614
5615         // Check that, during channel creation, we use the same feerate in the open channel message
5616         // as we do in the Channel object creation itself.
5617         #[test]
5618         fn test_open_channel_msg_fee() {
5619                 let original_fee = 253;
5620                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5621                 let secp_ctx = Secp256k1::new();
5622                 let seed = [42; 32];
5623                 let network = Network::Testnet;
5624                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5625
5626                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5627                 let config = UserConfig::default();
5628                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5629
5630                 // Now change the fee so we can check that the fee in the open_channel message is the
5631                 // same as the old fee.
5632                 fee_est.fee_est = 500;
5633                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5634                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5635         }
5636
5637         #[test]
5638         fn test_holder_vs_counterparty_dust_limit() {
5639                 // Test that when calculating the local and remote commitment transaction fees, the correct
5640                 // dust limits are used.
5641                 let feeest = TestFeeEstimator{fee_est: 15000};
5642                 let secp_ctx = Secp256k1::new();
5643                 let seed = [42; 32];
5644                 let network = Network::Testnet;
5645                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5646
5647                 // Go through the flow of opening a channel between two nodes, making sure
5648                 // they have different dust limits.
5649
5650                 // Create Node A's channel pointing to Node B's pubkey
5651                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5652                 let config = UserConfig::default();
5653                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5654
5655                 // Create Node B's channel by receiving Node A's open_channel message
5656                 // Make sure A's dust limit is as we expect.
5657                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5658                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5659                 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5660
5661                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5662                 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5663                 accept_channel_msg.dust_limit_satoshis = 546;
5664                 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5665                 node_a_chan.holder_dust_limit_satoshis = 1560;
5666
5667                 // Put some inbound and outbound HTLCs in A's channel.
5668                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5669                 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5670                         htlc_id: 0,
5671                         amount_msat: htlc_amount_msat,
5672                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5673                         cltv_expiry: 300000000,
5674                         state: InboundHTLCState::Committed,
5675                 });
5676
5677                 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5678                         htlc_id: 1,
5679                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5680                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5681                         cltv_expiry: 200000000,
5682                         state: OutboundHTLCState::Committed,
5683                         source: HTLCSource::OutboundRoute {
5684                                 path: Vec::new(),
5685                                 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5686                                 first_hop_htlc_msat: 548,
5687                         }
5688                 });
5689
5690                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5691                 // the dust limit check.
5692                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5693                 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5694                 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5695                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5696
5697                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5698                 // of the HTLCs are seen to be above the dust limit.
5699                 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5700                 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5701                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5702                 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5703                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5704         }
5705
5706         #[test]
5707         fn test_timeout_vs_success_htlc_dust_limit() {
5708                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5709                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5710                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5711                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5712                 let fee_est = TestFeeEstimator{fee_est: 253 };
5713                 let secp_ctx = Secp256k1::new();
5714                 let seed = [42; 32];
5715                 let network = Network::Testnet;
5716                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5717
5718                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5719                 let config = UserConfig::default();
5720                 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5721
5722                 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5723                 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5724
5725                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5726                 // counted as dust when it shouldn't be.
5727                 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5728                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5729                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5730                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5731
5732                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5733                 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5734                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5735                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5736                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5737
5738                 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5739
5740                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5741                 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5742                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5743                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5744                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5745
5746                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5747                 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5748                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5749                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5750                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5751         }
5752
5753         #[test]
5754         fn channel_reestablish_no_updates() {
5755                 let feeest = TestFeeEstimator{fee_est: 15000};
5756                 let logger = test_utils::TestLogger::new();
5757                 let secp_ctx = Secp256k1::new();
5758                 let seed = [42; 32];
5759                 let network = Network::Testnet;
5760                 let best_block = BestBlock::from_genesis(network);
5761                 let chain_hash = best_block.block_hash();
5762                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5763
5764                 // Go through the flow of opening a channel between two nodes.
5765
5766                 // Create Node A's channel pointing to Node B's pubkey
5767                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5768                 let config = UserConfig::default();
5769                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5770
5771                 // Create Node B's channel by receiving Node A's open_channel message
5772                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5773                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5774                 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5775
5776                 // Node B --> Node A: accept channel
5777                 let accept_channel_msg = node_b_chan.get_accept_channel();
5778                 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5779
5780                 // Node A --> Node B: funding created
5781                 let output_script = node_a_chan.get_funding_redeemscript();
5782                 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5783                         value: 10000000, script_pubkey: output_script.clone(),
5784                 }]};
5785                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5786                 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5787                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5788
5789                 // Node B --> Node A: funding signed
5790                 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5791
5792                 // Now disconnect the two nodes and check that the commitment point in
5793                 // Node B's channel_reestablish message is sane.
5794                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5795                 let msg = node_b_chan.get_channel_reestablish(&&logger);
5796                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5797                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5798                 match msg.data_loss_protect {
5799                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5800                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5801                         },
5802                         _ => panic!()
5803                 }
5804
5805                 // Check that the commitment point in Node A's channel_reestablish message
5806                 // is sane.
5807                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5808                 let msg = node_a_chan.get_channel_reestablish(&&logger);
5809                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5810                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5811                 match msg.data_loss_protect {
5812                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5813                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5814                         },
5815                         _ => panic!()
5816                 }
5817         }
5818
5819         #[test]
5820         fn channel_update() {
5821                 let feeest = TestFeeEstimator{fee_est: 15000};
5822                 let secp_ctx = Secp256k1::new();
5823                 let seed = [42; 32];
5824                 let network = Network::Testnet;
5825                 let chain_hash = genesis_block(network).header.block_hash();
5826                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5827
5828                 // Create a channel.
5829                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5830                 let config = UserConfig::default();
5831                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5832                 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5833                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5834                 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5835
5836                 // Make sure that receiving a channel update will update the Channel as expected.
5837                 let update = ChannelUpdate {
5838                         contents: UnsignedChannelUpdate {
5839                                 chain_hash,
5840                                 short_channel_id: 0,
5841                                 timestamp: 0,
5842                                 flags: 0,
5843                                 cltv_expiry_delta: 100,
5844                                 htlc_minimum_msat: 5,
5845                                 htlc_maximum_msat: OptionalField::Absent,
5846                                 fee_base_msat: 110,
5847                                 fee_proportional_millionths: 11,
5848                                 excess_data: Vec::new(),
5849                         },
5850                         signature: Signature::from(unsafe { FFISignature::new() })
5851                 };
5852                 node_a_chan.channel_update(&update).unwrap();
5853
5854                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5855                 // change our official htlc_minimum_msat.
5856                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5857                 match node_a_chan.counterparty_forwarding_info() {
5858                         Some(info) => {
5859                                 assert_eq!(info.cltv_expiry_delta, 100);
5860                                 assert_eq!(info.fee_base_msat, 110);
5861                                 assert_eq!(info.fee_proportional_millionths, 11);
5862                         },
5863                         None => panic!("expected counterparty forwarding info to be Some")
5864                 }
5865         }
5866
5867         #[test]
5868         fn outbound_commitment_test() {
5869                 // Test vectors from BOLT 3 Appendix C:
5870                 let feeest = TestFeeEstimator{fee_est: 15000};
5871                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5872                 let secp_ctx = Secp256k1::new();
5873
5874                 let mut signer = InMemorySigner::new(
5875                         &secp_ctx,
5876                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5877                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5878                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5879                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5880                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5881
5882                         // These aren't set in the test vectors:
5883                         [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],
5884                         10_000_000,
5885                         [0; 32]
5886                 );
5887
5888                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5889                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5890                 let keys_provider = Keys { signer: signer.clone() };
5891
5892                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5893                 let mut config = UserConfig::default();
5894                 config.channel_options.announced_channel = false;
5895                 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, &InitFeatures::known(), 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5896                 chan.holder_dust_limit_satoshis = 546;
5897                 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5898
5899                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5900
5901                 let counterparty_pubkeys = ChannelPublicKeys {
5902                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5903                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5904                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5905                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5906                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5907                 };
5908                 chan.channel_transaction_parameters.counterparty_parameters = Some(
5909                         CounterpartyChannelTransactionParameters {
5910                                 pubkeys: counterparty_pubkeys.clone(),
5911                                 selected_contest_delay: 144
5912                         });
5913                 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5914                 signer.ready_channel(&chan.channel_transaction_parameters);
5915
5916                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5917                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5918
5919                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5920                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5921
5922                 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5923                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5924
5925                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5926                 // derived from a commitment_seed, so instead we copy it here and call
5927                 // build_commitment_transaction.
5928                 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5929                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5930                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5931                 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5932                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5933
5934                 macro_rules! test_commitment {
5935                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5936                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5937                         } ) => { {
5938                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5939                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
5940
5941                                         let htlcs = res.3.drain(..)
5942                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5943                                                 .collect();
5944                                         (res.0, htlcs)
5945                                 };
5946                                 let trusted_tx = commitment_tx.trust();
5947                                 let unsigned_tx = trusted_tx.built_transaction();
5948                                 let redeemscript = chan.get_funding_redeemscript();
5949                                 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5950                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5951                                 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5952
5953                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5954                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5955                                 let mut counterparty_htlc_sigs = Vec::new();
5956                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5957                                 $({
5958                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5959                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5960                                         counterparty_htlc_sigs.push(remote_signature);
5961                                 })*
5962                                 assert_eq!(htlcs.len(), per_htlc.len());
5963
5964                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
5965                                         commitment_tx.clone(),
5966                                         counterparty_signature,
5967                                         counterparty_htlc_sigs,
5968                                         &chan.holder_signer.pubkeys().funding_pubkey,
5969                                         chan.counterparty_funding_pubkey()
5970                                 );
5971                                 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5972                                 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5973
5974                                 let funding_redeemscript = chan.get_funding_redeemscript();
5975                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5976                                 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5977
5978                                 // ((htlc, counterparty_sig), (index, holder_sig))
5979                                 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5980
5981                                 $({
5982                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5983
5984                                         let ref htlc = htlcs[$htlc_idx];
5985                                         let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5986                                                 chan.get_counterparty_selected_contest_delay().unwrap(),
5987                                                 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5988                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5989                                         let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5990                                         secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5991
5992                                         let mut preimage: Option<PaymentPreimage> = None;
5993                                         if !htlc.offered {
5994                                                 for i in 0..5 {
5995                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5996                                                         if out == htlc.payment_hash {
5997                                                                 preimage = Some(PaymentPreimage([i; 32]));
5998                                                         }
5999                                                 }
6000
6001                                                 assert!(preimage.is_some());
6002                                         }
6003
6004                                         let htlc_sig = htlc_sig_iter.next().unwrap();
6005                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
6006
6007                                         let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
6008                                         assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
6009                                         let index = (htlc_sig.1).0;
6010                                         let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
6011                                         let trusted_tx = holder_commitment_tx.trust();
6012                                         assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
6013                                                         hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
6014                                 })*
6015                                 assert!(htlc_sig_iter.next().is_none());
6016                         } }
6017                 }
6018
6019                 // simple commitment tx with no HTLCs
6020                 chan.value_to_self_msat = 7000000000;
6021
6022                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
6023                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
6024                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6025
6026                 chan.pending_inbound_htlcs.push({
6027                         let mut out = InboundHTLCOutput{
6028                                 htlc_id: 0,
6029                                 amount_msat: 1000000,
6030                                 cltv_expiry: 500,
6031                                 payment_hash: PaymentHash([0; 32]),
6032                                 state: InboundHTLCState::Committed,
6033                         };
6034                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
6035                         out
6036                 });
6037                 chan.pending_inbound_htlcs.push({
6038                         let mut out = InboundHTLCOutput{
6039                                 htlc_id: 1,
6040                                 amount_msat: 2000000,
6041                                 cltv_expiry: 501,
6042                                 payment_hash: PaymentHash([0; 32]),
6043                                 state: InboundHTLCState::Committed,
6044                         };
6045                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6046                         out
6047                 });
6048                 chan.pending_outbound_htlcs.push({
6049                         let mut out = OutboundHTLCOutput{
6050                                 htlc_id: 2,
6051                                 amount_msat: 2000000,
6052                                 cltv_expiry: 502,
6053                                 payment_hash: PaymentHash([0; 32]),
6054                                 state: OutboundHTLCState::Committed,
6055                                 source: HTLCSource::dummy(),
6056                         };
6057                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
6058                         out
6059                 });
6060                 chan.pending_outbound_htlcs.push({
6061                         let mut out = OutboundHTLCOutput{
6062                                 htlc_id: 3,
6063                                 amount_msat: 3000000,
6064                                 cltv_expiry: 503,
6065                                 payment_hash: PaymentHash([0; 32]),
6066                                 state: OutboundHTLCState::Committed,
6067                                 source: HTLCSource::dummy(),
6068                         };
6069                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
6070                         out
6071                 });
6072                 chan.pending_inbound_htlcs.push({
6073                         let mut out = InboundHTLCOutput{
6074                                 htlc_id: 4,
6075                                 amount_msat: 4000000,
6076                                 cltv_expiry: 504,
6077                                 payment_hash: PaymentHash([0; 32]),
6078                                 state: InboundHTLCState::Committed,
6079                         };
6080                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
6081                         out
6082                 });
6083
6084                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
6085                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6086                 chan.feerate_per_kw = 0;
6087
6088                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
6089                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
6090                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6091
6092                                   { 0,
6093                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
6094                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
6095                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6096
6097                                   { 1,
6098                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
6099                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
6100                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6101
6102                                   { 2,
6103                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
6104                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
6105                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6106
6107                                   { 3,
6108                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
6109                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
6110                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6111
6112                                   { 4,
6113                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
6114                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
6115                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6116                 } );
6117
6118                 // commitment tx with seven outputs untrimmed (maximum feerate)
6119                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6120                 chan.feerate_per_kw = 647;
6121
6122                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
6123                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
6124                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6125
6126                                   { 0,
6127                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
6128                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
6129                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6130
6131                                   { 1,
6132                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
6133                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
6134                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6135
6136                                   { 2,
6137                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
6138                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
6139                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6140
6141                                   { 3,
6142                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
6143                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
6144                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6145
6146                                   { 4,
6147                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
6148                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
6149                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6150                 } );
6151
6152                 // commitment tx with six outputs untrimmed (minimum feerate)
6153                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6154                 chan.feerate_per_kw = 648;
6155
6156                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
6157                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
6158                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6159
6160                                   { 0,
6161                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
6162                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
6163                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6164
6165                                   { 1,
6166                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
6167                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
6168                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6169
6170                                   { 2,
6171                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
6172                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
6173                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6174
6175                                   { 3,
6176                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
6177                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
6178                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6179                 } );
6180
6181                 // commitment tx with six outputs untrimmed (maximum feerate)
6182                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6183                 chan.feerate_per_kw = 2069;
6184
6185                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
6186                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
6187                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6188
6189                                   { 0,
6190                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
6191                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
6192                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6193
6194                                   { 1,
6195                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
6196                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
6197                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6198
6199                                   { 2,
6200                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
6201                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
6202                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6203
6204                                   { 3,
6205                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
6206                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
6207                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6208                 } );
6209
6210                 // commitment tx with five outputs untrimmed (minimum feerate)
6211                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6212                 chan.feerate_per_kw = 2070;
6213
6214                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
6215                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
6216                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6217
6218                                   { 0,
6219                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
6220                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
6221                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6222
6223                                   { 1,
6224                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
6225                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
6226                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6227
6228                                   { 2,
6229                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
6230                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
6231                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6232                 } );
6233
6234                 // commitment tx with five outputs untrimmed (maximum feerate)
6235                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6236                 chan.feerate_per_kw = 2194;
6237
6238                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
6239                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
6240                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6241
6242                                   { 0,
6243                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
6244                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
6245                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6246
6247                                   { 1,
6248                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
6249                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
6250                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6251
6252                                   { 2,
6253                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
6254                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
6255                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6256                 } );
6257
6258                 // commitment tx with four outputs untrimmed (minimum feerate)
6259                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6260                 chan.feerate_per_kw = 2195;
6261
6262                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
6263                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
6264                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6265
6266                                   { 0,
6267                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
6268                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
6269                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6270
6271                                   { 1,
6272                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
6273                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
6274                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6275                 } );
6276
6277                 // commitment tx with four outputs untrimmed (maximum feerate)
6278                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6279                 chan.feerate_per_kw = 3702;
6280
6281                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
6282                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
6283                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6284
6285                                   { 0,
6286                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
6287                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
6288                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6289
6290                                   { 1,
6291                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
6292                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
6293                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6294                 } );
6295
6296                 // commitment tx with three outputs untrimmed (minimum feerate)
6297                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6298                 chan.feerate_per_kw = 3703;
6299
6300                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
6301                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
6302                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6303
6304                                   { 0,
6305                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
6306                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
6307                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6308                 } );
6309
6310                 // commitment tx with three outputs untrimmed (maximum feerate)
6311                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6312                 chan.feerate_per_kw = 4914;
6313
6314                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
6315                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
6316                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6317
6318                                   { 0,
6319                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
6320                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
6321                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6322                 } );
6323
6324                 // commitment tx with two outputs untrimmed (minimum feerate)
6325                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6326                 chan.feerate_per_kw = 4915;
6327
6328                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
6329                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
6330                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6331
6332                 // commitment tx with two outputs untrimmed (maximum feerate)
6333                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6334                 chan.feerate_per_kw = 9651180;
6335
6336                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
6337                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
6338                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6339
6340                 // commitment tx with one output untrimmed (minimum feerate)
6341                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6342                 chan.feerate_per_kw = 9651181;
6343
6344                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6345                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6346                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6347
6348                 // commitment tx with fee greater than funder amount
6349                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6350                 chan.feerate_per_kw = 9651936;
6351
6352                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6353                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6354                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6355
6356                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
6357                 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
6358                 chan.feerate_per_kw = 253;
6359                 chan.pending_inbound_htlcs.clear();
6360                 chan.pending_inbound_htlcs.push({
6361                         let mut out = InboundHTLCOutput{
6362                                 htlc_id: 1,
6363                                 amount_msat: 2000000,
6364                                 cltv_expiry: 501,
6365                                 payment_hash: PaymentHash([0; 32]),
6366                                 state: InboundHTLCState::Committed,
6367                         };
6368                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6369                         out
6370                 });
6371                 chan.pending_outbound_htlcs.clear();
6372                 chan.pending_outbound_htlcs.push({
6373                         let mut out = OutboundHTLCOutput{
6374                                 htlc_id: 6,
6375                                 amount_msat: 5000000,
6376                                 cltv_expiry: 506,
6377                                 payment_hash: PaymentHash([0; 32]),
6378                                 state: OutboundHTLCState::Committed,
6379                                 source: HTLCSource::dummy(),
6380                         };
6381                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6382                         out
6383                 });
6384                 chan.pending_outbound_htlcs.push({
6385                         let mut out = OutboundHTLCOutput{
6386                                 htlc_id: 5,
6387                                 amount_msat: 5000000,
6388                                 cltv_expiry: 505,
6389                                 payment_hash: PaymentHash([0; 32]),
6390                                 state: OutboundHTLCState::Committed,
6391                                 source: HTLCSource::dummy(),
6392                         };
6393                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6394                         out
6395                 });
6396
6397                 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6398                                  "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6399                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6400
6401                                   { 0,
6402                                   "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6403                                   "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6404                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6405                                   { 1,
6406                                   "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6407                                   "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6408                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6409                                   { 2,
6410                                   "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6411                                   "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6412                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6413                 } );
6414         }
6415
6416         #[test]
6417         fn test_per_commitment_secret_gen() {
6418                 // Test vectors from BOLT 3 Appendix D:
6419
6420                 let mut seed = [0; 32];
6421                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6422                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6423                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6424
6425                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6426                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6427                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6428
6429                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6430                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6431
6432                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6433                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6434
6435                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6436                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6437                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6438         }
6439
6440         #[test]
6441         fn test_key_derivation() {
6442                 // Test vectors from BOLT 3 Appendix E:
6443                 let secp_ctx = Secp256k1::new();
6444
6445                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6446                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6447
6448                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6449                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6450
6451                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6452                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6453
6454                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6455                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6456
6457                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6458                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6459
6460                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6461                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6462
6463                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6464                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
6465         }
6466 }