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