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