515e10264fac63070d0588d9b0a3c57471d27eeb
[rust-lightning] / lightning / src / ln / channel.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{Transaction, EcdsaSighashType};
12 use bitcoin::util::sighash;
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::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,ecdsa::Signature};
23 use bitcoin::secp256k1;
24
25 use crate::ln::{PaymentPreimage, PaymentHash};
26 use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
27 use crate::ln::msgs;
28 use crate::ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use crate::ln::script::{self, ShutdownScript};
30 use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use crate::ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, htlc_success_tx_weight, htlc_timeout_tx_weight, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
32 use crate::ln::chan_utils;
33 use crate::ln::onion_utils::HTLCFailReason;
34 use crate::chain::BestBlock;
35 use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator};
36 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
37 use crate::chain::transaction::{OutPoint, TransactionData};
38 use crate::chain::keysinterface::{WriteableEcdsaChannelSigner, EntropySource, ChannelSigner, SignerProvider, NodeSigner, Recipient};
39 use crate::routing::gossip::NodeId;
40 use crate::util::events::ClosureReason;
41 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
42 use crate::util::logger::Logger;
43 use crate::util::errors::APIError;
44 use crate::util::config::{UserConfig, ChannelConfig, LegacyChannelConfig, ChannelHandshakeConfig, ChannelHandshakeLimits};
45 use crate::util::scid_utils::scid_from_parts;
46
47 use crate::io;
48 use crate::prelude::*;
49 use core::{cmp,mem,fmt};
50 use core::ops::Deref;
51 #[cfg(any(test, fuzzing, debug_assertions))]
52 use crate::sync::Mutex;
53 use bitcoin::hashes::hex::ToHex;
54
55 #[cfg(test)]
56 pub struct ChannelValueStat {
57         pub value_to_self_msat: u64,
58         pub channel_value_msat: u64,
59         pub channel_reserve_msat: u64,
60         pub pending_outbound_htlcs_amount_msat: u64,
61         pub pending_inbound_htlcs_amount_msat: u64,
62         pub holding_cell_outbound_amount_msat: u64,
63         pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
64         pub counterparty_dust_limit_msat: u64,
65 }
66
67 pub struct AvailableBalances {
68         /// The amount that would go to us if we close the channel, ignoring any on-chain fees.
69         pub balance_msat: u64,
70         /// Total amount available for our counterparty to send to us.
71         pub inbound_capacity_msat: u64,
72         /// Total amount available for us to send to our counterparty.
73         pub outbound_capacity_msat: u64,
74         /// The maximum value we can assign to the next outbound HTLC
75         pub next_outbound_htlc_limit_msat: u64,
76 }
77
78 #[derive(Debug, Clone, Copy, PartialEq)]
79 enum FeeUpdateState {
80         // Inbound states mirroring InboundHTLCState
81         RemoteAnnounced,
82         AwaitingRemoteRevokeToAnnounce,
83         // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
84         // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
85         // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
86         // the fee update anywhere, we can simply consider the fee update `Committed` immediately
87         // instead of setting it to AwaitingAnnouncedRemoteRevoke.
88
89         // Outbound state can only be `LocalAnnounced` or `Committed`
90         Outbound,
91 }
92
93 enum InboundHTLCRemovalReason {
94         FailRelay(msgs::OnionErrorPacket),
95         FailMalformed(([u8; 32], u16)),
96         Fulfill(PaymentPreimage),
97 }
98
99 enum InboundHTLCState {
100         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
101         /// update_add_htlc message for this HTLC.
102         RemoteAnnounced(PendingHTLCStatus),
103         /// Included in a received commitment_signed message (implying we've
104         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
105         /// state (see the example below). We have not yet included this HTLC in a
106         /// commitment_signed message because we are waiting on the remote's
107         /// aforementioned state revocation. One reason this missing remote RAA
108         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
109         /// is because every time we create a new "state", i.e. every time we sign a
110         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
111         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
112         /// sent provided the per_commitment_point for our current commitment tx.
113         /// The other reason we should not send a commitment_signed without their RAA
114         /// is because their RAA serves to ACK our previous commitment_signed.
115         ///
116         /// Here's an example of how an HTLC could come to be in this state:
117         /// remote --> update_add_htlc(prev_htlc)   --> local
118         /// remote --> commitment_signed(prev_htlc) --> local
119         /// remote <-- revoke_and_ack               <-- local
120         /// remote <-- commitment_signed(prev_htlc) <-- local
121         /// [note that here, the remote does not respond with a RAA]
122         /// remote --> update_add_htlc(this_htlc)   --> local
123         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
124         /// Now `this_htlc` will be assigned this state. It's unable to be officially
125         /// accepted, i.e. included in a commitment_signed, because we're missing the
126         /// RAA that provides our next per_commitment_point. The per_commitment_point
127         /// is used to derive commitment keys, which are used to construct the
128         /// signatures in a commitment_signed message.
129         /// Implies AwaitingRemoteRevoke.
130         ///
131         /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
132         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
133         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
134         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
135         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
136         /// channel (before it can then get forwarded and/or removed).
137         /// Implies AwaitingRemoteRevoke.
138         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
139         Committed,
140         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
141         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
142         /// we'll drop it.
143         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
144         /// commitment transaction without it as otherwise we'll have to force-close the channel to
145         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
146         /// anyway). That said, ChannelMonitor does this for us (see
147         /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
148         /// our own local state before then, once we're sure that the next commitment_signed and
149         /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
150         LocalRemoved(InboundHTLCRemovalReason),
151 }
152
153 struct InboundHTLCOutput {
154         htlc_id: u64,
155         amount_msat: u64,
156         cltv_expiry: u32,
157         payment_hash: PaymentHash,
158         state: InboundHTLCState,
159 }
160
161 enum OutboundHTLCState {
162         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
163         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
164         /// we will promote to Committed (note that they may not accept it until the next time we
165         /// revoke, but we don't really care about that:
166         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
167         ///    money back (though we won't), and,
168         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
169         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
170         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
171         ///    we'll never get out of sync).
172         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
173         /// OutboundHTLCOutput's size just for a temporary bit
174         LocalAnnounced(Box<msgs::OnionPacket>),
175         Committed,
176         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
177         /// the change (though they'll need to revoke before we fail the payment).
178         RemoteRemoved(OutboundHTLCOutcome),
179         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
180         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
181         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
182         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
183         /// remote revoke_and_ack on a previous state before we can do so.
184         AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome),
185         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
186         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
187         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
188         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
189         /// revoke_and_ack to drop completely.
190         AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome),
191 }
192
193 #[derive(Clone)]
194 enum OutboundHTLCOutcome {
195         Success(Option<PaymentPreimage>),
196         Failure(HTLCFailReason),
197 }
198
199 impl From<Option<HTLCFailReason>> for OutboundHTLCOutcome {
200         fn from(o: Option<HTLCFailReason>) -> Self {
201                 match o {
202                         None => OutboundHTLCOutcome::Success(None),
203                         Some(r) => OutboundHTLCOutcome::Failure(r)
204                 }
205         }
206 }
207
208 impl<'a> Into<Option<&'a HTLCFailReason>> for &'a OutboundHTLCOutcome {
209         fn into(self) -> Option<&'a HTLCFailReason> {
210                 match self {
211                         OutboundHTLCOutcome::Success(_) => None,
212                         OutboundHTLCOutcome::Failure(ref r) => Some(r)
213                 }
214         }
215 }
216
217 struct OutboundHTLCOutput {
218         htlc_id: u64,
219         amount_msat: u64,
220         cltv_expiry: u32,
221         payment_hash: PaymentHash,
222         state: OutboundHTLCState,
223         source: HTLCSource,
224 }
225
226 /// See AwaitingRemoteRevoke ChannelState for more info
227 enum HTLCUpdateAwaitingACK {
228         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
229                 // always outbound
230                 amount_msat: u64,
231                 cltv_expiry: u32,
232                 payment_hash: PaymentHash,
233                 source: HTLCSource,
234                 onion_routing_packet: msgs::OnionPacket,
235         },
236         ClaimHTLC {
237                 payment_preimage: PaymentPreimage,
238                 htlc_id: u64,
239         },
240         FailHTLC {
241                 htlc_id: u64,
242                 err_packet: msgs::OnionErrorPacket,
243         },
244 }
245
246 /// There are a few "states" and then a number of flags which can be applied:
247 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
248 /// TheirChannelReady and OurChannelReady then get set on FundingSent, and when both are set we
249 /// move on to ChannelReady.
250 /// Note that PeerDisconnected can be set on both ChannelReady and FundingSent.
251 /// ChannelReady can then get all remaining flags set on it, until we finish shutdown, then we
252 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
253 enum ChannelState {
254         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
255         OurInitSent = 1 << 0,
256         /// Implies we have received their open_channel/accept_channel message
257         TheirInitSent = 1 << 1,
258         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
259         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
260         /// upon receipt of funding_created, so simply skip this state.
261         FundingCreated = 4,
262         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
263         /// on the funding transaction to confirm. The ChannelReady flags are set to indicate when we
264         /// and our counterparty consider the funding transaction confirmed.
265         FundingSent = 8,
266         /// Flag which can be set on FundingSent to indicate they sent us a channel_ready message.
267         /// Once both TheirChannelReady and OurChannelReady are set, state moves on to ChannelReady.
268         TheirChannelReady = 1 << 4,
269         /// Flag which can be set on FundingSent to indicate we sent them a channel_ready message.
270         /// Once both TheirChannelReady and OurChannelReady are set, state moves on to ChannelReady.
271         OurChannelReady = 1 << 5,
272         ChannelReady = 64,
273         /// Flag which is set on ChannelReady and FundingSent indicating remote side is considered
274         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
275         /// dance.
276         PeerDisconnected = 1 << 7,
277         /// Flag which is set on ChannelReady, FundingCreated, and FundingSent indicating the user has
278         /// told us a ChannelMonitor update is pending async persistence somewhere and we should pause
279         /// sending any outbound messages until they've managed to finish.
280         MonitorUpdateInProgress = 1 << 8,
281         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
282         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
283         /// messages as then we will be unable to determine which HTLCs they included in their
284         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
285         /// later.
286         /// Flag is set on ChannelReady.
287         AwaitingRemoteRevoke = 1 << 9,
288         /// Flag which is set on ChannelReady or FundingSent after receiving a shutdown message from
289         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
290         /// to respond with our own shutdown message when possible.
291         RemoteShutdownSent = 1 << 10,
292         /// Flag which is set on ChannelReady or FundingSent after sending a shutdown message. At this
293         /// point, we may not add any new HTLCs to the channel.
294         LocalShutdownSent = 1 << 11,
295         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
296         /// to drop us, but we store this anyway.
297         ShutdownComplete = 4096,
298 }
299 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
300 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32;
301
302 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
303
304 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
305 /// our counterparty or not. However, we don't want to announce updates right away to avoid
306 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
307 /// our channel_update message and track the current state here.
308 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
309 #[derive(Clone, Copy, PartialEq)]
310 pub(super) enum ChannelUpdateStatus {
311         /// We've announced the channel as enabled and are connected to our peer.
312         Enabled,
313         /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
314         DisabledStaged,
315         /// Our channel is live again, but we haven't announced the channel as enabled yet.
316         EnabledStaged,
317         /// We've announced the channel as disabled.
318         Disabled,
319 }
320
321 /// We track when we sent an `AnnouncementSignatures` to our peer in a few states, described here.
322 #[derive(PartialEq)]
323 pub enum AnnouncementSigsState {
324         /// We have not sent our peer an `AnnouncementSignatures` yet, or our peer disconnected since
325         /// we sent the last `AnnouncementSignatures`.
326         NotSent,
327         /// We sent an `AnnouncementSignatures` to our peer since the last time our peer disconnected.
328         /// This state never appears on disk - instead we write `NotSent`.
329         MessageSent,
330         /// We sent a `CommitmentSigned` after the last `AnnouncementSignatures` we sent. Because we
331         /// only ever have a single `CommitmentSigned` pending at once, if we sent one after sending
332         /// `AnnouncementSignatures` then we know the peer received our `AnnouncementSignatures` if
333         /// they send back a `RevokeAndACK`.
334         /// This state never appears on disk - instead we write `NotSent`.
335         Committed,
336         /// We received a `RevokeAndACK`, effectively ack-ing our `AnnouncementSignatures`, at this
337         /// point we no longer need to re-send our `AnnouncementSignatures` again on reconnect.
338         PeerReceived,
339 }
340
341 /// An enum indicating whether the local or remote side offered a given HTLC.
342 enum HTLCInitiator {
343         LocalOffered,
344         RemoteOffered,
345 }
346
347 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
348 struct HTLCStats {
349         pending_htlcs: u32,
350         pending_htlcs_value_msat: u64,
351         on_counterparty_tx_dust_exposure_msat: u64,
352         on_holder_tx_dust_exposure_msat: u64,
353         holding_cell_msat: u64,
354         on_holder_tx_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
355 }
356
357 /// An enum gathering stats on commitment transaction, either local or remote.
358 struct CommitmentStats<'a> {
359         tx: CommitmentTransaction, // the transaction info
360         feerate_per_kw: u32, // the feerate included to build the transaction
361         total_fee_sat: u64, // the total fee included in the transaction
362         num_nondust_htlcs: usize,  // the number of HTLC outputs (dust HTLCs *non*-included)
363         htlcs_included: Vec<(HTLCOutputInCommitment, Option<&'a HTLCSource>)>, // the list of HTLCs (dust HTLCs *included*) which were not ignored when building the transaction
364         local_balance_msat: u64, // local balance before fees but considering dust limits
365         remote_balance_msat: u64, // remote balance before fees but considering dust limits
366         preimages: Vec<PaymentPreimage>, // preimages for successful offered HTLCs since last commitment
367 }
368
369 /// Used when calculating whether we or the remote can afford an additional HTLC.
370 struct HTLCCandidate {
371         amount_msat: u64,
372         origin: HTLCInitiator,
373 }
374
375 impl HTLCCandidate {
376         fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
377                 Self {
378                         amount_msat,
379                         origin,
380                 }
381         }
382 }
383
384 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
385 /// description
386 enum UpdateFulfillFetch {
387         NewClaim {
388                 monitor_update: ChannelMonitorUpdate,
389                 htlc_value_msat: u64,
390                 msg: Option<msgs::UpdateFulfillHTLC>,
391         },
392         DuplicateClaim {},
393 }
394
395 /// The return type of get_update_fulfill_htlc_and_commit.
396 pub enum UpdateFulfillCommitFetch<'a> {
397         /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
398         /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
399         /// previously placed in the holding cell (and has since been removed).
400         NewClaim {
401                 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
402                 monitor_update: &'a ChannelMonitorUpdate,
403                 /// The value of the HTLC which was claimed, in msat.
404                 htlc_value_msat: u64,
405         },
406         /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
407         /// or has been forgotten (presumably previously claimed).
408         DuplicateClaim {},
409 }
410
411 /// The return value of `monitor_updating_restored`
412 pub(super) struct MonitorRestoreUpdates {
413         pub raa: Option<msgs::RevokeAndACK>,
414         pub commitment_update: Option<msgs::CommitmentUpdate>,
415         pub order: RAACommitmentOrder,
416         pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
417         pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
418         pub finalized_claimed_htlcs: Vec<HTLCSource>,
419         pub funding_broadcastable: Option<Transaction>,
420         pub channel_ready: Option<msgs::ChannelReady>,
421         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
422 }
423
424 /// The return value of `channel_reestablish`
425 pub(super) struct ReestablishResponses {
426         pub channel_ready: Option<msgs::ChannelReady>,
427         pub raa: Option<msgs::RevokeAndACK>,
428         pub commitment_update: Option<msgs::CommitmentUpdate>,
429         pub order: RAACommitmentOrder,
430         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
431         pub shutdown_msg: Option<msgs::Shutdown>,
432 }
433
434 /// If the majority of the channels funds are to the fundee and the initiator holds only just
435 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
436 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
437 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
438 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
439 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
440 /// by this multiple without hitting this case, before sending.
441 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
442 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
443 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
444 /// leave the channel less usable as we hold a bigger reserve.
445 #[cfg(any(fuzzing, test))]
446 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
447 #[cfg(not(any(fuzzing, test)))]
448 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
449
450 /// If we fail to see a funding transaction confirmed on-chain within this many blocks after the
451 /// channel creation on an inbound channel, we simply force-close and move on.
452 /// This constant is the one suggested in BOLT 2.
453 pub(crate) const FUNDING_CONF_DEADLINE_BLOCKS: u32 = 2016;
454
455 /// In case of a concurrent update_add_htlc proposed by our counterparty, we might
456 /// not have enough balance value remaining to cover the onchain cost of this new
457 /// HTLC weight. If this happens, our counterparty fails the reception of our
458 /// commitment_signed including this new HTLC due to infringement on the channel
459 /// reserve.
460 /// To prevent this case, we compute our outbound update_fee with an HTLC buffer of
461 /// size 2. However, if the number of concurrent update_add_htlc is higher, this still
462 /// leads to a channel force-close. Ultimately, this is an issue coming from the
463 /// design of LN state machines, allowing asynchronous updates.
464 pub(crate) const CONCURRENT_INBOUND_HTLC_FEE_BUFFER: u32 = 2;
465
466 /// When a channel is opened, we check that the funding amount is enough to pay for relevant
467 /// commitment transaction fees, with at least this many HTLCs present on the commitment
468 /// transaction (not counting the value of the HTLCs themselves).
469 pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
470
471 /// When a [`Channel`] has its [`ChannelConfig`] updated, its existing one is stashed for up to this
472 /// number of ticks to allow forwarding HTLCs by nodes that have yet to receive the new
473 /// ChannelUpdate prompted by the config update. This value was determined as follows:
474 ///
475 ///   * The expected interval between ticks (1 minute).
476 ///   * The average convergence delay of updates across the network, i.e., ~300 seconds on average
477 ///      for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
478 ///   * `EXPIRE_PREV_CONFIG_TICKS` = convergence_delay / tick_interval
479 pub(crate) const EXPIRE_PREV_CONFIG_TICKS: usize = 5;
480
481 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
482 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
483 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
484 // inbound channel.
485 //
486 // Holder designates channel data owned for the benefice of the user client.
487 // Counterparty designates channel data owned by the another channel participant entity.
488 pub(super) struct Channel<Signer: ChannelSigner> {
489         config: LegacyChannelConfig,
490
491         // Track the previous `ChannelConfig` so that we can continue forwarding HTLCs that were
492         // constructed using it. The second element in the tuple corresponds to the number of ticks that
493         // have elapsed since the update occurred.
494         prev_config: Option<(ChannelConfig, usize)>,
495
496         inbound_handshake_limits_override: Option<ChannelHandshakeLimits>,
497
498         user_id: u128,
499
500         channel_id: [u8; 32],
501         channel_state: u32,
502
503         // When we reach max(6 blocks, minimum_depth), we need to send an AnnouncementSigs message to
504         // our peer. However, we want to make sure they received it, or else rebroadcast it when we
505         // next connect.
506         // We do so here, see `AnnouncementSigsSent` for more details on the state(s).
507         // Note that a number of our tests were written prior to the behavior here which retransmits
508         // AnnouncementSignatures until after an RAA completes, so the behavior is short-circuited in
509         // many tests.
510         #[cfg(any(test, feature = "_test_utils"))]
511         pub(crate) announcement_sigs_state: AnnouncementSigsState,
512         #[cfg(not(any(test, feature = "_test_utils")))]
513         announcement_sigs_state: AnnouncementSigsState,
514
515         secp_ctx: Secp256k1<secp256k1::All>,
516         channel_value_satoshis: u64,
517
518         latest_monitor_update_id: u64,
519
520         holder_signer: Signer,
521         shutdown_scriptpubkey: Option<ShutdownScript>,
522         destination_script: Script,
523
524         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
525         // generation start at 0 and count up...this simplifies some parts of implementation at the
526         // cost of others, but should really just be changed.
527
528         cur_holder_commitment_transaction_number: u64,
529         cur_counterparty_commitment_transaction_number: u64,
530         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
531         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
532         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
533         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
534
535         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
536         /// need to ensure we resend them in the order we originally generated them. Note that because
537         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
538         /// sufficient to simply set this to the opposite of any message we are generating as we
539         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
540         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
541         /// send it first.
542         resend_order: RAACommitmentOrder,
543
544         monitor_pending_channel_ready: bool,
545         monitor_pending_revoke_and_ack: bool,
546         monitor_pending_commitment_signed: bool,
547
548         // TODO: If a channel is drop'd, we don't know whether the `ChannelMonitor` is ultimately
549         // responsible for some of the HTLCs here or not - we don't know whether the update in question
550         // completed or not. We currently ignore these fields entirely when force-closing a channel,
551         // but need to handle this somehow or we run the risk of losing HTLCs!
552         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
553         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
554         monitor_pending_finalized_fulfills: Vec<HTLCSource>,
555
556         // pending_update_fee is filled when sending and receiving update_fee.
557         //
558         // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
559         // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
560         // generating new commitment transactions with exactly the same criteria as inbound/outbound
561         // HTLCs with similar state.
562         pending_update_fee: Option<(u32, FeeUpdateState)>,
563         // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
564         // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
565         // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
566         // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
567         // further `send_update_fee` calls, dropping the previous holding cell update entirely.
568         holding_cell_update_fee: Option<u32>,
569         next_holder_htlc_id: u64,
570         next_counterparty_htlc_id: u64,
571         feerate_per_kw: u32,
572
573         /// The timestamp set on our latest `channel_update` message for this channel. It is updated
574         /// when the channel is updated in ways which may impact the `channel_update` message or when a
575         /// new block is received, ensuring it's always at least moderately close to the current real
576         /// time.
577         update_time_counter: u32,
578
579         #[cfg(debug_assertions)]
580         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
581         holder_max_commitment_tx_output: Mutex<(u64, u64)>,
582         #[cfg(debug_assertions)]
583         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
584         counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
585
586         last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
587         target_closing_feerate_sats_per_kw: Option<u32>,
588
589         /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
590         /// update, we need to delay processing it until later. We do that here by simply storing the
591         /// closing_signed message and handling it in `maybe_propose_closing_signed`.
592         pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
593
594         /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
595         /// transaction. These are set once we reach `closing_negotiation_ready`.
596         #[cfg(test)]
597         pub(crate) closing_fee_limits: Option<(u64, u64)>,
598         #[cfg(not(test))]
599         closing_fee_limits: Option<(u64, u64)>,
600
601         /// Flag that ensures that `accept_inbound_channel` must be called before `funding_created`
602         /// is executed successfully. The reason for this flag is that when the
603         /// `UserConfig::manually_accept_inbound_channels` config flag is set to true, inbound channels
604         /// are required to be manually accepted by the node operator before the `msgs::AcceptChannel`
605         /// message is created and sent out. During the manual accept process, `accept_inbound_channel`
606         /// is called by `ChannelManager::accept_inbound_channel`.
607         ///
608         /// The flag counteracts that a counterparty node could theoretically send a
609         /// `msgs::FundingCreated` message before the node operator has manually accepted an inbound
610         /// channel request made by the counterparty node. That would execute `funding_created` before
611         /// `accept_inbound_channel`, and `funding_created` should therefore not execute successfully.
612         inbound_awaiting_accept: bool,
613
614         /// The hash of the block in which the funding transaction was included.
615         funding_tx_confirmed_in: Option<BlockHash>,
616         funding_tx_confirmation_height: u32,
617         short_channel_id: Option<u64>,
618         /// Either the height at which this channel was created or the height at which it was last
619         /// serialized if it was serialized by versions prior to 0.0.103.
620         /// We use this to close if funding is never broadcasted.
621         channel_creation_height: u32,
622
623         counterparty_dust_limit_satoshis: u64,
624
625         #[cfg(test)]
626         pub(super) holder_dust_limit_satoshis: u64,
627         #[cfg(not(test))]
628         holder_dust_limit_satoshis: u64,
629
630         #[cfg(test)]
631         pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
632         #[cfg(not(test))]
633         counterparty_max_htlc_value_in_flight_msat: u64,
634
635         #[cfg(test)]
636         pub(super) holder_max_htlc_value_in_flight_msat: u64,
637         #[cfg(not(test))]
638         holder_max_htlc_value_in_flight_msat: u64,
639
640         /// minimum channel reserve for self to maintain - set by them.
641         counterparty_selected_channel_reserve_satoshis: Option<u64>,
642
643         #[cfg(test)]
644         pub(super) holder_selected_channel_reserve_satoshis: u64,
645         #[cfg(not(test))]
646         holder_selected_channel_reserve_satoshis: u64,
647
648         counterparty_htlc_minimum_msat: u64,
649         holder_htlc_minimum_msat: u64,
650         #[cfg(test)]
651         pub counterparty_max_accepted_htlcs: u16,
652         #[cfg(not(test))]
653         counterparty_max_accepted_htlcs: u16,
654         //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
655         minimum_depth: Option<u32>,
656
657         counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
658
659         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
660         funding_transaction: Option<Transaction>,
661
662         counterparty_cur_commitment_point: Option<PublicKey>,
663         counterparty_prev_commitment_point: Option<PublicKey>,
664         counterparty_node_id: PublicKey,
665
666         counterparty_shutdown_scriptpubkey: Option<Script>,
667
668         commitment_secrets: CounterpartyCommitmentSecrets,
669
670         channel_update_status: ChannelUpdateStatus,
671         /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
672         /// not complete within a single timer tick (one minute), we should force-close the channel.
673         /// This prevents us from keeping unusable channels around forever if our counterparty wishes
674         /// to DoS us.
675         /// Note that this field is reset to false on deserialization to give us a chance to connect to
676         /// our peer and start the closing_signed negotiation fresh.
677         closing_signed_in_flight: bool,
678
679         /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
680         /// This can be used to rebroadcast the channel_announcement message later.
681         announcement_sigs: Option<(Signature, Signature)>,
682
683         // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
684         // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
685         // be, by comparing the cached values to the fee of the tranaction generated by
686         // `build_commitment_transaction`.
687         #[cfg(any(test, fuzzing))]
688         next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
689         #[cfg(any(test, fuzzing))]
690         next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
691
692         /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
693         /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
694         /// channel_ready *before* sending the channel_reestablish (which is clearly a violation of
695         /// the BOLT specs). We copy c-lightning's workaround here and simply store the channel_ready
696         /// message until we receive a channel_reestablish.
697         ///
698         /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
699         pub workaround_lnd_bug_4006: Option<msgs::ChannelReady>,
700
701         #[cfg(any(test, fuzzing))]
702         // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
703         // corresponding HTLC on the inbound path. If, then, the outbound path channel is
704         // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
705         // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
706         // is fine, but as a sanity check in our failure to generate the second claim, we check here
707         // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
708         historical_inbound_htlc_fulfills: HashSet<u64>,
709
710         /// This channel's type, as negotiated during channel open
711         channel_type: ChannelTypeFeatures,
712
713         // Our counterparty can offer us SCID aliases which they will map to this channel when routing
714         // outbound payments. These can be used in invoice route hints to avoid explicitly revealing
715         // the channel's funding UTXO.
716         //
717         // We also use this when sending our peer a channel_update that isn't to be broadcasted
718         // publicly - allowing them to re-use their map of SCID -> channel for channel_update ->
719         // associated channel mapping.
720         //
721         // We only bother storing the most recent SCID alias at any time, though our counterparty has
722         // to store all of them.
723         latest_inbound_scid_alias: Option<u64>,
724
725         // We always offer our counterparty a static SCID alias, which we recognize as for this channel
726         // if we see it in HTLC forwarding instructions. We don't bother rotating the alias given we
727         // don't currently support node id aliases and eventually privacy should be provided with
728         // blinded paths instead of simple scid+node_id aliases.
729         outbound_scid_alias: u64,
730
731         // We track whether we already emitted a `ChannelReady` event.
732         channel_ready_event_emitted: bool,
733
734         /// The unique identifier used to re-derive the private key material for the channel through
735         /// [`SignerProvider::derive_channel_signer`].
736         channel_keys_id: [u8; 32],
737
738         /// When we generate [`ChannelMonitorUpdate`]s to persist, they may not be persisted immediately.
739         /// If we then persist the [`channelmanager::ChannelManager`] and crash before the persistence
740         /// completes we still need to be able to complete the persistence. Thus, we have to keep a
741         /// copy of the [`ChannelMonitorUpdate`] here until it is complete.
742         pending_monitor_updates: Vec<ChannelMonitorUpdate>,
743 }
744
745 #[cfg(any(test, fuzzing))]
746 struct CommitmentTxInfoCached {
747         fee: u64,
748         total_pending_htlcs: usize,
749         next_holder_htlc_id: u64,
750         next_counterparty_htlc_id: u64,
751         feerate: u32,
752 }
753
754 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
755
756 pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
757         const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
758         const COMMITMENT_TX_BASE_ANCHOR_WEIGHT: u64 = 1124;
759         if opt_anchors { COMMITMENT_TX_BASE_ANCHOR_WEIGHT } else { COMMITMENT_TX_BASE_WEIGHT }
760 }
761
762 #[cfg(not(test))]
763 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
764 #[cfg(test)]
765 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
766
767 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
768
769 /// The percentage of the channel value `holder_max_htlc_value_in_flight_msat` used to be set to,
770 /// before this was made configurable. The percentage was made configurable in LDK 0.0.107,
771 /// although LDK 0.0.104+ enabled serialization of channels with a different value set for
772 /// `holder_max_htlc_value_in_flight_msat`.
773 pub const MAX_IN_FLIGHT_PERCENT_LEGACY: u8 = 10;
774
775 /// Maximum `funding_satoshis` value according to the BOLT #2 specification, if
776 /// `option_support_large_channel` (aka wumbo channels) is not supported.
777 /// It's 2^24 - 1.
778 pub const MAX_FUNDING_SATOSHIS_NO_WUMBO: u64 = (1 << 24) - 1;
779
780 /// Total bitcoin supply in satoshis.
781 pub const TOTAL_BITCOIN_SUPPLY_SATOSHIS: u64 = 21_000_000 * 1_0000_0000;
782
783 /// The maximum network dust limit for standard script formats. This currently represents the
784 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
785 /// transaction non-standard and thus refuses to relay it.
786 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
787 /// implementations use this value for their dust limit today.
788 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
789
790 /// The maximum channel dust limit we will accept from our counterparty.
791 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
792
793 /// The dust limit is used for both the commitment transaction outputs as well as the closing
794 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
795 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
796 /// In order to avoid having to concern ourselves with standardness during the closing process, we
797 /// simply require our counterparty to use a dust limit which will leave any segwit output
798 /// standard.
799 /// See <https://github.com/lightning/bolts/issues/905> for more details.
800 pub const MIN_CHAN_DUST_LIMIT_SATOSHIS: u64 = 354;
801
802 // Just a reasonable implementation-specific safe lower bound, higher than the dust limit.
803 pub const MIN_THEIR_CHAN_RESERVE_SATOSHIS: u64 = 1000;
804
805 /// Used to return a simple Error back to ChannelManager. Will get converted to a
806 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
807 /// channel_id in ChannelManager.
808 pub(super) enum ChannelError {
809         Ignore(String),
810         Warn(String),
811         Close(String),
812 }
813
814 impl fmt::Debug for ChannelError {
815         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
816                 match self {
817                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
818                         &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
819                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
820                 }
821         }
822 }
823
824 macro_rules! secp_check {
825         ($res: expr, $err: expr) => {
826                 match $res {
827                         Ok(thing) => thing,
828                         Err(_) => return Err(ChannelError::Close($err)),
829                 }
830         };
831 }
832
833 impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
834         /// Returns the value to use for `holder_max_htlc_value_in_flight_msat` as a percentage of the
835         /// `channel_value_satoshis` in msat, set through
836         /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]
837         ///
838         /// The effective percentage is lower bounded by 1% and upper bounded by 100%.
839         ///
840         /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]: crate::util::config::ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel
841         fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64, config: &ChannelHandshakeConfig) -> u64 {
842                 let configured_percent = if config.max_inbound_htlc_value_in_flight_percent_of_channel < 1 {
843                         1
844                 } else if config.max_inbound_htlc_value_in_flight_percent_of_channel > 100 {
845                         100
846                 } else {
847                         config.max_inbound_htlc_value_in_flight_percent_of_channel as u64
848                 };
849                 channel_value_satoshis * 10 * configured_percent
850         }
851
852         /// Returns a minimum channel reserve value the remote needs to maintain,
853         /// required by us according to the configured or default
854         /// [`ChannelHandshakeConfig::their_channel_reserve_proportional_millionths`]
855         ///
856         /// Guaranteed to return a value no larger than channel_value_satoshis
857         ///
858         /// This is used both for outbound and inbound channels and has lower bound
859         /// of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`.
860         pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64, config: &UserConfig) -> u64 {
861                 let calculated_reserve = channel_value_satoshis.saturating_mul(config.channel_handshake_config.their_channel_reserve_proportional_millionths as u64) / 1_000_000;
862                 cmp::min(channel_value_satoshis, cmp::max(calculated_reserve, MIN_THEIR_CHAN_RESERVE_SATOSHIS))
863         }
864
865         /// This is for legacy reasons, present for forward-compatibility.
866         /// LDK versions older than 0.0.104 don't know how read/handle values other than default
867         /// from storage. Hence, we use this function to not persist default values of
868         /// `holder_selected_channel_reserve_satoshis` for channels into storage.
869         pub(crate) fn get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
870                 let (q, _) = channel_value_satoshis.overflowing_div(100);
871                 cmp::min(channel_value_satoshis, cmp::max(q, 1000))
872         }
873
874         pub(crate) fn opt_anchors(&self) -> bool {
875                 self.channel_transaction_parameters.opt_anchors.is_some()
876         }
877
878         fn get_initial_channel_type(config: &UserConfig, their_features: &InitFeatures) -> ChannelTypeFeatures {
879                 // The default channel type (ie the first one we try) depends on whether the channel is
880                 // public - if it is, we just go with `only_static_remotekey` as it's the only option
881                 // available. If it's private, we first try `scid_privacy` as it provides better privacy
882                 // with no other changes, and fall back to `only_static_remotekey`.
883                 let mut ret = ChannelTypeFeatures::only_static_remote_key();
884                 if !config.channel_handshake_config.announced_channel &&
885                         config.channel_handshake_config.negotiate_scid_privacy &&
886                         their_features.supports_scid_privacy() {
887                         ret.set_scid_privacy_required();
888                 }
889
890                 // Optionally, if the user would like to negotiate the `anchors_zero_fee_htlc_tx` option, we
891                 // set it now. If they don't understand it, we'll fall back to our default of
892                 // `only_static_remotekey`.
893                 #[cfg(anchors)]
894                 { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
895                         if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx &&
896                                 their_features.supports_anchors_zero_fee_htlc_tx() {
897                                 ret.set_anchors_zero_fee_htlc_tx_required();
898                         }
899                 }
900
901                 ret
902         }
903
904         /// If we receive an error message, it may only be a rejection of the channel type we tried,
905         /// not of our ability to open any channel at all. Thus, on error, we should first call this
906         /// and see if we get a new `OpenChannel` message, otherwise the channel is failed.
907         pub(crate) fn maybe_handle_error_without_close(&mut self, chain_hash: BlockHash) -> Result<msgs::OpenChannel, ()> {
908                 if !self.is_outbound() || self.channel_state != ChannelState::OurInitSent as u32 { return Err(()); }
909                 if self.channel_type == ChannelTypeFeatures::only_static_remote_key() {
910                         // We've exhausted our options
911                         return Err(());
912                 }
913                 // We support opening a few different types of channels. Try removing our additional
914                 // features one by one until we've either arrived at our default or the counterparty has
915                 // accepted one.
916                 //
917                 // Due to the order below, we may not negotiate `option_anchors_zero_fee_htlc_tx` if the
918                 // counterparty doesn't support `option_scid_privacy`. Since `get_initial_channel_type`
919                 // checks whether the counterparty supports every feature, this would only happen if the
920                 // counterparty is advertising the feature, but rejecting channels proposing the feature for
921                 // whatever reason.
922                 if self.channel_type.supports_anchors_zero_fee_htlc_tx() {
923                         self.channel_type.clear_anchors_zero_fee_htlc_tx();
924                         assert!(self.channel_transaction_parameters.opt_non_zero_fee_anchors.is_none());
925                         self.channel_transaction_parameters.opt_anchors = None;
926                 } else if self.channel_type.supports_scid_privacy() {
927                         self.channel_type.clear_scid_privacy();
928                 } else {
929                         self.channel_type = ChannelTypeFeatures::only_static_remote_key();
930                 }
931                 Ok(self.get_open_channel(chain_hash))
932         }
933
934         // Constructors:
935         pub fn new_outbound<ES: Deref, SP: Deref, F: Deref>(
936                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP, counterparty_node_id: PublicKey, their_features: &InitFeatures,
937                 channel_value_satoshis: u64, push_msat: u64, user_id: u128, config: &UserConfig, current_chain_height: u32,
938                 outbound_scid_alias: u64
939         ) -> Result<Channel<Signer>, APIError>
940         where ES::Target: EntropySource,
941               SP::Target: SignerProvider<Signer = Signer>,
942               F::Target: FeeEstimator,
943         {
944                 let holder_selected_contest_delay = config.channel_handshake_config.our_to_self_delay;
945                 let channel_keys_id = signer_provider.generate_channel_keys_id(false, channel_value_satoshis, user_id);
946                 let holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
947                 let pubkeys = holder_signer.pubkeys().clone();
948
949                 if !their_features.supports_wumbo() && channel_value_satoshis > MAX_FUNDING_SATOSHIS_NO_WUMBO {
950                         return Err(APIError::APIMisuseError{err: format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, channel_value_satoshis)});
951                 }
952                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
953                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than the total bitcoin supply, it was {}", channel_value_satoshis)});
954                 }
955                 let channel_value_msat = channel_value_satoshis * 1000;
956                 if push_msat > channel_value_msat {
957                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
958                 }
959                 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
960                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
961                 }
962                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis, config);
963                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
964                         // Protocol level safety check in place, although it should never happen because
965                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
966                         return Err(APIError::APIMisuseError { err: format!("Holder selected channel  reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
967                 }
968
969                 let channel_type = Self::get_initial_channel_type(&config, their_features);
970                 debug_assert!(channel_type.is_subset(&channelmanager::provided_channel_type_features(&config)));
971
972                 let feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
973
974                 let value_to_self_msat = channel_value_satoshis * 1000 - push_msat;
975                 let commitment_tx_fee = Self::commit_tx_fee_msat(feerate, MIN_AFFORDABLE_HTLC_COUNT, channel_type.requires_anchors_zero_fee_htlc_tx());
976                 if value_to_self_msat < commitment_tx_fee {
977                         return Err(APIError::APIMisuseError{ err: format!("Funding amount ({}) can't even pay fee for initial commitment transaction fee of {}.", value_to_self_msat / 1000, commitment_tx_fee / 1000) });
978                 }
979
980                 let mut secp_ctx = Secp256k1::new();
981                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
982
983                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
984                         Some(signer_provider.get_shutdown_scriptpubkey())
985                 } else { None };
986
987                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
988                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
989                                 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
990                         }
991                 }
992
993                 Ok(Channel {
994                         user_id,
995
996                         config: LegacyChannelConfig {
997                                 options: config.channel_config.clone(),
998                                 announced_channel: config.channel_handshake_config.announced_channel,
999                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1000                         },
1001
1002                         prev_config: None,
1003
1004                         inbound_handshake_limits_override: Some(config.channel_handshake_limits.clone()),
1005
1006                         channel_id: entropy_source.get_secure_random_bytes(),
1007                         channel_state: ChannelState::OurInitSent as u32,
1008                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1009                         secp_ctx,
1010                         channel_value_satoshis,
1011
1012                         latest_monitor_update_id: 0,
1013
1014                         holder_signer,
1015                         shutdown_scriptpubkey,
1016                         destination_script: signer_provider.get_destination_script(),
1017
1018                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1019                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1020                         value_to_self_msat,
1021
1022                         pending_inbound_htlcs: Vec::new(),
1023                         pending_outbound_htlcs: Vec::new(),
1024                         holding_cell_htlc_updates: Vec::new(),
1025                         pending_update_fee: None,
1026                         holding_cell_update_fee: None,
1027                         next_holder_htlc_id: 0,
1028                         next_counterparty_htlc_id: 0,
1029                         update_time_counter: 1,
1030
1031                         resend_order: RAACommitmentOrder::CommitmentFirst,
1032
1033                         monitor_pending_channel_ready: false,
1034                         monitor_pending_revoke_and_ack: false,
1035                         monitor_pending_commitment_signed: false,
1036                         monitor_pending_forwards: Vec::new(),
1037                         monitor_pending_failures: Vec::new(),
1038                         monitor_pending_finalized_fulfills: Vec::new(),
1039
1040                         #[cfg(debug_assertions)]
1041                         holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
1042                         #[cfg(debug_assertions)]
1043                         counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
1044
1045                         last_sent_closing_fee: None,
1046                         pending_counterparty_closing_signed: None,
1047                         closing_fee_limits: None,
1048                         target_closing_feerate_sats_per_kw: None,
1049
1050                         inbound_awaiting_accept: false,
1051
1052                         funding_tx_confirmed_in: None,
1053                         funding_tx_confirmation_height: 0,
1054                         short_channel_id: None,
1055                         channel_creation_height: current_chain_height,
1056
1057                         feerate_per_kw: feerate,
1058                         counterparty_dust_limit_satoshis: 0,
1059                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1060                         counterparty_max_htlc_value_in_flight_msat: 0,
1061                         holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
1062                         counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
1063                         holder_selected_channel_reserve_satoshis,
1064                         counterparty_htlc_minimum_msat: 0,
1065                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1066                         counterparty_max_accepted_htlcs: 0,
1067                         minimum_depth: None, // Filled in in accept_channel
1068
1069                         counterparty_forwarding_info: None,
1070
1071                         channel_transaction_parameters: ChannelTransactionParameters {
1072                                 holder_pubkeys: pubkeys,
1073                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1074                                 is_outbound_from_holder: true,
1075                                 counterparty_parameters: None,
1076                                 funding_outpoint: None,
1077                                 opt_anchors: if channel_type.requires_anchors_zero_fee_htlc_tx() { Some(()) } else { None },
1078                                 opt_non_zero_fee_anchors: None
1079                         },
1080                         funding_transaction: None,
1081
1082                         counterparty_cur_commitment_point: None,
1083                         counterparty_prev_commitment_point: None,
1084                         counterparty_node_id,
1085
1086                         counterparty_shutdown_scriptpubkey: None,
1087
1088                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1089
1090                         channel_update_status: ChannelUpdateStatus::Enabled,
1091                         closing_signed_in_flight: false,
1092
1093                         announcement_sigs: None,
1094
1095                         #[cfg(any(test, fuzzing))]
1096                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1097                         #[cfg(any(test, fuzzing))]
1098                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1099
1100                         workaround_lnd_bug_4006: None,
1101
1102                         latest_inbound_scid_alias: None,
1103                         outbound_scid_alias,
1104
1105                         channel_ready_event_emitted: false,
1106
1107                         #[cfg(any(test, fuzzing))]
1108                         historical_inbound_htlc_fulfills: HashSet::new(),
1109
1110                         channel_type,
1111                         channel_keys_id,
1112
1113                         pending_monitor_updates: Vec::new(),
1114                 })
1115         }
1116
1117         fn check_remote_fee<F: Deref, L: Deref>(fee_estimator: &LowerBoundedFeeEstimator<F>,
1118                 feerate_per_kw: u32, cur_feerate_per_kw: Option<u32>, logger: &L)
1119                 -> Result<(), ChannelError> where F::Target: FeeEstimator, L::Target: Logger,
1120         {
1121                 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
1122                 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
1123                 // We generally don't care too much if they set the feerate to something very high, but it
1124                 // could result in the channel being useless due to everything being dust.
1125                 let upper_limit = cmp::max(250 * 25,
1126                         fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
1127                 if feerate_per_kw as u64 > upper_limit {
1128                         return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
1129                 }
1130                 let lower_limit = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background);
1131                 // Some fee estimators round up to the next full sat/vbyte (ie 250 sats per kw), causing
1132                 // occasional issues with feerate disagreements between an initiator that wants a feerate
1133                 // of 1.1 sat/vbyte and a receiver that wants 1.1 rounded up to 2. Thus, we always add 250
1134                 // sat/kw before the comparison here.
1135                 if feerate_per_kw + 250 < lower_limit {
1136                         if let Some(cur_feerate) = cur_feerate_per_kw {
1137                                 if feerate_per_kw > cur_feerate {
1138                                         log_warn!(logger,
1139                                                 "Accepting feerate that may prevent us from closing this channel because it's higher than what we have now. Had {} s/kW, now {} s/kW.",
1140                                                 cur_feerate, feerate_per_kw);
1141                                         return Ok(());
1142                                 }
1143                         }
1144                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {} (- 250)", feerate_per_kw, lower_limit)));
1145                 }
1146                 Ok(())
1147         }
1148
1149         /// Creates a new channel from a remote sides' request for one.
1150         /// Assumes chain_hash has already been checked and corresponds with what we expect!
1151         pub fn new_from_req<ES: Deref, SP: Deref, F: Deref, L: Deref>(
1152                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
1153                 counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
1154                 their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u128, config: &UserConfig,
1155                 current_chain_height: u32, logger: &L, outbound_scid_alias: u64
1156         ) -> Result<Channel<Signer>, ChannelError>
1157                 where ES::Target: EntropySource,
1158                           SP::Target: SignerProvider<Signer = Signer>,
1159                           F::Target: FeeEstimator,
1160                           L::Target: Logger,
1161         {
1162                 let announced_channel = if (msg.channel_flags & 1) == 1 { true } else { false };
1163
1164                 // First check the channel type is known, failing before we do anything else if we don't
1165                 // support this channel type.
1166                 let channel_type = if let Some(channel_type) = &msg.channel_type {
1167                         if channel_type.supports_any_optional_bits() {
1168                                 return Err(ChannelError::Close("Channel Type field contained optional bits - this is not allowed".to_owned()));
1169                         }
1170
1171                         // We only support the channel types defined by the `ChannelManager` in
1172                         // `provided_channel_type_features`. The channel type must always support
1173                         // `static_remote_key`.
1174                         if !channel_type.requires_static_remote_key() {
1175                                 return Err(ChannelError::Close("Channel Type was not understood - we require static remote key".to_owned()));
1176                         }
1177                         // Make sure we support all of the features behind the channel type.
1178                         if !channel_type.is_subset(our_supported_features) {
1179                                 return Err(ChannelError::Close("Channel Type contains unsupported features".to_owned()));
1180                         }
1181                         if channel_type.requires_scid_privacy() && announced_channel {
1182                                 return Err(ChannelError::Close("SCID Alias/Privacy Channel Type cannot be set on a public channel".to_owned()));
1183                         }
1184                         channel_type.clone()
1185                 } else {
1186                         let channel_type = ChannelTypeFeatures::from_init(&their_features);
1187                         if channel_type != ChannelTypeFeatures::only_static_remote_key() {
1188                                 return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
1189                         }
1190                         channel_type
1191                 };
1192                 let opt_anchors = channel_type.supports_anchors_zero_fee_htlc_tx();
1193
1194                 let channel_keys_id = signer_provider.generate_channel_keys_id(true, msg.funding_satoshis, user_id);
1195                 let holder_signer = signer_provider.derive_channel_signer(msg.funding_satoshis, channel_keys_id);
1196                 let pubkeys = holder_signer.pubkeys().clone();
1197                 let counterparty_pubkeys = ChannelPublicKeys {
1198                         funding_pubkey: msg.funding_pubkey,
1199                         revocation_basepoint: msg.revocation_basepoint,
1200                         payment_point: msg.payment_point,
1201                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1202                         htlc_basepoint: msg.htlc_basepoint
1203                 };
1204
1205                 if config.channel_handshake_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
1206                         return Err(ChannelError::Close(format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks. It must be greater than {}", config.channel_handshake_config.our_to_self_delay, BREAKDOWN_TIMEOUT)));
1207                 }
1208
1209                 // Check sanity of message fields:
1210                 if msg.funding_satoshis > config.channel_handshake_limits.max_funding_satoshis {
1211                         return Err(ChannelError::Close(format!("Per our config, funding must be at most {}. It was {}", config.channel_handshake_limits.max_funding_satoshis, msg.funding_satoshis)));
1212                 }
1213                 if msg.funding_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1214                         return Err(ChannelError::Close(format!("Funding must be smaller than the total bitcoin supply. It was {}", msg.funding_satoshis)));
1215                 }
1216                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
1217                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
1218                 }
1219                 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
1220                 if msg.push_msat > full_channel_value_msat {
1221                         return Err(ChannelError::Close(format!("push_msat {} was larger than channel amount minus reserve ({})", msg.push_msat, full_channel_value_msat)));
1222                 }
1223                 if msg.dust_limit_satoshis > msg.funding_satoshis {
1224                         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)));
1225                 }
1226                 if msg.htlc_minimum_msat >= full_channel_value_msat {
1227                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1228                 }
1229                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw, None, logger)?;
1230
1231                 let max_counterparty_selected_contest_delay = u16::min(config.channel_handshake_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1232                 if msg.to_self_delay > max_counterparty_selected_contest_delay {
1233                         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)));
1234                 }
1235                 if msg.max_accepted_htlcs < 1 {
1236                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1237                 }
1238                 if msg.max_accepted_htlcs > MAX_HTLCS {
1239                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1240                 }
1241
1242                 // Now check against optional parameters as set by config...
1243                 if msg.funding_satoshis < config.channel_handshake_limits.min_funding_satoshis {
1244                         return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", msg.funding_satoshis, config.channel_handshake_limits.min_funding_satoshis)));
1245                 }
1246                 if msg.htlc_minimum_msat > config.channel_handshake_limits.max_htlc_minimum_msat {
1247                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat,  config.channel_handshake_limits.max_htlc_minimum_msat)));
1248                 }
1249                 if msg.max_htlc_value_in_flight_msat < config.channel_handshake_limits.min_max_htlc_value_in_flight_msat {
1250                         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.channel_handshake_limits.min_max_htlc_value_in_flight_msat)));
1251                 }
1252                 if msg.channel_reserve_satoshis > config.channel_handshake_limits.max_channel_reserve_satoshis {
1253                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.channel_handshake_limits.max_channel_reserve_satoshis)));
1254                 }
1255                 if msg.max_accepted_htlcs < config.channel_handshake_limits.min_max_accepted_htlcs {
1256                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.channel_handshake_limits.min_max_accepted_htlcs)));
1257                 }
1258                 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1259                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1260                 }
1261                 if msg.dust_limit_satoshis >  MAX_CHAN_DUST_LIMIT_SATOSHIS {
1262                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1263                 }
1264
1265                 // Convert things into internal flags and prep our state:
1266
1267                 if config.channel_handshake_limits.force_announced_channel_preference {
1268                         if config.channel_handshake_config.announced_channel != announced_channel {
1269                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
1270                         }
1271                 }
1272
1273                 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis, config);
1274                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1275                         // Protocol level safety check in place, although it should never happen because
1276                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
1277                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1278                 }
1279                 if holder_selected_channel_reserve_satoshis * 1000 >= full_channel_value_msat {
1280                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({})msats. Channel value is ({} - {})msats.", holder_selected_channel_reserve_satoshis * 1000, full_channel_value_msat, msg.push_msat)));
1281                 }
1282                 if msg.channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1283                         log_debug!(logger, "channel_reserve_satoshis ({}) is smaller than our dust limit ({}). We can broadcast stale states without any risk, implying this channel is very insecure for our counterparty.",
1284                                 msg.channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
1285                 }
1286                 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
1287                         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)));
1288                 }
1289
1290                 // check if the funder's amount for the initial commitment tx is sufficient
1291                 // for full fee payment plus a few HTLCs to ensure the channel will be useful.
1292                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
1293                 let commitment_tx_fee = Self::commit_tx_fee_msat(msg.feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT, opt_anchors) / 1000;
1294                 if funders_amount_msat / 1000 < commitment_tx_fee {
1295                         return Err(ChannelError::Close(format!("Funding amount ({} sats) can't even pay fee for initial commitment transaction fee of {} sats.", funders_amount_msat / 1000, commitment_tx_fee)));
1296                 }
1297
1298                 let to_remote_satoshis = funders_amount_msat / 1000 - commitment_tx_fee;
1299                 // While it's reasonable for us to not meet the channel reserve initially (if they don't
1300                 // want to push much to us), our counterparty should always have more than our reserve.
1301                 if to_remote_satoshis < holder_selected_channel_reserve_satoshis {
1302                         return Err(ChannelError::Close("Insufficient funding amount for initial reserve".to_owned()));
1303                 }
1304
1305                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1306                         match &msg.shutdown_scriptpubkey {
1307                                 &OptionalField::Present(ref script) => {
1308                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1309                                         if script.len() == 0 {
1310                                                 None
1311                                         } else {
1312                                                 if !script::is_bolt2_compliant(&script, their_features) {
1313                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
1314                                                 }
1315                                                 Some(script.clone())
1316                                         }
1317                                 },
1318                                 // 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
1319                                 &OptionalField::Absent => {
1320                                         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()));
1321                                 }
1322                         }
1323                 } else { None };
1324
1325                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
1326                         Some(signer_provider.get_shutdown_scriptpubkey())
1327                 } else { None };
1328
1329                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1330                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
1331                                 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
1332                         }
1333                 }
1334
1335                 let mut secp_ctx = Secp256k1::new();
1336                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1337
1338                 let chan = Channel {
1339                         user_id,
1340
1341                         config: LegacyChannelConfig {
1342                                 options: config.channel_config.clone(),
1343                                 announced_channel,
1344                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1345                         },
1346
1347                         prev_config: None,
1348
1349                         inbound_handshake_limits_override: None,
1350
1351                         channel_id: msg.temporary_channel_id,
1352                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
1353                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1354                         secp_ctx,
1355
1356                         latest_monitor_update_id: 0,
1357
1358                         holder_signer,
1359                         shutdown_scriptpubkey,
1360                         destination_script: signer_provider.get_destination_script(),
1361
1362                         cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1363                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1364                         value_to_self_msat: msg.push_msat,
1365
1366                         pending_inbound_htlcs: Vec::new(),
1367                         pending_outbound_htlcs: Vec::new(),
1368                         holding_cell_htlc_updates: Vec::new(),
1369                         pending_update_fee: None,
1370                         holding_cell_update_fee: None,
1371                         next_holder_htlc_id: 0,
1372                         next_counterparty_htlc_id: 0,
1373                         update_time_counter: 1,
1374
1375                         resend_order: RAACommitmentOrder::CommitmentFirst,
1376
1377                         monitor_pending_channel_ready: false,
1378                         monitor_pending_revoke_and_ack: false,
1379                         monitor_pending_commitment_signed: false,
1380                         monitor_pending_forwards: Vec::new(),
1381                         monitor_pending_failures: Vec::new(),
1382                         monitor_pending_finalized_fulfills: Vec::new(),
1383
1384                         #[cfg(debug_assertions)]
1385                         holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1386                         #[cfg(debug_assertions)]
1387                         counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1388
1389                         last_sent_closing_fee: None,
1390                         pending_counterparty_closing_signed: None,
1391                         closing_fee_limits: None,
1392                         target_closing_feerate_sats_per_kw: None,
1393
1394                         inbound_awaiting_accept: true,
1395
1396                         funding_tx_confirmed_in: None,
1397                         funding_tx_confirmation_height: 0,
1398                         short_channel_id: None,
1399                         channel_creation_height: current_chain_height,
1400
1401                         feerate_per_kw: msg.feerate_per_kw,
1402                         channel_value_satoshis: msg.funding_satoshis,
1403                         counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
1404                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1405                         counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
1406                         holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(msg.funding_satoshis, &config.channel_handshake_config),
1407                         counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
1408                         holder_selected_channel_reserve_satoshis,
1409                         counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
1410                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1411                         counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
1412                         minimum_depth: Some(cmp::max(config.channel_handshake_config.minimum_depth, 1)),
1413
1414                         counterparty_forwarding_info: None,
1415
1416                         channel_transaction_parameters: ChannelTransactionParameters {
1417                                 holder_pubkeys: pubkeys,
1418                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1419                                 is_outbound_from_holder: false,
1420                                 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1421                                         selected_contest_delay: msg.to_self_delay,
1422                                         pubkeys: counterparty_pubkeys,
1423                                 }),
1424                                 funding_outpoint: None,
1425                                 opt_anchors: if opt_anchors { Some(()) } else { None },
1426                                 opt_non_zero_fee_anchors: None
1427                         },
1428                         funding_transaction: None,
1429
1430                         counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
1431                         counterparty_prev_commitment_point: None,
1432                         counterparty_node_id,
1433
1434                         counterparty_shutdown_scriptpubkey,
1435
1436                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1437
1438                         channel_update_status: ChannelUpdateStatus::Enabled,
1439                         closing_signed_in_flight: false,
1440
1441                         announcement_sigs: None,
1442
1443                         #[cfg(any(test, fuzzing))]
1444                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1445                         #[cfg(any(test, fuzzing))]
1446                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1447
1448                         workaround_lnd_bug_4006: None,
1449
1450                         latest_inbound_scid_alias: None,
1451                         outbound_scid_alias,
1452
1453                         channel_ready_event_emitted: false,
1454
1455                         #[cfg(any(test, fuzzing))]
1456                         historical_inbound_htlc_fulfills: HashSet::new(),
1457
1458                         channel_type,
1459                         channel_keys_id,
1460
1461                         pending_monitor_updates: Vec::new(),
1462                 };
1463
1464                 Ok(chan)
1465         }
1466
1467         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1468         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1469         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1470         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1471         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1472         /// an HTLC to a).
1473         /// @local is used only to convert relevant internal structures which refer to remote vs local
1474         /// to decide value of outputs and direction of HTLCs.
1475         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1476         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1477         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1478         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1479         /// which peer generated this transaction and "to whom" this transaction flows.
1480         #[inline]
1481         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
1482                 where L::Target: Logger
1483         {
1484                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1485                 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1486                 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1487
1488                 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1489                 let mut remote_htlc_total_msat = 0;
1490                 let mut local_htlc_total_msat = 0;
1491                 let mut value_to_self_msat_offset = 0;
1492
1493                 let mut feerate_per_kw = self.feerate_per_kw;
1494                 if let Some((feerate, update_state)) = self.pending_update_fee {
1495                         if match update_state {
1496                                 // Note that these match the inclusion criteria when scanning
1497                                 // pending_inbound_htlcs below.
1498                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1499                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1500                                 FeeUpdateState::Outbound => { assert!(self.is_outbound());  generated_by_local },
1501                         } {
1502                                 feerate_per_kw = feerate;
1503                         }
1504                 }
1505
1506                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1507                         commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1508                         get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1509                         log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1510
1511                 macro_rules! get_htlc_in_commitment {
1512                         ($htlc: expr, $offered: expr) => {
1513                                 HTLCOutputInCommitment {
1514                                         offered: $offered,
1515                                         amount_msat: $htlc.amount_msat,
1516                                         cltv_expiry: $htlc.cltv_expiry,
1517                                         payment_hash: $htlc.payment_hash,
1518                                         transaction_output_index: None
1519                                 }
1520                         }
1521                 }
1522
1523                 macro_rules! add_htlc_output {
1524                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1525                                 if $outbound == local { // "offered HTLC output"
1526                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1527                                         let htlc_tx_fee = if self.opt_anchors() {
1528                                                 0
1529                                         } else {
1530                                                 feerate_per_kw as u64 * htlc_timeout_tx_weight(false) / 1000
1531                                         };
1532                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
1533                                                 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);
1534                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1535                                         } else {
1536                                                 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);
1537                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1538                                         }
1539                                 } else {
1540                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1541                                         let htlc_tx_fee = if self.opt_anchors() {
1542                                                 0
1543                                         } else {
1544                                                 feerate_per_kw as u64 * htlc_success_tx_weight(false) / 1000
1545                                         };
1546                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
1547                                                 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);
1548                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
1549                                         } else {
1550                                                 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);
1551                                                 included_dust_htlcs.push((htlc_in_tx, $source));
1552                                         }
1553                                 }
1554                         }
1555                 }
1556
1557                 for ref htlc in self.pending_inbound_htlcs.iter() {
1558                         let (include, state_name) = match htlc.state {
1559                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1560                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1561                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1562                                 InboundHTLCState::Committed => (true, "Committed"),
1563                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1564                         };
1565
1566                         if include {
1567                                 add_htlc_output!(htlc, false, None, state_name);
1568                                 remote_htlc_total_msat += htlc.amount_msat;
1569                         } else {
1570                                 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);
1571                                 match &htlc.state {
1572                                         &InboundHTLCState::LocalRemoved(ref reason) => {
1573                                                 if generated_by_local {
1574                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1575                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
1576                                                         }
1577                                                 }
1578                                         },
1579                                         _ => {},
1580                                 }
1581                         }
1582                 }
1583
1584                 let mut preimages: Vec<PaymentPreimage> = Vec::new();
1585
1586                 for ref htlc in self.pending_outbound_htlcs.iter() {
1587                         let (include, state_name) = match htlc.state {
1588                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1589                                 OutboundHTLCState::Committed => (true, "Committed"),
1590                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1591                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1592                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1593                         };
1594
1595                         let preimage_opt = match htlc.state {
1596                                 OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(p)) => p,
1597                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(p)) => p,
1598                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(p)) => p,
1599                                 _ => None,
1600                         };
1601
1602                         if let Some(preimage) = preimage_opt {
1603                                 preimages.push(preimage);
1604                         }
1605
1606                         if include {
1607                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1608                                 local_htlc_total_msat += htlc.amount_msat;
1609                         } else {
1610                                 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);
1611                                 match htlc.state {
1612                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_))|OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) => {
1613                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
1614                                         },
1615                                         OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(_)) => {
1616                                                 if !generated_by_local {
1617                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
1618                                                 }
1619                                         },
1620                                         _ => {},
1621                                 }
1622                         }
1623                 }
1624
1625                 let mut value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1626                 assert!(value_to_self_msat >= 0);
1627                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1628                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1629                 // "violate" their reserve value by couting those against it. Thus, we have to convert
1630                 // everything to i64 before subtracting as otherwise we can overflow.
1631                 let mut 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;
1632                 assert!(value_to_remote_msat >= 0);
1633
1634                 #[cfg(debug_assertions)]
1635                 {
1636                         // Make sure that the to_self/to_remote is always either past the appropriate
1637                         // channel_reserve *or* it is making progress towards it.
1638                         let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1639                                 self.holder_max_commitment_tx_output.lock().unwrap()
1640                         } else {
1641                                 self.counterparty_max_commitment_tx_output.lock().unwrap()
1642                         };
1643                         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);
1644                         broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1645                         debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= self.holder_selected_channel_reserve_satoshis as i64);
1646                         broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1647                 }
1648
1649                 let total_fee_sat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, included_non_dust_htlcs.len(), self.channel_transaction_parameters.opt_anchors.is_some());
1650                 let anchors_val = if self.channel_transaction_parameters.opt_anchors.is_some() { ANCHOR_OUTPUT_VALUE_SATOSHI * 2 } else { 0 } as i64;
1651                 let (value_to_self, value_to_remote) = if self.is_outbound() {
1652                         (value_to_self_msat / 1000 - anchors_val - total_fee_sat as i64, value_to_remote_msat / 1000)
1653                 } else {
1654                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - anchors_val - total_fee_sat as i64)
1655                 };
1656
1657                 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1658                 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1659                 let (funding_pubkey_a, funding_pubkey_b) = if local {
1660                         (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
1661                 } else {
1662                         (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
1663                 };
1664
1665                 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1666                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1667                 } else {
1668                         value_to_a = 0;
1669                 }
1670
1671                 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1672                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1673                 } else {
1674                         value_to_b = 0;
1675                 }
1676
1677                 let num_nondust_htlcs = included_non_dust_htlcs.len();
1678
1679                 let channel_parameters =
1680                         if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1681                         else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1682                 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1683                                                                              value_to_a as u64,
1684                                                                              value_to_b as u64,
1685                                                                              self.channel_transaction_parameters.opt_anchors.is_some(),
1686                                                                              funding_pubkey_a,
1687                                                                              funding_pubkey_b,
1688                                                                              keys.clone(),
1689                                                                              feerate_per_kw,
1690                                                                              &mut included_non_dust_htlcs,
1691                                                                              &channel_parameters
1692                 );
1693                 let mut htlcs_included = included_non_dust_htlcs;
1694                 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1695                 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1696                 htlcs_included.append(&mut included_dust_htlcs);
1697
1698                 // For the stats, trimmed-to-0 the value in msats accordingly
1699                 value_to_self_msat = if (value_to_self_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_self_msat };
1700                 value_to_remote_msat = if (value_to_remote_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_remote_msat };
1701
1702                 CommitmentStats {
1703                         tx,
1704                         feerate_per_kw,
1705                         total_fee_sat,
1706                         num_nondust_htlcs,
1707                         htlcs_included,
1708                         local_balance_msat: value_to_self_msat as u64,
1709                         remote_balance_msat: value_to_remote_msat as u64,
1710                         preimages
1711                 }
1712         }
1713
1714         #[inline]
1715         fn get_closing_scriptpubkey(&self) -> Script {
1716                 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1717                 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1718                 // outside of those situations will fail.
1719                 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1720         }
1721
1722         #[inline]
1723         fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1724                 let mut ret =
1725                 (4 +                                           // version
1726                  1 +                                           // input count
1727                  36 +                                          // prevout
1728                  1 +                                           // script length (0)
1729                  4 +                                           // sequence
1730                  1 +                                           // output count
1731                  4                                             // lock time
1732                  )*4 +                                         // * 4 for non-witness parts
1733                 2 +                                            // witness marker and flag
1734                 1 +                                            // witness element count
1735                 4 +                                            // 4 element lengths (2 sigs, multisig dummy, and witness script)
1736                 self.get_funding_redeemscript().len() as u64 + // funding witness script
1737                 2*(1 + 71);                                    // two signatures + sighash type flags
1738                 if let Some(spk) = a_scriptpubkey {
1739                         ret += ((8+1) +                            // output values and script length
1740                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1741                 }
1742                 if let Some(spk) = b_scriptpubkey {
1743                         ret += ((8+1) +                            // output values and script length
1744                                 spk.len() as u64) * 4;                 // scriptpubkey and witness multiplier
1745                 }
1746                 ret
1747         }
1748
1749         #[inline]
1750         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
1751                 assert!(self.pending_inbound_htlcs.is_empty());
1752                 assert!(self.pending_outbound_htlcs.is_empty());
1753                 assert!(self.pending_update_fee.is_none());
1754
1755                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1756                 let mut value_to_holder: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1757                 let mut value_to_counterparty: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1758
1759                 if value_to_holder < 0 {
1760                         assert!(self.is_outbound());
1761                         total_fee_satoshis += (-value_to_holder) as u64;
1762                 } else if value_to_counterparty < 0 {
1763                         assert!(!self.is_outbound());
1764                         total_fee_satoshis += (-value_to_counterparty) as u64;
1765                 }
1766
1767                 if skip_remote_output || value_to_counterparty as u64 <= self.holder_dust_limit_satoshis {
1768                         value_to_counterparty = 0;
1769                 }
1770
1771                 if value_to_holder as u64 <= self.holder_dust_limit_satoshis {
1772                         value_to_holder = 0;
1773                 }
1774
1775                 assert!(self.shutdown_scriptpubkey.is_some());
1776                 let holder_shutdown_script = self.get_closing_scriptpubkey();
1777                 let counterparty_shutdown_script = self.counterparty_shutdown_scriptpubkey.clone().unwrap();
1778                 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
1779
1780                 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
1781                 (closing_transaction, total_fee_satoshis)
1782         }
1783
1784         fn funding_outpoint(&self) -> OutPoint {
1785                 self.channel_transaction_parameters.funding_outpoint.unwrap()
1786         }
1787
1788         #[inline]
1789         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1790         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1791         /// our counterparty!)
1792         /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1793         /// TODO Some magic rust shit to compile-time check this?
1794         fn build_holder_transaction_keys(&self, commitment_number: u64) -> TxCreationKeys {
1795                 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1796                 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1797                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1798                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1799
1800                 TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint)
1801         }
1802
1803         #[inline]
1804         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1805         /// will sign and send to our counterparty.
1806         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1807         fn build_remote_transaction_keys(&self) -> TxCreationKeys {
1808                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1809                 //may see payments to it!
1810                 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1811                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1812                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1813
1814                 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)
1815         }
1816
1817         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1818         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1819         /// Panics if called before accept_channel/new_from_req
1820         pub fn get_funding_redeemscript(&self) -> Script {
1821                 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1822         }
1823
1824         /// Claims an HTLC while we're disconnected from a peer, dropping the [`ChannelMonitorUpdate`]
1825         /// entirely.
1826         ///
1827         /// The [`ChannelMonitor`] for this channel MUST be updated out-of-band with the preimage
1828         /// provided (i.e. without calling [`crate::chain::Watch::update_channel`]).
1829         ///
1830         /// The HTLC claim will end up in the holding cell (because the caller must ensure the peer is
1831         /// disconnected).
1832         pub fn claim_htlc_while_disconnected_dropping_mon_update<L: Deref>
1833                 (&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L)
1834         where L::Target: Logger {
1835                 // Assert that we'll add the HTLC claim to the holding cell in `get_update_fulfill_htlc`
1836                 // (see equivalent if condition there).
1837                 assert!(self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32) != 0);
1838                 let mon_update_id = self.latest_monitor_update_id; // Forget the ChannelMonitor update
1839                 let fulfill_resp = self.get_update_fulfill_htlc(htlc_id_arg, payment_preimage_arg, logger);
1840                 self.latest_monitor_update_id = mon_update_id;
1841                 if let UpdateFulfillFetch::NewClaim { msg, .. } = fulfill_resp {
1842                         assert!(msg.is_none()); // The HTLC must have ended up in the holding cell.
1843                 }
1844         }
1845
1846         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1847                 // Either ChannelReady got set (which means it won't be unset) or there is no way any
1848                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1849                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1850                 // either.
1851                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
1852                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1853                 }
1854                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1855
1856                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1857
1858                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1859                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1860                 // these, but for now we just have to treat them as normal.
1861
1862                 let mut pending_idx = core::usize::MAX;
1863                 let mut htlc_value_msat = 0;
1864                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1865                         if htlc.htlc_id == htlc_id_arg {
1866                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1867                                 match htlc.state {
1868                                         InboundHTLCState::Committed => {},
1869                                         InboundHTLCState::LocalRemoved(ref reason) => {
1870                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1871                                                 } else {
1872                                                         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()));
1873                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1874                                                 }
1875                                                 return UpdateFulfillFetch::DuplicateClaim {};
1876                                         },
1877                                         _ => {
1878                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1879                                                 // Don't return in release mode here so that we can update channel_monitor
1880                                         }
1881                                 }
1882                                 pending_idx = idx;
1883                                 htlc_value_msat = htlc.amount_msat;
1884                                 break;
1885                         }
1886                 }
1887                 if pending_idx == core::usize::MAX {
1888                         #[cfg(any(test, fuzzing))]
1889                         // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1890                         // this is simply a duplicate claim, not previously failed and we lost funds.
1891                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1892                         return UpdateFulfillFetch::DuplicateClaim {};
1893                 }
1894
1895                 // Now update local state:
1896                 //
1897                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1898                 // can claim it even if the channel hits the chain before we see their next commitment.
1899                 self.latest_monitor_update_id += 1;
1900                 let monitor_update = ChannelMonitorUpdate {
1901                         update_id: self.latest_monitor_update_id,
1902                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1903                                 payment_preimage: payment_preimage_arg.clone(),
1904                         }],
1905                 };
1906
1907                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32)) != 0 {
1908                         // Note that this condition is the same as the assertion in
1909                         // `claim_htlc_while_disconnected_dropping_mon_update` and must match exactly -
1910                         // `claim_htlc_while_disconnected_dropping_mon_update` would not work correctly if we
1911                         // do not not get into this branch.
1912                         for pending_update in self.holding_cell_htlc_updates.iter() {
1913                                 match pending_update {
1914                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1915                                                 if htlc_id_arg == htlc_id {
1916                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
1917                                                         self.latest_monitor_update_id -= 1;
1918                                                         #[cfg(any(test, fuzzing))]
1919                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1920                                                         return UpdateFulfillFetch::DuplicateClaim {};
1921                                                 }
1922                                         },
1923                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1924                                                 if htlc_id_arg == htlc_id {
1925                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1926                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1927                                                         // rare enough it may not be worth the complexity burden.
1928                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1929                                                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1930                                                 }
1931                                         },
1932                                         _ => {}
1933                                 }
1934                         }
1935                         log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1936                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1937                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1938                         });
1939                         #[cfg(any(test, fuzzing))]
1940                         self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1941                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1942                 }
1943                 #[cfg(any(test, fuzzing))]
1944                 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1945
1946                 {
1947                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1948                         if let InboundHTLCState::Committed = htlc.state {
1949                         } else {
1950                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1951                                 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1952                         }
1953                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1954                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1955                 }
1956
1957                 UpdateFulfillFetch::NewClaim {
1958                         monitor_update,
1959                         htlc_value_msat,
1960                         msg: Some(msgs::UpdateFulfillHTLC {
1961                                 channel_id: self.channel_id(),
1962                                 htlc_id: htlc_id_arg,
1963                                 payment_preimage: payment_preimage_arg,
1964                         }),
1965                 }
1966         }
1967
1968         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> UpdateFulfillCommitFetch where L::Target: Logger {
1969                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1970                         UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(_) } => {
1971                                 let mut additional_update = self.build_commitment_no_status_check(logger);
1972                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
1973                                 // strictly increasing by one, so decrement it here.
1974                                 self.latest_monitor_update_id = monitor_update.update_id;
1975                                 monitor_update.updates.append(&mut additional_update.updates);
1976                                 self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
1977                                 self.pending_monitor_updates.push(monitor_update);
1978                                 UpdateFulfillCommitFetch::NewClaim {
1979                                         monitor_update: self.pending_monitor_updates.last().unwrap(),
1980                                         htlc_value_msat,
1981                                 }
1982                         },
1983                         UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } => {
1984                                 self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
1985                                 self.pending_monitor_updates.push(monitor_update);
1986                                 UpdateFulfillCommitFetch::NewClaim {
1987                                         monitor_update: self.pending_monitor_updates.last().unwrap(),
1988                                         htlc_value_msat,
1989                                 }
1990                         }
1991                         UpdateFulfillFetch::DuplicateClaim {} => UpdateFulfillCommitFetch::DuplicateClaim {},
1992                 }
1993         }
1994
1995         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1996         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1997         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1998         /// before we fail backwards.
1999         ///
2000         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
2001         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
2002         /// [`ChannelError::Ignore`].
2003         pub fn queue_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L)
2004         -> Result<(), ChannelError> where L::Target: Logger {
2005                 self.fail_htlc(htlc_id_arg, err_packet, true, logger)
2006                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
2007         }
2008
2009         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
2010         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
2011         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
2012         /// before we fail backwards.
2013         ///
2014         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
2015         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
2016         /// [`ChannelError::Ignore`].
2017         fn fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, mut force_holding_cell: bool, logger: &L)
2018         -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> where L::Target: Logger {
2019                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
2020                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
2021                 }
2022                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2023
2024                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
2025                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
2026                 // these, but for now we just have to treat them as normal.
2027
2028                 let mut pending_idx = core::usize::MAX;
2029                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
2030                         if htlc.htlc_id == htlc_id_arg {
2031                                 match htlc.state {
2032                                         InboundHTLCState::Committed => {},
2033                                         InboundHTLCState::LocalRemoved(ref reason) => {
2034                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2035                                                 } else {
2036                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
2037                                                 }
2038                                                 return Ok(None);
2039                                         },
2040                                         _ => {
2041                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
2042                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
2043                                         }
2044                                 }
2045                                 pending_idx = idx;
2046                         }
2047                 }
2048                 if pending_idx == core::usize::MAX {
2049                         #[cfg(any(test, fuzzing))]
2050                         // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
2051                         // is simply a duplicate fail, not previously failed and we failed-back too early.
2052                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
2053                         return Ok(None);
2054                 }
2055
2056                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32)) != 0 {
2057                         debug_assert!(force_holding_cell, "!force_holding_cell is only called when emptying the holding cell, so we shouldn't end up back in it!");
2058                         force_holding_cell = true;
2059                 }
2060
2061                 // Now update local state:
2062                 if force_holding_cell {
2063                         for pending_update in self.holding_cell_htlc_updates.iter() {
2064                                 match pending_update {
2065                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
2066                                                 if htlc_id_arg == htlc_id {
2067                                                         #[cfg(any(test, fuzzing))]
2068                                                         debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
2069                                                         return Ok(None);
2070                                                 }
2071                                         },
2072                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
2073                                                 if htlc_id_arg == htlc_id {
2074                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
2075                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
2076                                                 }
2077                                         },
2078                                         _ => {}
2079                                 }
2080                         }
2081                         log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
2082                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
2083                                 htlc_id: htlc_id_arg,
2084                                 err_packet,
2085                         });
2086                         return Ok(None);
2087                 }
2088
2089                 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
2090                 {
2091                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
2092                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
2093                 }
2094
2095                 Ok(Some(msgs::UpdateFailHTLC {
2096                         channel_id: self.channel_id(),
2097                         htlc_id: htlc_id_arg,
2098                         reason: err_packet
2099                 }))
2100         }
2101
2102         // Message handlers:
2103
2104         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, default_limits: &ChannelHandshakeLimits, their_features: &InitFeatures) -> Result<(), ChannelError> {
2105                 let peer_limits = if let Some(ref limits) = self.inbound_handshake_limits_override { limits } else { default_limits };
2106
2107                 // Check sanity of message fields:
2108                 if !self.is_outbound() {
2109                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
2110                 }
2111                 if self.channel_state != ChannelState::OurInitSent as u32 {
2112                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
2113                 }
2114                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
2115                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
2116                 }
2117                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
2118                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
2119                 }
2120                 if msg.dust_limit_satoshis > self.holder_selected_channel_reserve_satoshis {
2121                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, self.holder_selected_channel_reserve_satoshis)));
2122                 }
2123                 if msg.channel_reserve_satoshis > self.channel_value_satoshis - self.holder_selected_channel_reserve_satoshis {
2124                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than channel value minus our reserve ({})",
2125                                 msg.channel_reserve_satoshis, self.channel_value_satoshis - self.holder_selected_channel_reserve_satoshis)));
2126                 }
2127                 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
2128                 if msg.htlc_minimum_msat >= full_channel_value_msat {
2129                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
2130                 }
2131                 let max_delay_acceptable = u16::min(peer_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
2132                 if msg.to_self_delay > max_delay_acceptable {
2133                         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)));
2134                 }
2135                 if msg.max_accepted_htlcs < 1 {
2136                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
2137                 }
2138                 if msg.max_accepted_htlcs > MAX_HTLCS {
2139                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
2140                 }
2141
2142                 // Now check against optional parameters as set by config...
2143                 if msg.htlc_minimum_msat > peer_limits.max_htlc_minimum_msat {
2144                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, peer_limits.max_htlc_minimum_msat)));
2145                 }
2146                 if msg.max_htlc_value_in_flight_msat < peer_limits.min_max_htlc_value_in_flight_msat {
2147                         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, peer_limits.min_max_htlc_value_in_flight_msat)));
2148                 }
2149                 if msg.channel_reserve_satoshis > peer_limits.max_channel_reserve_satoshis {
2150                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, peer_limits.max_channel_reserve_satoshis)));
2151                 }
2152                 if msg.max_accepted_htlcs < peer_limits.min_max_accepted_htlcs {
2153                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, peer_limits.min_max_accepted_htlcs)));
2154                 }
2155                 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
2156                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
2157                 }
2158                 if msg.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
2159                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
2160                 }
2161                 if msg.minimum_depth > peer_limits.max_minimum_depth {
2162                         return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", peer_limits.max_minimum_depth, msg.minimum_depth)));
2163                 }
2164
2165                 if let Some(ty) = &msg.channel_type {
2166                         if *ty != self.channel_type {
2167                                 return Err(ChannelError::Close("Channel Type in accept_channel didn't match the one sent in open_channel.".to_owned()));
2168                         }
2169                 } else if their_features.supports_channel_type() {
2170                         // Assume they've accepted the channel type as they said they understand it.
2171                 } else {
2172                         let channel_type = ChannelTypeFeatures::from_init(&their_features);
2173                         if channel_type != ChannelTypeFeatures::only_static_remote_key() {
2174                                 return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
2175                         }
2176                         self.channel_type = channel_type;
2177                 }
2178
2179                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
2180                         match &msg.shutdown_scriptpubkey {
2181                                 &OptionalField::Present(ref script) => {
2182                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
2183                                         if script.len() == 0 {
2184                                                 None
2185                                         } else {
2186                                                 if !script::is_bolt2_compliant(&script, their_features) {
2187                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
2188                                                 }
2189                                                 Some(script.clone())
2190                                         }
2191                                 },
2192                                 // 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
2193                                 &OptionalField::Absent => {
2194                                         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()));
2195                                 }
2196                         }
2197                 } else { None };
2198
2199                 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
2200                 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
2201                 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
2202                 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
2203                 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
2204
2205                 if peer_limits.trust_own_funding_0conf {
2206                         self.minimum_depth = Some(msg.minimum_depth);
2207                 } else {
2208                         self.minimum_depth = Some(cmp::max(1, msg.minimum_depth));
2209                 }
2210
2211                 let counterparty_pubkeys = ChannelPublicKeys {
2212                         funding_pubkey: msg.funding_pubkey,
2213                         revocation_basepoint: msg.revocation_basepoint,
2214                         payment_point: msg.payment_point,
2215                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
2216                         htlc_basepoint: msg.htlc_basepoint
2217                 };
2218
2219                 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
2220                         selected_contest_delay: msg.to_self_delay,
2221                         pubkeys: counterparty_pubkeys,
2222                 });
2223
2224                 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
2225                 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
2226
2227                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
2228                 self.inbound_handshake_limits_override = None; // We're done enforcing limits on our peer's handshake now.
2229
2230                 Ok(())
2231         }
2232
2233         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
2234                 let funding_script = self.get_funding_redeemscript();
2235
2236                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number);
2237                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).tx;
2238                 {
2239                         let trusted_tx = initial_commitment_tx.trust();
2240                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
2241                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2242                         // They sign the holder commitment transaction...
2243                         log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
2244                                 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
2245                                 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
2246                                 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2247                         secp_check!(self.secp_ctx.verify_ecdsa(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
2248                 }
2249
2250                 let counterparty_keys = self.build_remote_transaction_keys();
2251                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
2252
2253                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
2254                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
2255                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
2256                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
2257
2258                 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.secp_ctx)
2259                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
2260
2261                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
2262                 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
2263         }
2264
2265         fn counterparty_funding_pubkey(&self) -> &PublicKey {
2266                 &self.get_counterparty_pubkeys().funding_pubkey
2267         }
2268
2269         pub fn funding_created<SP: Deref, L: Deref>(
2270                 &mut self, msg: &msgs::FundingCreated, best_block: BestBlock, signer_provider: &SP, logger: &L
2271         ) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError>
2272         where
2273                 SP::Target: SignerProvider<Signer = Signer>,
2274                 L::Target: Logger
2275         {
2276                 if self.is_outbound() {
2277                         return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
2278                 }
2279                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2280                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
2281                         // remember the channel, so it's safe to just send an error_message here and drop the
2282                         // channel.
2283                         return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
2284                 }
2285                 if self.inbound_awaiting_accept {
2286                         return Err(ChannelError::Close("FundingCreated message received before the channel was accepted".to_owned()));
2287                 }
2288                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
2289                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2290                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2291                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2292                 }
2293
2294                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
2295                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
2296                 // This is an externally observable change before we finish all our checks.  In particular
2297                 // funding_created_signature may fail.
2298                 self.holder_signer.provide_channel_parameters(&self.channel_transaction_parameters);
2299
2300                 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
2301                         Ok(res) => res,
2302                         Err(ChannelError::Close(e)) => {
2303                                 self.channel_transaction_parameters.funding_outpoint = None;
2304                                 return Err(ChannelError::Close(e));
2305                         },
2306                         Err(e) => {
2307                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
2308                                 // to make sure we don't continue with an inconsistent state.
2309                                 panic!("unexpected error type from funding_created_signature {:?}", e);
2310                         }
2311                 };
2312
2313                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2314                         initial_commitment_tx,
2315                         msg.signature,
2316                         Vec::new(),
2317                         &self.get_holder_pubkeys().funding_pubkey,
2318                         self.counterparty_funding_pubkey()
2319                 );
2320
2321                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, Vec::new())
2322                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
2323
2324                 // Now that we're past error-generating stuff, update our local state:
2325
2326                 let funding_redeemscript = self.get_funding_redeemscript();
2327                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
2328                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
2329                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
2330                 let mut monitor_signer = signer_provider.derive_channel_signer(self.channel_value_satoshis, self.channel_keys_id);
2331                 monitor_signer.provide_channel_parameters(&self.channel_transaction_parameters);
2332                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), monitor_signer,
2333                                                           shutdown_script, self.get_holder_selected_contest_delay(),
2334                                                           &self.destination_script, (funding_txo, funding_txo_script.clone()),
2335                                                           &self.channel_transaction_parameters,
2336                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
2337                                                           obscure_factor,
2338                                                           holder_commitment_tx, best_block, self.counterparty_node_id);
2339
2340                 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);
2341
2342                 self.channel_state = ChannelState::FundingSent as u32;
2343                 self.channel_id = funding_txo.to_channel_id();
2344                 self.cur_counterparty_commitment_transaction_number -= 1;
2345                 self.cur_holder_commitment_transaction_number -= 1;
2346
2347                 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
2348
2349                 let need_channel_ready = self.check_get_channel_ready(0).is_some();
2350                 self.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
2351
2352                 Ok((msgs::FundingSigned {
2353                         channel_id: self.channel_id,
2354                         signature
2355                 }, channel_monitor))
2356         }
2357
2358         /// Handles a funding_signed message from the remote end.
2359         /// If this call is successful, broadcast the funding transaction (and not before!)
2360         pub fn funding_signed<SP: Deref, L: Deref>(
2361                 &mut self, msg: &msgs::FundingSigned, best_block: BestBlock, signer_provider: &SP, logger: &L
2362         ) -> Result<ChannelMonitor<Signer>, ChannelError>
2363         where
2364                 SP::Target: SignerProvider<Signer = Signer>,
2365                 L::Target: Logger
2366         {
2367                 if !self.is_outbound() {
2368                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
2369                 }
2370                 if self.channel_state & !(ChannelState::MonitorUpdateInProgress as u32) != ChannelState::FundingCreated as u32 {
2371                         return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
2372                 }
2373                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
2374                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2375                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2376                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2377                 }
2378
2379                 let funding_script = self.get_funding_redeemscript();
2380
2381                 let counterparty_keys = self.build_remote_transaction_keys();
2382                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
2383                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
2384                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
2385
2386                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
2387                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
2388
2389                 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number);
2390                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).tx;
2391                 {
2392                         let trusted_tx = initial_commitment_tx.trust();
2393                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
2394                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2395                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
2396                         if let Err(_) = self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
2397                                 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
2398                         }
2399                 }
2400
2401                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2402                         initial_commitment_tx,
2403                         msg.signature,
2404                         Vec::new(),
2405                         &self.get_holder_pubkeys().funding_pubkey,
2406                         self.counterparty_funding_pubkey()
2407                 );
2408
2409                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, Vec::new())
2410                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
2411
2412
2413                 let funding_redeemscript = self.get_funding_redeemscript();
2414                 let funding_txo = self.get_funding_txo().unwrap();
2415                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
2416                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
2417                 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
2418                 let mut monitor_signer = signer_provider.derive_channel_signer(self.channel_value_satoshis, self.channel_keys_id);
2419                 monitor_signer.provide_channel_parameters(&self.channel_transaction_parameters);
2420                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), monitor_signer,
2421                                                           shutdown_script, self.get_holder_selected_contest_delay(),
2422                                                           &self.destination_script, (funding_txo, funding_txo_script),
2423                                                           &self.channel_transaction_parameters,
2424                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
2425                                                           obscure_factor,
2426                                                           holder_commitment_tx, best_block, self.counterparty_node_id);
2427
2428                 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);
2429
2430                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateInProgress as u32), 0); // We have no had any monitor(s) yet to fail update!
2431                 self.channel_state = ChannelState::FundingSent as u32;
2432                 self.cur_holder_commitment_transaction_number -= 1;
2433                 self.cur_counterparty_commitment_transaction_number -= 1;
2434
2435                 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
2436
2437                 let need_channel_ready = self.check_get_channel_ready(0).is_some();
2438                 self.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
2439                 Ok(channel_monitor)
2440         }
2441
2442         /// Handles a channel_ready message from our peer. If we've already sent our channel_ready
2443         /// and the channel is now usable (and public), this may generate an announcement_signatures to
2444         /// reply with.
2445         pub fn channel_ready<NS: Deref, L: Deref>(
2446                 &mut self, msg: &msgs::ChannelReady, node_signer: &NS, genesis_block_hash: BlockHash,
2447                 user_config: &UserConfig, best_block: &BestBlock, logger: &L
2448         ) -> Result<Option<msgs::AnnouncementSignatures>, ChannelError>
2449         where
2450                 NS::Target: NodeSigner,
2451                 L::Target: Logger
2452         {
2453                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2454                         self.workaround_lnd_bug_4006 = Some(msg.clone());
2455                         return Err(ChannelError::Ignore("Peer sent channel_ready when we needed a channel_reestablish. The peer is likely lnd, see https://github.com/lightningnetwork/lnd/issues/4006".to_owned()));
2456                 }
2457
2458                 if let Some(scid_alias) = msg.short_channel_id_alias {
2459                         if Some(scid_alias) != self.short_channel_id {
2460                                 // The scid alias provided can be used to route payments *from* our counterparty,
2461                                 // i.e. can be used for inbound payments and provided in invoices, but is not used
2462                                 // when routing outbound payments.
2463                                 self.latest_inbound_scid_alias = Some(scid_alias);
2464                         }
2465                 }
2466
2467                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2468
2469                 if non_shutdown_state == ChannelState::FundingSent as u32 {
2470                         self.channel_state |= ChannelState::TheirChannelReady as u32;
2471                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurChannelReady as u32) {
2472                         self.channel_state = ChannelState::ChannelReady as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2473                         self.update_time_counter += 1;
2474                 } else if self.channel_state & (ChannelState::ChannelReady as u32) != 0 ||
2475                         // If we reconnected before sending our `channel_ready` they may still resend theirs:
2476                         (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32) ==
2477                                               (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32))
2478                 {
2479                         // They probably disconnected/reconnected and re-sent the channel_ready, which is
2480                         // required, or they're sending a fresh SCID alias.
2481                         let expected_point =
2482                                 if self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
2483                                         // If they haven't ever sent an updated point, the point they send should match
2484                                         // the current one.
2485                                         self.counterparty_cur_commitment_point
2486                                 } else {
2487                                         // If they have sent updated points, channel_ready is always supposed to match
2488                                         // their "first" point, which we re-derive here.
2489                                         Some(PublicKey::from_secret_key(&self.secp_ctx, &SecretKey::from_slice(
2490                                                         &self.commitment_secrets.get_secret(INITIAL_COMMITMENT_NUMBER - 1).expect("We should have all prev secrets available")
2491                                                 ).expect("We already advanced, so previous secret keys should have been validated already")))
2492                                 };
2493                         if expected_point != Some(msg.next_per_commitment_point) {
2494                                 return Err(ChannelError::Close("Peer sent a reconnect channel_ready with a different point".to_owned()));
2495                         }
2496                         return Ok(None);
2497                 } else {
2498                         return Err(ChannelError::Close("Peer sent a channel_ready at a strange time".to_owned()));
2499                 }
2500
2501                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2502                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2503
2504                 log_info!(logger, "Received channel_ready from peer for channel {}", log_bytes!(self.channel_id()));
2505
2506                 Ok(self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, best_block.height(), logger))
2507         }
2508
2509         /// Returns transaction if there is pending funding transaction that is yet to broadcast
2510         pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
2511                 if self.channel_state & (ChannelState::FundingCreated as u32) != 0 {
2512                         self.funding_transaction.clone()
2513                 } else {
2514                         None
2515                 }
2516         }
2517
2518         /// Returns a HTLCStats about inbound pending htlcs
2519         fn get_inbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2520                 let mut stats = HTLCStats {
2521                         pending_htlcs: self.pending_inbound_htlcs.len() as u32,
2522                         pending_htlcs_value_msat: 0,
2523                         on_counterparty_tx_dust_exposure_msat: 0,
2524                         on_holder_tx_dust_exposure_msat: 0,
2525                         holding_cell_msat: 0,
2526                         on_holder_tx_holding_cell_htlcs_count: 0,
2527                 };
2528
2529                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if self.opt_anchors() {
2530                         (0, 0)
2531                 } else {
2532                         let dust_buffer_feerate = self.get_dust_buffer_feerate(outbound_feerate_update) as u64;
2533                         (dust_buffer_feerate * htlc_timeout_tx_weight(false) / 1000,
2534                                 dust_buffer_feerate * htlc_success_tx_weight(false) / 1000)
2535                 };
2536                 let counterparty_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.counterparty_dust_limit_satoshis;
2537                 let holder_dust_limit_success_sat = htlc_success_dust_limit + self.holder_dust_limit_satoshis;
2538                 for ref htlc in self.pending_inbound_htlcs.iter() {
2539                         stats.pending_htlcs_value_msat += htlc.amount_msat;
2540                         if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
2541                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2542                         }
2543                         if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
2544                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2545                         }
2546                 }
2547                 stats
2548         }
2549
2550         /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
2551         fn get_outbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2552                 let mut stats = HTLCStats {
2553                         pending_htlcs: self.pending_outbound_htlcs.len() as u32,
2554                         pending_htlcs_value_msat: 0,
2555                         on_counterparty_tx_dust_exposure_msat: 0,
2556                         on_holder_tx_dust_exposure_msat: 0,
2557                         holding_cell_msat: 0,
2558                         on_holder_tx_holding_cell_htlcs_count: 0,
2559                 };
2560
2561                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if self.opt_anchors() {
2562                         (0, 0)
2563                 } else {
2564                         let dust_buffer_feerate = self.get_dust_buffer_feerate(outbound_feerate_update) as u64;
2565                         (dust_buffer_feerate * htlc_timeout_tx_weight(false) / 1000,
2566                                 dust_buffer_feerate * htlc_success_tx_weight(false) / 1000)
2567                 };
2568                 let counterparty_dust_limit_success_sat = htlc_success_dust_limit + self.counterparty_dust_limit_satoshis;
2569                 let holder_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.holder_dust_limit_satoshis;
2570                 for ref htlc in self.pending_outbound_htlcs.iter() {
2571                         stats.pending_htlcs_value_msat += htlc.amount_msat;
2572                         if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
2573                                 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2574                         }
2575                         if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
2576                                 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2577                         }
2578                 }
2579
2580                 for update in self.holding_cell_htlc_updates.iter() {
2581                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
2582                                 stats.pending_htlcs += 1;
2583                                 stats.pending_htlcs_value_msat += amount_msat;
2584                                 stats.holding_cell_msat += amount_msat;
2585                                 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
2586                                         stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
2587                                 }
2588                                 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
2589                                         stats.on_holder_tx_dust_exposure_msat += amount_msat;
2590                                 } else {
2591                                         stats.on_holder_tx_holding_cell_htlcs_count += 1;
2592                                 }
2593                         }
2594                 }
2595                 stats
2596         }
2597
2598         /// Get the available balances, see [`AvailableBalances`]'s fields for more info.
2599         /// Doesn't bother handling the
2600         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
2601         /// corner case properly.
2602         pub fn get_available_balances(&self) -> AvailableBalances {
2603                 // Note that we have to handle overflow due to the above case.
2604                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
2605
2606                 let mut balance_msat = self.value_to_self_msat;
2607                 for ref htlc in self.pending_inbound_htlcs.iter() {
2608                         if let InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) = htlc.state {
2609                                 balance_msat += htlc.amount_msat;
2610                         }
2611                 }
2612                 balance_msat -= outbound_stats.pending_htlcs_value_msat;
2613
2614                 let outbound_capacity_msat = cmp::max(self.value_to_self_msat as i64
2615                                 - outbound_stats.pending_htlcs_value_msat as i64
2616                                 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
2617                         0) as u64;
2618                 AvailableBalances {
2619                         inbound_capacity_msat: cmp::max(self.channel_value_satoshis as i64 * 1000
2620                                         - self.value_to_self_msat as i64
2621                                         - self.get_inbound_pending_htlc_stats(None).pending_htlcs_value_msat as i64
2622                                         - self.holder_selected_channel_reserve_satoshis as i64 * 1000,
2623                                 0) as u64,
2624                         outbound_capacity_msat,
2625                         next_outbound_htlc_limit_msat: cmp::max(cmp::min(outbound_capacity_msat as i64,
2626                                         self.counterparty_max_htlc_value_in_flight_msat as i64
2627                                                 - outbound_stats.pending_htlcs_value_msat as i64),
2628                                 0) as u64,
2629                         balance_msat,
2630                 }
2631         }
2632
2633         pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
2634                 (self.holder_selected_channel_reserve_satoshis, self.counterparty_selected_channel_reserve_satoshis)
2635         }
2636
2637         // Get the fee cost in MSATS of a commitment tx with a given number of HTLC outputs.
2638         // Note that num_htlcs should not include dust HTLCs.
2639         fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2640                 // Note that we need to divide before multiplying to round properly,
2641                 // since the lowest denomination of bitcoin on-chain is the satoshi.
2642                 (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate_per_kw as u64 / 1000 * 1000
2643         }
2644
2645         // Get the fee cost in SATS of a commitment tx with a given number of HTLC outputs.
2646         // Note that num_htlcs should not include dust HTLCs.
2647         #[inline]
2648         fn commit_tx_fee_sat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2649                 feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
2650         }
2651
2652         // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
2653         // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
2654         // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2655         // are excluded.
2656         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2657                 assert!(self.is_outbound());
2658
2659                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if self.opt_anchors() {
2660                         (0, 0)
2661                 } else {
2662                         (self.feerate_per_kw as u64 * htlc_success_tx_weight(false) / 1000,
2663                                 self.feerate_per_kw as u64 * htlc_timeout_tx_weight(false) / 1000)
2664                 };
2665                 let real_dust_limit_success_sat = htlc_success_dust_limit + self.holder_dust_limit_satoshis;
2666                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.holder_dust_limit_satoshis;
2667
2668                 let mut addl_htlcs = 0;
2669                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2670                 match htlc.origin {
2671                         HTLCInitiator::LocalOffered => {
2672                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2673                                         addl_htlcs += 1;
2674                                 }
2675                         },
2676                         HTLCInitiator::RemoteOffered => {
2677                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2678                                         addl_htlcs += 1;
2679                                 }
2680                         }
2681                 }
2682
2683                 let mut included_htlcs = 0;
2684                 for ref htlc in self.pending_inbound_htlcs.iter() {
2685                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2686                                 continue
2687                         }
2688                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2689                         // transaction including this HTLC if it times out before they RAA.
2690                         included_htlcs += 1;
2691                 }
2692
2693                 for ref htlc in self.pending_outbound_htlcs.iter() {
2694                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2695                                 continue
2696                         }
2697                         match htlc.state {
2698                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2699                                 OutboundHTLCState::Committed => included_htlcs += 1,
2700                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2701                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2702                                 // transaction won't be generated until they send us their next RAA, which will mean
2703                                 // dropping any HTLCs in this state.
2704                                 _ => {},
2705                         }
2706                 }
2707
2708                 for htlc in self.holding_cell_htlc_updates.iter() {
2709                         match htlc {
2710                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2711                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
2712                                                 continue
2713                                         }
2714                                         included_htlcs += 1
2715                                 },
2716                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2717                                          // ack we're guaranteed to never include them in commitment txs anymore.
2718                         }
2719                 }
2720
2721                 let num_htlcs = included_htlcs + addl_htlcs;
2722                 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2723                 #[cfg(any(test, fuzzing))]
2724                 {
2725                         let mut fee = res;
2726                         if fee_spike_buffer_htlc.is_some() {
2727                                 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2728                         }
2729                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2730                                 + self.holding_cell_htlc_updates.len();
2731                         let commitment_tx_info = CommitmentTxInfoCached {
2732                                 fee,
2733                                 total_pending_htlcs,
2734                                 next_holder_htlc_id: match htlc.origin {
2735                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2736                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2737                                 },
2738                                 next_counterparty_htlc_id: match htlc.origin {
2739                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2740                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2741                                 },
2742                                 feerate: self.feerate_per_kw,
2743                         };
2744                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2745                 }
2746                 res
2747         }
2748
2749         // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2750         // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2751         // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2752         // excluded.
2753         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2754                 assert!(!self.is_outbound());
2755
2756                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if self.opt_anchors() {
2757                         (0, 0)
2758                 } else {
2759                         (self.feerate_per_kw as u64 * htlc_success_tx_weight(false) / 1000,
2760                                 self.feerate_per_kw as u64 * htlc_timeout_tx_weight(false) / 1000)
2761                 };
2762                 let real_dust_limit_success_sat = htlc_success_dust_limit + self.counterparty_dust_limit_satoshis;
2763                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.counterparty_dust_limit_satoshis;
2764
2765                 let mut addl_htlcs = 0;
2766                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2767                 match htlc.origin {
2768                         HTLCInitiator::LocalOffered => {
2769                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2770                                         addl_htlcs += 1;
2771                                 }
2772                         },
2773                         HTLCInitiator::RemoteOffered => {
2774                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2775                                         addl_htlcs += 1;
2776                                 }
2777                         }
2778                 }
2779
2780                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2781                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2782                 // committed outbound HTLCs, see below.
2783                 let mut included_htlcs = 0;
2784                 for ref htlc in self.pending_inbound_htlcs.iter() {
2785                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2786                                 continue
2787                         }
2788                         included_htlcs += 1;
2789                 }
2790
2791                 for ref htlc in self.pending_outbound_htlcs.iter() {
2792                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2793                                 continue
2794                         }
2795                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2796                         // i.e. if they've responded to us with an RAA after announcement.
2797                         match htlc.state {
2798                                 OutboundHTLCState::Committed => included_htlcs += 1,
2799                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2800                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2801                                 _ => {},
2802                         }
2803                 }
2804
2805                 let num_htlcs = included_htlcs + addl_htlcs;
2806                 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2807                 #[cfg(any(test, fuzzing))]
2808                 {
2809                         let mut fee = res;
2810                         if fee_spike_buffer_htlc.is_some() {
2811                                 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2812                         }
2813                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2814                         let commitment_tx_info = CommitmentTxInfoCached {
2815                                 fee,
2816                                 total_pending_htlcs,
2817                                 next_holder_htlc_id: match htlc.origin {
2818                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2819                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2820                                 },
2821                                 next_counterparty_htlc_id: match htlc.origin {
2822                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2823                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2824                                 },
2825                                 feerate: self.feerate_per_kw,
2826                         };
2827                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2828                 }
2829                 res
2830         }
2831
2832         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>
2833         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2834                 // We can't accept HTLCs sent after we've sent a shutdown.
2835                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelReady as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelReady as u32);
2836                 if local_sent_shutdown {
2837                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x4000|8);
2838                 }
2839                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2840                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelReady as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelReady as u32);
2841                 if remote_sent_shutdown {
2842                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2843                 }
2844                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2845                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2846                 }
2847                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2848                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2849                 }
2850                 if msg.amount_msat == 0 {
2851                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2852                 }
2853                 if msg.amount_msat < self.holder_htlc_minimum_msat {
2854                         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)));
2855                 }
2856
2857                 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
2858                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
2859                 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2860                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2861                 }
2862                 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
2863                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
2864                 }
2865                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2866                 // the reserve_satoshis we told them to always have as direct payment so that they lose
2867                 // something if we punish them for broadcasting an old state).
2868                 // Note that we don't really care about having a small/no to_remote output in our local
2869                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2870                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2871                 // present in the next commitment transaction we send them (at least for fulfilled ones,
2872                 // failed ones won't modify value_to_self).
2873                 // Note that we will send HTLCs which another instance of rust-lightning would think
2874                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2875                 // Channel state once they will not be present in the next received commitment
2876                 // transaction).
2877                 let mut removed_outbound_total_msat = 0;
2878                 for ref htlc in self.pending_outbound_htlcs.iter() {
2879                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
2880                                 removed_outbound_total_msat += htlc.amount_msat;
2881                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
2882                                 removed_outbound_total_msat += htlc.amount_msat;
2883                         }
2884                 }
2885
2886                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if self.opt_anchors() {
2887                         (0, 0)
2888                 } else {
2889                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
2890                         (dust_buffer_feerate * htlc_timeout_tx_weight(false) / 1000,
2891                                 dust_buffer_feerate * htlc_success_tx_weight(false) / 1000)
2892                 };
2893                 let exposure_dust_limit_timeout_sats = htlc_timeout_dust_limit + self.counterparty_dust_limit_satoshis;
2894                 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2895                         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;
2896                         if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2897                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2898                                         on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2899                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2900                         }
2901                 }
2902
2903                 let exposure_dust_limit_success_sats = htlc_success_dust_limit + self.holder_dust_limit_satoshis;
2904                 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2905                         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;
2906                         if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2907                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2908                                         on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2909                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2910                         }
2911                 }
2912
2913                 let pending_value_to_self_msat =
2914                         self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2915                 let pending_remote_value_msat =
2916                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2917                 if pending_remote_value_msat < msg.amount_msat {
2918                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2919                 }
2920
2921                 // Check that the remote can afford to pay for this HTLC on-chain at the current
2922                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2923                 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2924                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2925                         self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2926                 };
2927                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2928                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2929                 };
2930
2931                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < self.holder_selected_channel_reserve_satoshis * 1000 {
2932                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2933                 }
2934
2935                 if !self.is_outbound() {
2936                         // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2937                         // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2938                         // receiver's side, only on the sender's.
2939                         // Note that when we eventually remove support for fee updates and switch to anchor output
2940                         // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2941                         // the extra htlc when calculating the next remote commitment transaction fee as we should
2942                         // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2943                         // sensitive to fee spikes.
2944                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2945                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2946                         if pending_remote_value_msat - msg.amount_msat - self.holder_selected_channel_reserve_satoshis * 1000 < remote_fee_cost_incl_stuck_buffer_msat {
2947                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2948                                 // the HTLC, i.e. its status is already set to failing.
2949                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2950                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2951                         }
2952                 } else {
2953                         // Check that they won't violate our local required channel reserve by adding this HTLC.
2954                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2955                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2956                         if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2957                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2958                         }
2959                 }
2960                 if self.next_counterparty_htlc_id != msg.htlc_id {
2961                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2962                 }
2963                 if msg.cltv_expiry >= 500000000 {
2964                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2965                 }
2966
2967                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2968                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2969                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2970                         }
2971                 }
2972
2973                 // Now update local state:
2974                 self.next_counterparty_htlc_id += 1;
2975                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2976                         htlc_id: msg.htlc_id,
2977                         amount_msat: msg.amount_msat,
2978                         payment_hash: msg.payment_hash,
2979                         cltv_expiry: msg.cltv_expiry,
2980                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2981                 });
2982                 Ok(())
2983         }
2984
2985         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2986         #[inline]
2987         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentPreimage>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2988                 assert!(!(check_preimage.is_some() && fail_reason.is_some()), "cannot fail while we have a preimage");
2989                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2990                         if htlc.htlc_id == htlc_id {
2991                                 let outcome = match check_preimage {
2992                                         None => fail_reason.into(),
2993                                         Some(payment_preimage) => {
2994                                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
2995                                                 if payment_hash != htlc.payment_hash {
2996                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2997                                                 }
2998                                                 OutboundHTLCOutcome::Success(Some(payment_preimage))
2999                                         }
3000                                 };
3001                                 match htlc.state {
3002                                         OutboundHTLCState::LocalAnnounced(_) =>
3003                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
3004                                         OutboundHTLCState::Committed => {
3005                                                 htlc.state = OutboundHTLCState::RemoteRemoved(outcome);
3006                                         },
3007                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
3008                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
3009                                 }
3010                                 return Ok(htlc);
3011                         }
3012                 }
3013                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
3014         }
3015
3016         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
3017                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
3018                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
3019                 }
3020                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3021                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
3022                 }
3023
3024                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(msg.payment_preimage), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
3025         }
3026
3027         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
3028                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
3029                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
3030                 }
3031                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3032                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
3033                 }
3034
3035                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
3036                 Ok(())
3037         }
3038
3039         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
3040                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
3041                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
3042                 }
3043                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3044                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
3045                 }
3046
3047                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
3048                 Ok(())
3049         }
3050
3051         pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<&ChannelMonitorUpdate, ChannelError>
3052                 where L::Target: Logger
3053         {
3054                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
3055                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned()));
3056                 }
3057                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3058                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned()));
3059                 }
3060                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
3061                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned()));
3062                 }
3063
3064                 let funding_script = self.get_funding_redeemscript();
3065
3066                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number);
3067
3068                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
3069                 let commitment_txid = {
3070                         let trusted_tx = commitment_stats.tx.trust();
3071                         let bitcoin_tx = trusted_tx.built_transaction();
3072                         let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
3073
3074                         log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
3075                                 log_bytes!(msg.signature.serialize_compact()[..]),
3076                                 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
3077                                 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
3078                         if let Err(_) = self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
3079                                 return Err(ChannelError::Close("Invalid commitment tx signature from peer".to_owned()));
3080                         }
3081                         bitcoin_tx.txid
3082                 };
3083                 let mut htlcs_cloned: Vec<_> = commitment_stats.htlcs_included.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
3084
3085                 // If our counterparty updated the channel fee in this commitment transaction, check that
3086                 // they can actually afford the new fee now.
3087                 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
3088                         update_state == FeeUpdateState::RemoteAnnounced
3089                 } else { false };
3090                 if update_fee {
3091                         debug_assert!(!self.is_outbound());
3092                         let counterparty_reserve_we_require_msat = self.holder_selected_channel_reserve_satoshis * 1000;
3093                         if commitment_stats.remote_balance_msat < commitment_stats.total_fee_sat * 1000 + counterparty_reserve_we_require_msat {
3094                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned()));
3095                         }
3096                 }
3097                 #[cfg(any(test, fuzzing))]
3098                 {
3099                         if self.is_outbound() {
3100                                 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
3101                                 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
3102                                 if let Some(info) = projected_commit_tx_info {
3103                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
3104                                                 + self.holding_cell_htlc_updates.len();
3105                                         if info.total_pending_htlcs == total_pending_htlcs
3106                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
3107                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
3108                                                 && info.feerate == self.feerate_per_kw {
3109                                                         assert_eq!(commitment_stats.total_fee_sat, info.fee / 1000);
3110                                                 }
3111                                 }
3112                         }
3113                 }
3114
3115                 if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
3116                         return Err(ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs)));
3117                 }
3118
3119                 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
3120                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
3121                 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
3122                         if let Some(_) = htlc.transaction_output_index {
3123                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_stats.feerate_per_kw,
3124                                         self.get_counterparty_selected_contest_delay().unwrap(), &htlc, self.opt_anchors(),
3125                                         false, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
3126
3127                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &keys);
3128                                 let htlc_sighashtype = if self.opt_anchors() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
3129                                 let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
3130                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
3131                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
3132                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
3133                                 if let Err(_) = self.secp_ctx.verify_ecdsa(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
3134                                         return Err(ChannelError::Close("Invalid HTLC tx signature from peer".to_owned()));
3135                                 }
3136                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
3137                         } else {
3138                                 htlcs_and_sigs.push((htlc, None, source));
3139                         }
3140                 }
3141
3142                 let holder_commitment_tx = HolderCommitmentTransaction::new(
3143                         commitment_stats.tx,
3144                         msg.signature,
3145                         msg.htlc_signatures.clone(),
3146                         &self.get_holder_pubkeys().funding_pubkey,
3147                         self.counterparty_funding_pubkey()
3148                 );
3149
3150                 self.holder_signer.validate_holder_commitment(&holder_commitment_tx, commitment_stats.preimages)
3151                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
3152
3153                 // Update state now that we've passed all the can-fail calls...
3154                 let mut need_commitment = false;
3155                 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
3156                         if *update_state == FeeUpdateState::RemoteAnnounced {
3157                                 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
3158                                 need_commitment = true;
3159                         }
3160                 }
3161
3162                 self.latest_monitor_update_id += 1;
3163                 let mut monitor_update = ChannelMonitorUpdate {
3164                         update_id: self.latest_monitor_update_id,
3165                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
3166                                 commitment_tx: holder_commitment_tx,
3167                                 htlc_outputs: htlcs_and_sigs
3168                         }]
3169                 };
3170
3171                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3172                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
3173                                 Some(forward_info.clone())
3174                         } else { None };
3175                         if let Some(forward_info) = new_forward {
3176                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
3177                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
3178                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
3179                                 need_commitment = true;
3180                         }
3181                 }
3182                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3183                         if let &mut OutboundHTLCState::RemoteRemoved(ref mut outcome) = &mut htlc.state {
3184                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
3185                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
3186                                 // Grab the preimage, if it exists, instead of cloning
3187                                 let mut reason = OutboundHTLCOutcome::Success(None);
3188                                 mem::swap(outcome, &mut reason);
3189                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(reason);
3190                                 need_commitment = true;
3191                         }
3192                 }
3193
3194                 self.cur_holder_commitment_transaction_number -= 1;
3195                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
3196                 // build_commitment_no_status_check() next which will reset this to RAAFirst.
3197                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
3198
3199                 if (self.channel_state & ChannelState::MonitorUpdateInProgress as u32) != 0 {
3200                         // In case we initially failed monitor updating without requiring a response, we need
3201                         // to make sure the RAA gets sent first.
3202                         self.monitor_pending_revoke_and_ack = true;
3203                         if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
3204                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
3205                                 // the corresponding HTLC status updates so that get_last_commitment_update
3206                                 // includes the right HTLCs.
3207                                 self.monitor_pending_commitment_signed = true;
3208                                 let mut additional_update = self.build_commitment_no_status_check(logger);
3209                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
3210                                 // strictly increasing by one, so decrement it here.
3211                                 self.latest_monitor_update_id = monitor_update.update_id;
3212                                 monitor_update.updates.append(&mut additional_update.updates);
3213                         }
3214                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
3215                                 log_bytes!(self.channel_id));
3216                         self.pending_monitor_updates.push(monitor_update);
3217                         return Ok(self.pending_monitor_updates.last().unwrap());
3218                 }
3219
3220                 let need_commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
3221                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
3222                         // we'll send one right away when we get the revoke_and_ack when we
3223                         // free_holding_cell_htlcs().
3224                         let mut additional_update = self.build_commitment_no_status_check(logger);
3225                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
3226                         // strictly increasing by one, so decrement it here.
3227                         self.latest_monitor_update_id = monitor_update.update_id;
3228                         monitor_update.updates.append(&mut additional_update.updates);
3229                         true
3230                 } else { false };
3231
3232                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
3233                         log_bytes!(self.channel_id()), if need_commitment_signed { " our own commitment_signed and" } else { "" });
3234                 self.pending_monitor_updates.push(monitor_update);
3235                 self.monitor_updating_paused(true, need_commitment_signed, false, Vec::new(), Vec::new(), Vec::new());
3236                 return Ok(self.pending_monitor_updates.last().unwrap());
3237         }
3238
3239         /// Public version of the below, checking relevant preconditions first.
3240         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
3241         /// returns `(None, Vec::new())`.
3242         pub fn maybe_free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> (Option<&ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>) where L::Target: Logger {
3243                 if self.channel_state >= ChannelState::ChannelReady as u32 &&
3244                    (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32)) == 0 {
3245                         self.free_holding_cell_htlcs(logger)
3246                 } else { (None, Vec::new()) }
3247         }
3248
3249         /// Frees any pending commitment updates in the holding cell, generating the relevant messages
3250         /// for our counterparty.
3251         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> (Option<&ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>) where L::Target: Logger {
3252                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateInProgress as u32, 0);
3253                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
3254                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
3255                                 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
3256
3257                         let mut monitor_update = ChannelMonitorUpdate {
3258                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
3259                                 updates: Vec::new(),
3260                         };
3261
3262                         let mut htlc_updates = Vec::new();
3263                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
3264                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
3265                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
3266                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
3267                         let mut htlcs_to_fail = Vec::new();
3268                         for htlc_update in htlc_updates.drain(..) {
3269                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
3270                                 // fee races with adding too many outputs which push our total payments just over
3271                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
3272                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
3273                                 // to rebalance channels.
3274                                 match &htlc_update {
3275                                         &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
3276                                                 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone(), false, logger) {
3277                                                         Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
3278                                                         Err(e) => {
3279                                                                 match e {
3280                                                                         ChannelError::Ignore(ref msg) => {
3281                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
3282                                                                                         log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
3283                                                                                 // If we fail to send here, then this HTLC should
3284                                                                                 // be failed backwards. Failing to send here
3285                                                                                 // indicates that this HTLC may keep being put back
3286                                                                                 // into the holding cell without ever being
3287                                                                                 // successfully forwarded/failed/fulfilled, causing
3288                                                                                 // our counterparty to eventually close on us.
3289                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
3290                                                                         },
3291                                                                         _ => {
3292                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
3293                                                                         },
3294                                                                 }
3295                                                         }
3296                                                 }
3297                                         },
3298                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
3299                                                 // If an HTLC claim was previously added to the holding cell (via
3300                                                 // `get_update_fulfill_htlc`, then generating the claim message itself must
3301                                                 // not fail - any in between attempts to claim the HTLC will have resulted
3302                                                 // in it hitting the holding cell again and we cannot change the state of a
3303                                                 // holding cell HTLC from fulfill to anything else.
3304                                                 let (update_fulfill_msg_option, mut additional_monitor_update) =
3305                                                         if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
3306                                                                 (msg, monitor_update)
3307                                                         } else { unreachable!() };
3308                                                 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
3309                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
3310                                         },
3311                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
3312                                                 match self.fail_htlc(htlc_id, err_packet.clone(), false, logger) {
3313                                                         Ok(update_fail_msg_option) => {
3314                                                                 // If an HTLC failure was previously added to the holding cell (via
3315                                                                 // `queue_fail_htlc`) then generating the fail message itself must
3316                                                                 // not fail - we should never end up in a state where we double-fail
3317                                                                 // an HTLC or fail-then-claim an HTLC as it indicates we didn't wait
3318                                                                 // for a full revocation before failing.
3319                                                                 update_fail_htlcs.push(update_fail_msg_option.unwrap())
3320                                                         },
3321                                                         Err(e) => {
3322                                                                 if let ChannelError::Ignore(_) = e {}
3323                                                                 else {
3324                                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
3325                                                                 }
3326                                                         }
3327                                                 }
3328                                         },
3329                                 }
3330                         }
3331                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
3332                                 return (None, htlcs_to_fail);
3333                         }
3334                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
3335                                 self.send_update_fee(feerate, false, logger)
3336                         } else {
3337                                 None
3338                         };
3339
3340                         let mut additional_update = self.build_commitment_no_status_check(logger);
3341                         // build_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
3342                         // but we want them to be strictly increasing by one, so reset it here.
3343                         self.latest_monitor_update_id = monitor_update.update_id;
3344                         monitor_update.updates.append(&mut additional_update.updates);
3345
3346                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
3347                                 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
3348                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
3349
3350                         self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
3351                         self.pending_monitor_updates.push(monitor_update);
3352                         (Some(self.pending_monitor_updates.last().unwrap()), htlcs_to_fail)
3353                 } else {
3354                         (None, Vec::new())
3355                 }
3356         }
3357
3358         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
3359         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
3360         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
3361         /// generating an appropriate error *after* the channel state has been updated based on the
3362         /// revoke_and_ack message.
3363         pub fn revoke_and_ack<L: Deref>(&mut self, msg: &msgs::RevokeAndACK, logger: &L) -> Result<(Vec<(HTLCSource, PaymentHash)>, &ChannelMonitorUpdate), ChannelError>
3364                 where L::Target: Logger,
3365         {
3366                 if (self.channel_state & (ChannelState::ChannelReady as u32)) != (ChannelState::ChannelReady as u32) {
3367                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
3368                 }
3369                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3370                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
3371                 }
3372                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
3373                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
3374                 }
3375
3376                 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
3377
3378                 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
3379                         if PublicKey::from_secret_key(&self.secp_ctx, &secret) != counterparty_prev_commitment_point {
3380                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
3381                         }
3382                 }
3383
3384                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
3385                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
3386                         // haven't given them a new commitment transaction to broadcast). We should probably
3387                         // take advantage of this by updating our channel monitor, sending them an error, and
3388                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
3389                         // lot of work, and there's some chance this is all a misunderstanding anyway.
3390                         // We have to do *something*, though, since our signer may get mad at us for otherwise
3391                         // jumping a remote commitment number, so best to just force-close and move on.
3392                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
3393                 }
3394
3395                 #[cfg(any(test, fuzzing))]
3396                 {
3397                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
3398                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
3399                 }
3400
3401                 self.holder_signer.validate_counterparty_revocation(
3402                         self.cur_counterparty_commitment_transaction_number + 1,
3403                         &secret
3404                 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
3405
3406                 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
3407                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
3408                 self.latest_monitor_update_id += 1;
3409                 let mut monitor_update = ChannelMonitorUpdate {
3410                         update_id: self.latest_monitor_update_id,
3411                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
3412                                 idx: self.cur_counterparty_commitment_transaction_number + 1,
3413                                 secret: msg.per_commitment_secret,
3414                         }],
3415                 };
3416
3417                 // Update state now that we've passed all the can-fail calls...
3418                 // (note that we may still fail to generate the new commitment_signed message, but that's
3419                 // OK, we step the channel here and *then* if the new generation fails we can fail the
3420                 // channel based on that, but stepping stuff here should be safe either way.
3421                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
3422                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
3423                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
3424                 self.cur_counterparty_commitment_transaction_number -= 1;
3425
3426                 if self.announcement_sigs_state == AnnouncementSigsState::Committed {
3427                         self.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
3428                 }
3429
3430                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
3431                 let mut to_forward_infos = Vec::new();
3432                 let mut revoked_htlcs = Vec::new();
3433                 let mut finalized_claimed_htlcs = Vec::new();
3434                 let mut update_fail_htlcs = Vec::new();
3435                 let mut update_fail_malformed_htlcs = Vec::new();
3436                 let mut require_commitment = false;
3437                 let mut value_to_self_msat_diff: i64 = 0;
3438
3439                 {
3440                         // Take references explicitly so that we can hold multiple references to self.
3441                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
3442                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
3443
3444                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
3445                         pending_inbound_htlcs.retain(|htlc| {
3446                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3447                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
3448                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
3449                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
3450                                         }
3451                                         false
3452                                 } else { true }
3453                         });
3454                         pending_outbound_htlcs.retain(|htlc| {
3455                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
3456                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
3457                                         if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
3458                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
3459                                         } else {
3460                                                 finalized_claimed_htlcs.push(htlc.source.clone());
3461                                                 // They fulfilled, so we sent them money
3462                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
3463                                         }
3464                                         false
3465                                 } else { true }
3466                         });
3467                         for htlc in pending_inbound_htlcs.iter_mut() {
3468                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
3469                                         true
3470                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
3471                                         true
3472                                 } else { false };
3473                                 if swap {
3474                                         let mut state = InboundHTLCState::Committed;
3475                                         mem::swap(&mut state, &mut htlc.state);
3476
3477                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
3478                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
3479                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
3480                                                 require_commitment = true;
3481                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
3482                                                 match forward_info {
3483                                                         PendingHTLCStatus::Fail(fail_msg) => {
3484                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
3485                                                                 require_commitment = true;
3486                                                                 match fail_msg {
3487                                                                         HTLCFailureMsg::Relay(msg) => {
3488                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
3489                                                                                 update_fail_htlcs.push(msg)
3490                                                                         },
3491                                                                         HTLCFailureMsg::Malformed(msg) => {
3492                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
3493                                                                                 update_fail_malformed_htlcs.push(msg)
3494                                                                         },
3495                                                                 }
3496                                                         },
3497                                                         PendingHTLCStatus::Forward(forward_info) => {
3498                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
3499                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
3500                                                                 htlc.state = InboundHTLCState::Committed;
3501                                                         }
3502                                                 }
3503                                         }
3504                                 }
3505                         }
3506                         for htlc in pending_outbound_htlcs.iter_mut() {
3507                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3508                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
3509                                         htlc.state = OutboundHTLCState::Committed;
3510                                 }
3511                                 if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
3512                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
3513                                         // Grab the preimage, if it exists, instead of cloning
3514                                         let mut reason = OutboundHTLCOutcome::Success(None);
3515                                         mem::swap(outcome, &mut reason);
3516                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
3517                                         require_commitment = true;
3518                                 }
3519                         }
3520                 }
3521                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
3522
3523                 if let Some((feerate, update_state)) = self.pending_update_fee {
3524                         match update_state {
3525                                 FeeUpdateState::Outbound => {
3526                                         debug_assert!(self.is_outbound());
3527                                         log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
3528                                         self.feerate_per_kw = feerate;
3529                                         self.pending_update_fee = None;
3530                                 },
3531                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
3532                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
3533                                         debug_assert!(!self.is_outbound());
3534                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
3535                                         require_commitment = true;
3536                                         self.feerate_per_kw = feerate;
3537                                         self.pending_update_fee = None;
3538                                 },
3539                         }
3540                 }
3541
3542                 if (self.channel_state & ChannelState::MonitorUpdateInProgress as u32) == ChannelState::MonitorUpdateInProgress as u32 {
3543                         // We can't actually generate a new commitment transaction (incl by freeing holding
3544                         // cells) while we can't update the monitor, so we just return what we have.
3545                         if require_commitment {
3546                                 self.monitor_pending_commitment_signed = true;
3547                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
3548                                 // which does not update state, but we're definitely now awaiting a remote revoke
3549                                 // before we can step forward any more, so set it here.
3550                                 let mut additional_update = self.build_commitment_no_status_check(logger);
3551                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
3552                                 // strictly increasing by one, so decrement it here.
3553                                 self.latest_monitor_update_id = monitor_update.update_id;
3554                                 monitor_update.updates.append(&mut additional_update.updates);
3555                         }
3556                         self.monitor_pending_forwards.append(&mut to_forward_infos);
3557                         self.monitor_pending_failures.append(&mut revoked_htlcs);
3558                         self.monitor_pending_finalized_fulfills.append(&mut finalized_claimed_htlcs);
3559                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
3560                         self.pending_monitor_updates.push(monitor_update);
3561                         return Ok((Vec::new(), self.pending_monitor_updates.last().unwrap()));
3562                 }
3563
3564                 match self.free_holding_cell_htlcs(logger) {
3565                         (Some(_), htlcs_to_fail) => {
3566                                 let mut additional_update = self.pending_monitor_updates.pop().unwrap();
3567                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
3568                                 // strictly increasing by one, so decrement it here.
3569                                 self.latest_monitor_update_id = monitor_update.update_id;
3570                                 monitor_update.updates.append(&mut additional_update.updates);
3571
3572                                 self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
3573                                 self.pending_monitor_updates.push(monitor_update);
3574                                 Ok((htlcs_to_fail, self.pending_monitor_updates.last().unwrap()))
3575                         },
3576                         (None, htlcs_to_fail) => {
3577                                 if require_commitment {
3578                                         let mut additional_update = self.build_commitment_no_status_check(logger);
3579
3580                                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
3581                                         // strictly increasing by one, so decrement it here.
3582                                         self.latest_monitor_update_id = monitor_update.update_id;
3583                                         monitor_update.updates.append(&mut additional_update.updates);
3584
3585                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
3586                                                 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
3587                                         self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
3588                                         self.pending_monitor_updates.push(monitor_update);
3589                                         Ok((htlcs_to_fail, self.pending_monitor_updates.last().unwrap()))
3590                                 } else {
3591                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
3592                                         self.monitor_updating_paused(false, false, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
3593                                         self.pending_monitor_updates.push(monitor_update);
3594                                         Ok((htlcs_to_fail, self.pending_monitor_updates.last().unwrap()))
3595                                 }
3596                         }
3597                 }
3598         }
3599
3600         /// Queues up an outbound update fee by placing it in the holding cell. You should call
3601         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
3602         /// commitment update.
3603         pub fn queue_update_fee<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) where L::Target: Logger {
3604                 let msg_opt = self.send_update_fee(feerate_per_kw, true, logger);
3605                 assert!(msg_opt.is_none(), "We forced holding cell?");
3606         }
3607
3608         /// Adds a pending update to this channel. See the doc for send_htlc for
3609         /// further details on the optionness of the return value.
3610         /// If our balance is too low to cover the cost of the next commitment transaction at the
3611         /// new feerate, the update is cancelled.
3612         ///
3613         /// You MUST call [`Self::send_commitment_no_state_update`] prior to any other calls on this
3614         /// [`Channel`] if `force_holding_cell` is false.
3615         fn send_update_fee<L: Deref>(&mut self, feerate_per_kw: u32, mut force_holding_cell: bool, logger: &L) -> Option<msgs::UpdateFee> where L::Target: Logger {
3616                 if !self.is_outbound() {
3617                         panic!("Cannot send fee from inbound channel");
3618                 }
3619                 if !self.is_usable() {
3620                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
3621                 }
3622                 if !self.is_live() {
3623                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
3624                 }
3625
3626                 // Before proposing a feerate update, check that we can actually afford the new fee.
3627                 let inbound_stats = self.get_inbound_pending_htlc_stats(Some(feerate_per_kw));
3628                 let outbound_stats = self.get_outbound_pending_htlc_stats(Some(feerate_per_kw));
3629                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number);
3630                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
3631                 let buffer_fee_msat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, commitment_stats.num_nondust_htlcs + outbound_stats.on_holder_tx_holding_cell_htlcs_count as usize + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as usize, self.opt_anchors()) * 1000;
3632                 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
3633                 if holder_balance_msat < buffer_fee_msat  + self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 {
3634                         //TODO: auto-close after a number of failures?
3635                         log_debug!(logger, "Cannot afford to send new feerate at {}", feerate_per_kw);
3636                         return None;
3637                 }
3638
3639                 // Note, we evaluate pending htlc "preemptive" trimmed-to-dust threshold at the proposed `feerate_per_kw`.
3640                 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3641                 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3642                 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3643                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3644                         return None;
3645                 }
3646                 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3647                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3648                         return None;
3649                 }
3650
3651                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateInProgress as u32)) != 0 {
3652                         force_holding_cell = true;
3653                 }
3654
3655                 if force_holding_cell {
3656                         self.holding_cell_update_fee = Some(feerate_per_kw);
3657                         return None;
3658                 }
3659
3660                 debug_assert!(self.pending_update_fee.is_none());
3661                 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
3662
3663                 Some(msgs::UpdateFee {
3664                         channel_id: self.channel_id,
3665                         feerate_per_kw,
3666                 })
3667         }
3668
3669         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
3670         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
3671         /// resent.
3672         /// No further message handling calls may be made until a channel_reestablish dance has
3673         /// completed.
3674         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L)  where L::Target: Logger {
3675                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3676                 if self.channel_state < ChannelState::FundingSent as u32 {
3677                         self.channel_state = ChannelState::ShutdownComplete as u32;
3678                         return;
3679                 }
3680
3681                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == (ChannelState::PeerDisconnected as u32) {
3682                         // While the below code should be idempotent, it's simpler to just return early, as
3683                         // redundant disconnect events can fire, though they should be rare.
3684                         return;
3685                 }
3686
3687                 if self.announcement_sigs_state == AnnouncementSigsState::MessageSent || self.announcement_sigs_state == AnnouncementSigsState::Committed {
3688                         self.announcement_sigs_state = AnnouncementSigsState::NotSent;
3689                 }
3690
3691                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
3692                 // will be retransmitted.
3693                 self.last_sent_closing_fee = None;
3694                 self.pending_counterparty_closing_signed = None;
3695                 self.closing_fee_limits = None;
3696
3697                 let mut inbound_drop_count = 0;
3698                 self.pending_inbound_htlcs.retain(|htlc| {
3699                         match htlc.state {
3700                                 InboundHTLCState::RemoteAnnounced(_) => {
3701                                         // They sent us an update_add_htlc but we never got the commitment_signed.
3702                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
3703                                         // this HTLC accordingly
3704                                         inbound_drop_count += 1;
3705                                         false
3706                                 },
3707                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3708                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
3709                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3710                                         // in response to it yet, so don't touch it.
3711                                         true
3712                                 },
3713                                 InboundHTLCState::Committed => true,
3714                                 InboundHTLCState::LocalRemoved(_) => {
3715                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3716                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
3717                                         // (that we missed). Keep this around for now and if they tell us they missed
3718                                         // the commitment_signed we can re-transmit the update then.
3719                                         true
3720                                 },
3721                         }
3722                 });
3723                 self.next_counterparty_htlc_id -= inbound_drop_count;
3724
3725                 if let Some((_, update_state)) = self.pending_update_fee {
3726                         if update_state == FeeUpdateState::RemoteAnnounced {
3727                                 debug_assert!(!self.is_outbound());
3728                                 self.pending_update_fee = None;
3729                         }
3730                 }
3731
3732                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3733                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3734                                 // They sent us an update to remove this but haven't yet sent the corresponding
3735                                 // commitment_signed, we need to move it back to Committed and they can re-send
3736                                 // the update upon reconnection.
3737                                 htlc.state = OutboundHTLCState::Committed;
3738                         }
3739                 }
3740
3741                 self.channel_state |= ChannelState::PeerDisconnected as u32;
3742                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3743         }
3744
3745         /// Indicates that a ChannelMonitor update is in progress and has not yet been fully persisted.
3746         /// This must be called before we return the [`ChannelMonitorUpdate`] back to the
3747         /// [`ChannelManager`], which will call [`Self::monitor_updating_restored`] once the monitor
3748         /// update completes (potentially immediately).
3749         /// The messages which were generated with the monitor update must *not* have been sent to the
3750         /// remote end, and must instead have been dropped. They will be regenerated when
3751         /// [`Self::monitor_updating_restored`] is called.
3752         ///
3753         /// [`ChannelManager`]: super::channelmanager::ChannelManager
3754         /// [`chain::Watch`]: crate::chain::Watch
3755         /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3756         fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
3757                 resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
3758                 mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
3759                 mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
3760         ) {
3761                 self.monitor_pending_revoke_and_ack |= resend_raa;
3762                 self.monitor_pending_commitment_signed |= resend_commitment;
3763                 self.monitor_pending_channel_ready |= resend_channel_ready;
3764                 self.monitor_pending_forwards.append(&mut pending_forwards);
3765                 self.monitor_pending_failures.append(&mut pending_fails);
3766                 self.monitor_pending_finalized_fulfills.append(&mut pending_finalized_claimed_htlcs);
3767                 self.channel_state |= ChannelState::MonitorUpdateInProgress as u32;
3768         }
3769
3770         /// Indicates that the latest ChannelMonitor update has been committed by the client
3771         /// successfully and we should restore normal operation. Returns messages which should be sent
3772         /// to the remote side.
3773         pub fn monitor_updating_restored<L: Deref, NS: Deref>(
3774                 &mut self, logger: &L, node_signer: &NS, genesis_block_hash: BlockHash,
3775                 user_config: &UserConfig, best_block_height: u32
3776         ) -> MonitorRestoreUpdates
3777         where
3778                 L::Target: Logger,
3779                 NS::Target: NodeSigner
3780         {
3781                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateInProgress as u32, ChannelState::MonitorUpdateInProgress as u32);
3782                 self.channel_state &= !(ChannelState::MonitorUpdateInProgress as u32);
3783                 self.pending_monitor_updates.clear();
3784
3785                 // If we're past (or at) the FundingSent stage on an outbound channel, try to
3786                 // (re-)broadcast the funding transaction as we may have declined to broadcast it when we
3787                 // first received the funding_signed.
3788                 let mut funding_broadcastable =
3789                         if self.is_outbound() && self.channel_state & !MULTI_STATE_FLAGS >= ChannelState::FundingSent as u32 {
3790                                 self.funding_transaction.take()
3791                         } else { None };
3792                 // That said, if the funding transaction is already confirmed (ie we're active with a
3793                 // minimum_depth over 0) don't bother re-broadcasting the confirmed funding tx.
3794                 if self.channel_state & !MULTI_STATE_FLAGS >= ChannelState::ChannelReady as u32 && self.minimum_depth != Some(0) {
3795                         funding_broadcastable = None;
3796                 }
3797
3798                 // We will never broadcast the funding transaction when we're in MonitorUpdateInProgress
3799                 // (and we assume the user never directly broadcasts the funding transaction and waits for
3800                 // us to do it). Thus, we can only ever hit monitor_pending_channel_ready when we're
3801                 // * an inbound channel that failed to persist the monitor on funding_created and we got
3802                 //   the funding transaction confirmed before the monitor was persisted, or
3803                 // * a 0-conf channel and intended to send the channel_ready before any broadcast at all.
3804                 let channel_ready = if self.monitor_pending_channel_ready {
3805                         assert!(!self.is_outbound() || self.minimum_depth == Some(0),
3806                                 "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3807                         self.monitor_pending_channel_ready = false;
3808                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3809                         Some(msgs::ChannelReady {
3810                                 channel_id: self.channel_id(),
3811                                 next_per_commitment_point,
3812                                 short_channel_id_alias: Some(self.outbound_scid_alias),
3813                         })
3814                 } else { None };
3815
3816                 let announcement_sigs = self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, best_block_height, logger);
3817
3818                 let mut accepted_htlcs = Vec::new();
3819                 mem::swap(&mut accepted_htlcs, &mut self.monitor_pending_forwards);
3820                 let mut failed_htlcs = Vec::new();
3821                 mem::swap(&mut failed_htlcs, &mut self.monitor_pending_failures);
3822                 let mut finalized_claimed_htlcs = Vec::new();
3823                 mem::swap(&mut finalized_claimed_htlcs, &mut self.monitor_pending_finalized_fulfills);
3824
3825                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3826                         self.monitor_pending_revoke_and_ack = false;
3827                         self.monitor_pending_commitment_signed = false;
3828                         return MonitorRestoreUpdates {
3829                                 raa: None, commitment_update: None, order: RAACommitmentOrder::RevokeAndACKFirst,
3830                                 accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, channel_ready, announcement_sigs
3831                         };
3832                 }
3833
3834                 let raa = if self.monitor_pending_revoke_and_ack {
3835                         Some(self.get_last_revoke_and_ack())
3836                 } else { None };
3837                 let commitment_update = if self.monitor_pending_commitment_signed {
3838                         Some(self.get_last_commitment_update(logger))
3839                 } else { None };
3840
3841                 self.monitor_pending_revoke_and_ack = false;
3842                 self.monitor_pending_commitment_signed = false;
3843                 let order = self.resend_order.clone();
3844                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3845                         log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3846                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3847                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3848                 MonitorRestoreUpdates {
3849                         raa, commitment_update, order, accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, channel_ready, announcement_sigs
3850                 }
3851         }
3852
3853         pub fn update_fee<F: Deref, L: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::UpdateFee, logger: &L) -> Result<(), ChannelError>
3854                 where F::Target: FeeEstimator, L::Target: Logger
3855         {
3856                 if self.is_outbound() {
3857                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3858                 }
3859                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3860                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3861                 }
3862                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw, Some(self.feerate_per_kw), logger)?;
3863                 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate(None);
3864
3865                 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3866                 self.update_time_counter += 1;
3867                 // If the feerate has increased over the previous dust buffer (note that
3868                 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3869                 // won't be pushed over our dust exposure limit by the feerate increase.
3870                 if feerate_over_dust_buffer {
3871                         let inbound_stats = self.get_inbound_pending_htlc_stats(None);
3872                         let outbound_stats = self.get_outbound_pending_htlc_stats(None);
3873                         let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3874                         let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3875                         if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3876                                 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)",
3877                                         msg.feerate_per_kw, holder_tx_dust_exposure)));
3878                         }
3879                         if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3880                                 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)",
3881                                         msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3882                         }
3883                 }
3884                 Ok(())
3885         }
3886
3887         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3888                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3889                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3890                 msgs::RevokeAndACK {
3891                         channel_id: self.channel_id,
3892                         per_commitment_secret,
3893                         next_per_commitment_point,
3894                 }
3895         }
3896
3897         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3898                 let mut update_add_htlcs = Vec::new();
3899                 let mut update_fulfill_htlcs = Vec::new();
3900                 let mut update_fail_htlcs = Vec::new();
3901                 let mut update_fail_malformed_htlcs = Vec::new();
3902
3903                 for htlc in self.pending_outbound_htlcs.iter() {
3904                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3905                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
3906                                         channel_id: self.channel_id(),
3907                                         htlc_id: htlc.htlc_id,
3908                                         amount_msat: htlc.amount_msat,
3909                                         payment_hash: htlc.payment_hash,
3910                                         cltv_expiry: htlc.cltv_expiry,
3911                                         onion_routing_packet: (**onion_packet).clone(),
3912                                 });
3913                         }
3914                 }
3915
3916                 for htlc in self.pending_inbound_htlcs.iter() {
3917                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3918                                 match reason {
3919                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3920                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3921                                                         channel_id: self.channel_id(),
3922                                                         htlc_id: htlc.htlc_id,
3923                                                         reason: err_packet.clone()
3924                                                 });
3925                                         },
3926                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3927                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3928                                                         channel_id: self.channel_id(),
3929                                                         htlc_id: htlc.htlc_id,
3930                                                         sha256_of_onion: sha256_of_onion.clone(),
3931                                                         failure_code: failure_code.clone(),
3932                                                 });
3933                                         },
3934                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3935                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3936                                                         channel_id: self.channel_id(),
3937                                                         htlc_id: htlc.htlc_id,
3938                                                         payment_preimage: payment_preimage.clone(),
3939                                                 });
3940                                         },
3941                                 }
3942                         }
3943                 }
3944
3945                 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3946                         Some(msgs::UpdateFee {
3947                                 channel_id: self.channel_id(),
3948                                 feerate_per_kw: self.pending_update_fee.unwrap().0,
3949                         })
3950                 } else { None };
3951
3952                 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3953                                 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3954                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3955                 msgs::CommitmentUpdate {
3956                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3957                         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,
3958                 }
3959         }
3960
3961         /// May panic if some calls other than message-handling calls (which will all Err immediately)
3962         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3963         ///
3964         /// Some links printed in log lines are included here to check them during build (when run with
3965         /// `cargo doc --document-private-items`):
3966         /// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
3967         /// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
3968         pub fn channel_reestablish<L: Deref, NS: Deref>(
3969                 &mut self, msg: &msgs::ChannelReestablish, logger: &L, node_signer: &NS,
3970                 genesis_block_hash: BlockHash, user_config: &UserConfig, best_block: &BestBlock
3971         ) -> Result<ReestablishResponses, ChannelError>
3972         where
3973                 L::Target: Logger,
3974                 NS::Target: NodeSigner
3975         {
3976                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3977                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3978                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
3979                         // just close here instead of trying to recover.
3980                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3981                 }
3982
3983                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3984                         msg.next_local_commitment_number == 0 {
3985                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3986                 }
3987
3988                 if msg.next_remote_commitment_number > 0 {
3989                         match msg.data_loss_protect {
3990                                 OptionalField::Present(ref data_loss) => {
3991                                         let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3992                                         let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3993                                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3994                                         if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3995                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3996                                         }
3997                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3998                                                 macro_rules! log_and_panic {
3999                                                         ($err_msg: expr) => {
4000                                                                 log_error!(logger, $err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
4001                                                                 panic!($err_msg, log_bytes!(self.channel_id), log_pubkey!(self.counterparty_node_id));
4002                                                         }
4003                                                 }
4004                                                 log_and_panic!("We have fallen behind - we have received proof that if we broadcast our counterparty is going to claim all our funds.\n\
4005                                                         This implies you have restarted with lost ChannelMonitor and ChannelManager state, the first of which is a violation of the LDK chain::Watch requirements.\n\
4006                                                         More specifically, this means you have a bug in your implementation that can cause loss of funds, or you are running with an old backup, which is unsafe.\n\
4007                                                         If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
4008                                                         ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
4009                                                         ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
4010                                                         Note that due to a long-standing bug in lnd you may have to reach out to peers running lnd-based nodes to ask them to manually force-close channels\n\
4011                                                         See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
4012                                         }
4013                                 },
4014                                 OptionalField::Absent => {}
4015                         }
4016                 }
4017
4018                 // Before we change the state of the channel, we check if the peer is sending a very old
4019                 // commitment transaction number, if yes we send a warning message.
4020                 let our_commitment_transaction = INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number - 1;
4021                 if  msg.next_remote_commitment_number + 1 < our_commitment_transaction {
4022                         return Err(
4023                                 ChannelError::Warn(format!("Peer attempted to reestablish channel with a very old local commitment transaction: {} (received) vs {} (expected)", msg.next_remote_commitment_number, our_commitment_transaction))
4024                         );
4025                 }
4026
4027                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
4028                 // remaining cases either succeed or ErrorMessage-fail).
4029                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
4030
4031                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
4032                         assert!(self.shutdown_scriptpubkey.is_some());
4033                         Some(msgs::Shutdown {
4034                                 channel_id: self.channel_id,
4035                                 scriptpubkey: self.get_closing_scriptpubkey(),
4036                         })
4037                 } else { None };
4038
4039                 let announcement_sigs = self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, best_block.height(), logger);
4040
4041                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
4042                         // If we're waiting on a monitor update, we shouldn't re-send any channel_ready's.
4043                         if self.channel_state & (ChannelState::OurChannelReady as u32) == 0 ||
4044                                         self.channel_state & (ChannelState::MonitorUpdateInProgress as u32) != 0 {
4045                                 if msg.next_remote_commitment_number != 0 {
4046                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent channel_ready yet".to_owned()));
4047                                 }
4048                                 // Short circuit the whole handler as there is nothing we can resend them
4049                                 return Ok(ReestablishResponses {
4050                                         channel_ready: None,
4051                                         raa: None, commitment_update: None,
4052                                         order: RAACommitmentOrder::CommitmentFirst,
4053                                         shutdown_msg, announcement_sigs,
4054                                 });
4055                         }
4056
4057                         // We have OurChannelReady set!
4058                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4059                         return Ok(ReestablishResponses {
4060                                 channel_ready: Some(msgs::ChannelReady {
4061                                         channel_id: self.channel_id(),
4062                                         next_per_commitment_point,
4063                                         short_channel_id_alias: Some(self.outbound_scid_alias),
4064                                 }),
4065                                 raa: None, commitment_update: None,
4066                                 order: RAACommitmentOrder::CommitmentFirst,
4067                                 shutdown_msg, announcement_sigs,
4068                         });
4069                 }
4070
4071                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
4072                         // Remote isn't waiting on any RevokeAndACK from us!
4073                         // Note that if we need to repeat our ChannelReady we'll do that in the next if block.
4074                         None
4075                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
4076                         if self.channel_state & (ChannelState::MonitorUpdateInProgress as u32) != 0 {
4077                                 self.monitor_pending_revoke_and_ack = true;
4078                                 None
4079                         } else {
4080                                 Some(self.get_last_revoke_and_ack())
4081                         }
4082                 } else {
4083                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
4084                 };
4085
4086                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
4087                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
4088                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
4089                 // the corresponding revoke_and_ack back yet.
4090                 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 };
4091
4092                 let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
4093                         // We should never have to worry about MonitorUpdateInProgress resending ChannelReady
4094                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4095                         Some(msgs::ChannelReady {
4096                                 channel_id: self.channel_id(),
4097                                 next_per_commitment_point,
4098                                 short_channel_id_alias: Some(self.outbound_scid_alias),
4099                         })
4100                 } else { None };
4101
4102                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
4103                         if required_revoke.is_some() {
4104                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
4105                         } else {
4106                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
4107                         }
4108
4109                         Ok(ReestablishResponses {
4110                                 channel_ready, shutdown_msg, announcement_sigs,
4111                                 raa: required_revoke,
4112                                 commitment_update: None,
4113                                 order: self.resend_order.clone(),
4114                         })
4115                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
4116                         if required_revoke.is_some() {
4117                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
4118                         } else {
4119                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
4120                         }
4121
4122                         if self.channel_state & (ChannelState::MonitorUpdateInProgress as u32) != 0 {
4123                                 self.monitor_pending_commitment_signed = true;
4124                                 Ok(ReestablishResponses {
4125                                         channel_ready, shutdown_msg, announcement_sigs,
4126                                         commitment_update: None, raa: None,
4127                                         order: self.resend_order.clone(),
4128                                 })
4129                         } else {
4130                                 Ok(ReestablishResponses {
4131                                         channel_ready, shutdown_msg, announcement_sigs,
4132                                         raa: required_revoke,
4133                                         commitment_update: Some(self.get_last_commitment_update(logger)),
4134                                         order: self.resend_order.clone(),
4135                                 })
4136                         }
4137                 } else {
4138                         Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()))
4139                 }
4140         }
4141
4142         /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
4143         /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
4144         /// at which point they will be recalculated.
4145         fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>)
4146                 -> (u64, u64)
4147                 where F::Target: FeeEstimator
4148         {
4149                 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
4150
4151                 // Propose a range from our current Background feerate to our Normal feerate plus our
4152                 // force_close_avoidance_max_fee_satoshis.
4153                 // If we fail to come to consensus, we'll have to force-close.
4154                 let mut proposed_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Background);
4155                 let normal_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
4156                 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
4157
4158                 // The spec requires that (when the channel does not have anchors) we only send absolute
4159                 // channel fees no greater than the absolute channel fee on the current commitment
4160                 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
4161                 // very good reason to apply such a limit in any case. We don't bother doing so, risking
4162                 // some force-closure by old nodes, but we wanted to close the channel anyway.
4163
4164                 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
4165                         let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
4166                         proposed_feerate = cmp::max(proposed_feerate, min_feerate);
4167                         proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
4168                 }
4169
4170                 // Note that technically we could end up with a lower minimum fee if one sides' balance is
4171                 // below our dust limit, causing the output to disappear. We don't bother handling this
4172                 // case, however, as this should only happen if a channel is closed before any (material)
4173                 // payments have been made on it. This may cause slight fee overpayment and/or failure to
4174                 // come to consensus with our counterparty on appropriate fees, however it should be a
4175                 // relatively rare case. We can revisit this later, though note that in order to determine
4176                 // if the funders' output is dust we have to know the absolute fee we're going to use.
4177                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
4178                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
4179                 let proposed_max_total_fee_satoshis = if self.is_outbound() {
4180                                 // We always add force_close_avoidance_max_fee_satoshis to our normal
4181                                 // feerate-calculated fee, but allow the max to be overridden if we're using a
4182                                 // target feerate-calculated fee.
4183                                 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.options.force_close_avoidance_max_fee_satoshis,
4184                                         proposed_max_feerate as u64 * tx_weight / 1000)
4185                         } else {
4186                                 self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000
4187                         };
4188
4189                 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
4190                 self.closing_fee_limits.clone().unwrap()
4191         }
4192
4193         /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
4194         /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
4195         /// this point if we're the funder we should send the initial closing_signed, and in any case
4196         /// shutdown should complete within a reasonable timeframe.
4197         fn closing_negotiation_ready(&self) -> bool {
4198                 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
4199                         self.channel_state &
4200                                 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
4201                                  ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32)
4202                                 == BOTH_SIDES_SHUTDOWN_MASK &&
4203                         self.pending_update_fee.is_none()
4204         }
4205
4206         /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
4207         /// an Err if no progress is being made and the channel should be force-closed instead.
4208         /// Should be called on a one-minute timer.
4209         pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
4210                 if self.closing_negotiation_ready() {
4211                         if self.closing_signed_in_flight {
4212                                 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
4213                         } else {
4214                                 self.closing_signed_in_flight = true;
4215                         }
4216                 }
4217                 Ok(())
4218         }
4219
4220         pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(
4221                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
4222                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
4223                 where F::Target: FeeEstimator, L::Target: Logger
4224         {
4225                 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
4226                         return Ok((None, None));
4227                 }
4228
4229                 if !self.is_outbound() {
4230                         if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
4231                                 return self.closing_signed(fee_estimator, &msg);
4232                         }
4233                         return Ok((None, None));
4234                 }
4235
4236                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
4237
4238                 assert!(self.shutdown_scriptpubkey.is_some());
4239                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
4240                 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
4241                         our_min_fee, our_max_fee, total_fee_satoshis);
4242
4243                 let sig = self.holder_signer
4244                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
4245                         .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
4246
4247                 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
4248                 Ok((Some(msgs::ClosingSigned {
4249                         channel_id: self.channel_id,
4250                         fee_satoshis: total_fee_satoshis,
4251                         signature: sig,
4252                         fee_range: Some(msgs::ClosingSignedFeeRange {
4253                                 min_fee_satoshis: our_min_fee,
4254                                 max_fee_satoshis: our_max_fee,
4255                         }),
4256                 }), None))
4257         }
4258
4259         pub fn shutdown<SP: Deref>(
4260                 &mut self, signer_provider: &SP, their_features: &InitFeatures, msg: &msgs::Shutdown
4261         ) -> Result<(Option<msgs::Shutdown>, Option<&ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
4262         where SP::Target: SignerProvider
4263         {
4264                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
4265                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
4266                 }
4267                 if self.channel_state < ChannelState::FundingSent as u32 {
4268                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
4269                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
4270                         // can do that via error message without getting a connection fail anyway...
4271                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
4272                 }
4273                 for htlc in self.pending_inbound_htlcs.iter() {
4274                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4275                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
4276                         }
4277                 }
4278                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4279
4280                 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
4281                         return Err(ChannelError::Warn(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
4282                 }
4283
4284                 if self.counterparty_shutdown_scriptpubkey.is_some() {
4285                         if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
4286                                 return Err(ChannelError::Warn(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
4287                         }
4288                 } else {
4289                         self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
4290                 }
4291
4292                 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
4293                 // immediately after the commitment dance, but we can send a Shutdown because we won't send
4294                 // any further commitment updates after we set LocalShutdownSent.
4295                 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
4296
4297                 let update_shutdown_script = match self.shutdown_scriptpubkey {
4298                         Some(_) => false,
4299                         None => {
4300                                 assert!(send_shutdown);
4301                                 let shutdown_scriptpubkey = signer_provider.get_shutdown_scriptpubkey();
4302                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
4303                                         return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
4304                                 }
4305                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4306                                 true
4307                         },
4308                 };
4309
4310                 // From here on out, we may not fail!
4311
4312                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
4313                 self.update_time_counter += 1;
4314
4315                 let monitor_update = if update_shutdown_script {
4316                         self.latest_monitor_update_id += 1;
4317                         let monitor_update = ChannelMonitorUpdate {
4318                                 update_id: self.latest_monitor_update_id,
4319                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4320                                         scriptpubkey: self.get_closing_scriptpubkey(),
4321                                 }],
4322                         };
4323                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
4324                         self.pending_monitor_updates.push(monitor_update);
4325                         Some(self.pending_monitor_updates.last().unwrap())
4326                 } else { None };
4327                 let shutdown = if send_shutdown {
4328                         Some(msgs::Shutdown {
4329                                 channel_id: self.channel_id,
4330                                 scriptpubkey: self.get_closing_scriptpubkey(),
4331                         })
4332                 } else { None };
4333
4334                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
4335                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
4336                 // cell HTLCs and return them to fail the payment.
4337                 self.holding_cell_update_fee = None;
4338                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4339                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4340                         match htlc_update {
4341                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4342                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4343                                         false
4344                                 },
4345                                 _ => true
4346                         }
4347                 });
4348
4349                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4350                 self.update_time_counter += 1;
4351
4352                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4353         }
4354
4355         fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
4356                 let mut tx = closing_tx.trust().built_transaction().clone();
4357
4358                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
4359
4360                 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
4361                 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
4362                 let mut holder_sig = sig.serialize_der().to_vec();
4363                 holder_sig.push(EcdsaSighashType::All as u8);
4364                 let mut cp_sig = counterparty_sig.serialize_der().to_vec();
4365                 cp_sig.push(EcdsaSighashType::All as u8);
4366                 if funding_key[..] < counterparty_funding_key[..] {
4367                         tx.input[0].witness.push(holder_sig);
4368                         tx.input[0].witness.push(cp_sig);
4369                 } else {
4370                         tx.input[0].witness.push(cp_sig);
4371                         tx.input[0].witness.push(holder_sig);
4372                 }
4373
4374                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
4375                 tx
4376         }
4377
4378         pub fn closing_signed<F: Deref>(
4379                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::ClosingSigned)
4380                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
4381                 where F::Target: FeeEstimator
4382         {
4383                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
4384                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
4385                 }
4386                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
4387                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
4388                 }
4389                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
4390                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
4391                 }
4392                 if msg.fee_satoshis > TOTAL_BITCOIN_SUPPLY_SATOSHIS { // this is required to stop potential overflow in build_closing_transaction
4393                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
4394                 }
4395
4396                 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
4397                         return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
4398                 }
4399
4400                 if self.channel_state & ChannelState::MonitorUpdateInProgress as u32 != 0 {
4401                         self.pending_counterparty_closing_signed = Some(msg.clone());
4402                         return Ok((None, None));
4403                 }
4404
4405                 let funding_redeemscript = self.get_funding_redeemscript();
4406                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
4407                 if used_total_fee != msg.fee_satoshis {
4408                         return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee other than the value they can claim. Fee in message: {}. Actual closing tx fee: {}", msg.fee_satoshis, used_total_fee)));
4409                 }
4410                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
4411
4412                 match self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
4413                         Ok(_) => {},
4414                         Err(_e) => {
4415                                 // The remote end may have decided to revoke their output due to inconsistent dust
4416                                 // limits, so check for that case by re-checking the signature here.
4417                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
4418                                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
4419                                 secp_check!(self.secp_ctx.verify_ecdsa(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
4420                         },
4421                 };
4422
4423                 for outp in closing_tx.trust().built_transaction().output.iter() {
4424                         if !outp.script_pubkey.is_witness_program() && outp.value < MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS {
4425                                 return Err(ChannelError::Close("Remote sent us a closing_signed with a dust output. Always use segwit closing scripts!".to_owned()));
4426                         }
4427                 }
4428
4429                 assert!(self.shutdown_scriptpubkey.is_some());
4430                 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
4431                         if last_fee == msg.fee_satoshis {
4432                                 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
4433                                 self.channel_state = ChannelState::ShutdownComplete as u32;
4434                                 self.update_time_counter += 1;
4435                                 return Ok((None, Some(tx)));
4436                         }
4437                 }
4438
4439                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
4440
4441                 macro_rules! propose_fee {
4442                         ($new_fee: expr) => {
4443                                 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
4444                                         (closing_tx, $new_fee)
4445                                 } else {
4446                                         self.build_closing_transaction($new_fee, false)
4447                                 };
4448
4449                                 let sig = self.holder_signer
4450                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
4451                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
4452
4453                                 let signed_tx = if $new_fee == msg.fee_satoshis {
4454                                         self.channel_state = ChannelState::ShutdownComplete as u32;
4455                                         self.update_time_counter += 1;
4456                                         let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
4457                                         Some(tx)
4458                                 } else { None };
4459
4460                                 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
4461                                 return Ok((Some(msgs::ClosingSigned {
4462                                         channel_id: self.channel_id,
4463                                         fee_satoshis: used_fee,
4464                                         signature: sig,
4465                                         fee_range: Some(msgs::ClosingSignedFeeRange {
4466                                                 min_fee_satoshis: our_min_fee,
4467                                                 max_fee_satoshis: our_max_fee,
4468                                         }),
4469                                 }), signed_tx))
4470                         }
4471                 }
4472
4473                 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
4474                         if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
4475                                 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)));
4476                         }
4477                         if max_fee_satoshis < our_min_fee {
4478                                 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)));
4479                         }
4480                         if min_fee_satoshis > our_max_fee {
4481                                 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)));
4482                         }
4483
4484                         if !self.is_outbound() {
4485                                 // They have to pay, so pick the highest fee in the overlapping range.
4486                                 // We should never set an upper bound aside from their full balance
4487                                 debug_assert_eq!(our_max_fee, self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000);
4488                                 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
4489                         } else {
4490                                 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
4491                                         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.",
4492                                                 msg.fee_satoshis, our_min_fee, our_max_fee)));
4493                                 }
4494                                 // The proposed fee is in our acceptable range, accept it and broadcast!
4495                                 propose_fee!(msg.fee_satoshis);
4496                         }
4497                 } else {
4498                         // Old fee style negotiation. We don't bother to enforce whether they are complying
4499                         // with the "making progress" requirements, we just comply and hope for the best.
4500                         if let Some((last_fee, _)) = self.last_sent_closing_fee {
4501                                 if msg.fee_satoshis > last_fee {
4502                                         if msg.fee_satoshis < our_max_fee {
4503                                                 propose_fee!(msg.fee_satoshis);
4504                                         } else if last_fee < our_max_fee {
4505                                                 propose_fee!(our_max_fee);
4506                                         } else {
4507                                                 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)));
4508                                         }
4509                                 } else {
4510                                         if msg.fee_satoshis > our_min_fee {
4511                                                 propose_fee!(msg.fee_satoshis);
4512                                         } else if last_fee > our_min_fee {
4513                                                 propose_fee!(our_min_fee);
4514                                         } else {
4515                                                 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)));
4516                                         }
4517                                 }
4518                         } else {
4519                                 if msg.fee_satoshis < our_min_fee {
4520                                         propose_fee!(our_min_fee);
4521                                 } else if msg.fee_satoshis > our_max_fee {
4522                                         propose_fee!(our_max_fee);
4523                                 } else {
4524                                         propose_fee!(msg.fee_satoshis);
4525                                 }
4526                         }
4527                 }
4528         }
4529
4530         // Public utilities:
4531
4532         pub fn channel_id(&self) -> [u8; 32] {
4533                 self.channel_id
4534         }
4535
4536         pub fn minimum_depth(&self) -> Option<u32> {
4537                 self.minimum_depth
4538         }
4539
4540         /// Gets the "user_id" value passed into the construction of this channel. It has no special
4541         /// meaning and exists only to allow users to have a persistent identifier of a channel.
4542         pub fn get_user_id(&self) -> u128 {
4543                 self.user_id
4544         }
4545
4546         /// Gets the channel's type
4547         pub fn get_channel_type(&self) -> &ChannelTypeFeatures {
4548                 &self.channel_type
4549         }
4550
4551         /// Guaranteed to be Some after both ChannelReady messages have been exchanged (and, thus,
4552         /// is_usable() returns true).
4553         /// Allowed in any state (including after shutdown)
4554         pub fn get_short_channel_id(&self) -> Option<u64> {
4555                 self.short_channel_id
4556         }
4557
4558         /// Allowed in any state (including after shutdown)
4559         pub fn latest_inbound_scid_alias(&self) -> Option<u64> {
4560                 self.latest_inbound_scid_alias
4561         }
4562
4563         /// Allowed in any state (including after shutdown)
4564         pub fn outbound_scid_alias(&self) -> u64 {
4565                 self.outbound_scid_alias
4566         }
4567         /// Only allowed immediately after deserialization if get_outbound_scid_alias returns 0,
4568         /// indicating we were written by LDK prior to 0.0.106 which did not set outbound SCID aliases.
4569         pub fn set_outbound_scid_alias(&mut self, outbound_scid_alias: u64) {
4570                 assert_eq!(self.outbound_scid_alias, 0);
4571                 self.outbound_scid_alias = outbound_scid_alias;
4572         }
4573
4574         /// Returns the funding_txo we either got from our peer, or were given by
4575         /// get_outbound_funding_created.
4576         pub fn get_funding_txo(&self) -> Option<OutPoint> {
4577                 self.channel_transaction_parameters.funding_outpoint
4578         }
4579
4580         /// Returns the block hash in which our funding transaction was confirmed.
4581         pub fn get_funding_tx_confirmed_in(&self) -> Option<BlockHash> {
4582                 self.funding_tx_confirmed_in
4583         }
4584
4585         /// Returns the current number of confirmations on the funding transaction.
4586         pub fn get_funding_tx_confirmations(&self, height: u32) -> u32 {
4587                 if self.funding_tx_confirmation_height == 0 {
4588                         // We either haven't seen any confirmation yet, or observed a reorg.
4589                         return 0;
4590                 }
4591
4592                 height.checked_sub(self.funding_tx_confirmation_height).map_or(0, |c| c + 1)
4593         }
4594
4595         fn get_holder_selected_contest_delay(&self) -> u16 {
4596                 self.channel_transaction_parameters.holder_selected_contest_delay
4597         }
4598
4599         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
4600                 &self.channel_transaction_parameters.holder_pubkeys
4601         }
4602
4603         pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
4604                 self.channel_transaction_parameters.counterparty_parameters
4605                         .as_ref().map(|params| params.selected_contest_delay)
4606         }
4607
4608         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
4609                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
4610         }
4611
4612         /// Allowed in any state (including after shutdown)
4613         pub fn get_counterparty_node_id(&self) -> PublicKey {
4614                 self.counterparty_node_id
4615         }
4616
4617         /// Allowed in any state (including after shutdown)
4618         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
4619                 self.holder_htlc_minimum_msat
4620         }
4621
4622         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
4623         pub fn get_holder_htlc_maximum_msat(&self) -> Option<u64> {
4624                 self.get_htlc_maximum_msat(self.holder_max_htlc_value_in_flight_msat)
4625         }
4626
4627         /// Allowed in any state (including after shutdown)
4628         pub fn get_announced_htlc_max_msat(&self) -> u64 {
4629                 return cmp::min(
4630                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
4631                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
4632                         // channel might have been used to route very small values (either by honest users or as DoS).
4633                         self.channel_value_satoshis * 1000 * 9 / 10,
4634
4635                         self.counterparty_max_htlc_value_in_flight_msat
4636                 );
4637         }
4638
4639         /// Allowed in any state (including after shutdown)
4640         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
4641                 self.counterparty_htlc_minimum_msat
4642         }
4643
4644         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
4645         pub fn get_counterparty_htlc_maximum_msat(&self) -> Option<u64> {
4646                 self.get_htlc_maximum_msat(self.counterparty_max_htlc_value_in_flight_msat)
4647         }
4648
4649         fn get_htlc_maximum_msat(&self, party_max_htlc_value_in_flight_msat: u64) -> Option<u64> {
4650                 self.counterparty_selected_channel_reserve_satoshis.map(|counterparty_reserve| {
4651                         let holder_reserve = self.holder_selected_channel_reserve_satoshis;
4652                         cmp::min(
4653                                 (self.channel_value_satoshis - counterparty_reserve - holder_reserve) * 1000,
4654                                 party_max_htlc_value_in_flight_msat
4655                         )
4656                 })
4657         }
4658
4659         pub fn get_value_satoshis(&self) -> u64 {
4660                 self.channel_value_satoshis
4661         }
4662
4663         pub fn get_fee_proportional_millionths(&self) -> u32 {
4664                 self.config.options.forwarding_fee_proportional_millionths
4665         }
4666
4667         pub fn get_cltv_expiry_delta(&self) -> u16 {
4668                 cmp::max(self.config.options.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
4669         }
4670
4671         pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
4672                 self.config.options.max_dust_htlc_exposure_msat
4673         }
4674
4675         /// Returns the previous [`ChannelConfig`] applied to this channel, if any.
4676         pub fn prev_config(&self) -> Option<ChannelConfig> {
4677                 self.prev_config.map(|prev_config| prev_config.0)
4678         }
4679
4680         // Checks whether we should emit a `ChannelReady` event.
4681         pub(crate) fn should_emit_channel_ready_event(&mut self) -> bool {
4682                 self.is_usable() && !self.channel_ready_event_emitted
4683         }
4684
4685         // Remembers that we already emitted a `ChannelReady` event.
4686         pub(crate) fn set_channel_ready_event_emitted(&mut self) {
4687                 self.channel_ready_event_emitted = true;
4688         }
4689
4690         /// Tracks the number of ticks elapsed since the previous [`ChannelConfig`] was updated. Once
4691         /// [`EXPIRE_PREV_CONFIG_TICKS`] is reached, the previous config is considered expired and will
4692         /// no longer be considered when forwarding HTLCs.
4693         pub fn maybe_expire_prev_config(&mut self) {
4694                 if self.prev_config.is_none() {
4695                         return;
4696                 }
4697                 let prev_config = self.prev_config.as_mut().unwrap();
4698                 prev_config.1 += 1;
4699                 if prev_config.1 == EXPIRE_PREV_CONFIG_TICKS {
4700                         self.prev_config = None;
4701                 }
4702         }
4703
4704         /// Returns the current [`ChannelConfig`] applied to the channel.
4705         pub fn config(&self) -> ChannelConfig {
4706                 self.config.options
4707         }
4708
4709         /// Updates the channel's config. A bool is returned indicating whether the config update
4710         /// applied resulted in a new ChannelUpdate message.
4711         pub fn update_config(&mut self, config: &ChannelConfig) -> bool {
4712                 let did_channel_update =
4713                         self.config.options.forwarding_fee_proportional_millionths != config.forwarding_fee_proportional_millionths ||
4714                         self.config.options.forwarding_fee_base_msat != config.forwarding_fee_base_msat ||
4715                         self.config.options.cltv_expiry_delta != config.cltv_expiry_delta;
4716                 if did_channel_update {
4717                         self.prev_config = Some((self.config.options, 0));
4718                         // Update the counter, which backs the ChannelUpdate timestamp, to allow the relay
4719                         // policy change to propagate throughout the network.
4720                         self.update_time_counter += 1;
4721                 }
4722                 self.config.options = *config;
4723                 did_channel_update
4724         }
4725
4726         fn internal_htlc_satisfies_config(
4727                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32, config: &ChannelConfig,
4728         ) -> Result<(), (&'static str, u16)> {
4729                 let fee = amt_to_forward.checked_mul(config.forwarding_fee_proportional_millionths as u64)
4730                         .and_then(|prop_fee| (prop_fee / 1000000).checked_add(config.forwarding_fee_base_msat as u64));
4731                 if fee.is_none() || htlc.amount_msat < fee.unwrap() ||
4732                         (htlc.amount_msat - fee.unwrap()) < amt_to_forward {
4733                         return Err((
4734                                 "Prior hop has deviated from specified fees parameters or origin node has obsolete ones",
4735                                 0x1000 | 12, // fee_insufficient
4736                         ));
4737                 }
4738                 if (htlc.cltv_expiry as u64) < outgoing_cltv_value as u64 + config.cltv_expiry_delta as u64 {
4739                         return Err((
4740                                 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
4741                                 0x1000 | 13, // incorrect_cltv_expiry
4742                         ));
4743                 }
4744                 Ok(())
4745         }
4746
4747         /// Determines whether the parameters of an incoming HTLC to be forwarded satisfy the channel's
4748         /// [`ChannelConfig`]. This first looks at the channel's current [`ChannelConfig`], and if
4749         /// unsuccessful, falls back to the previous one if one exists.
4750         pub fn htlc_satisfies_config(
4751                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32,
4752         ) -> Result<(), (&'static str, u16)> {
4753                 self.internal_htlc_satisfies_config(&htlc, amt_to_forward, outgoing_cltv_value, &self.config())
4754                         .or_else(|err| {
4755                                 if let Some(prev_config) = self.prev_config() {
4756                                         self.internal_htlc_satisfies_config(htlc, amt_to_forward, outgoing_cltv_value, &prev_config)
4757                                 } else {
4758                                         Err(err)
4759                                 }
4760                         })
4761         }
4762
4763         pub fn get_feerate(&self) -> u32 {
4764                 self.feerate_per_kw
4765         }
4766
4767         pub fn get_dust_buffer_feerate(&self, outbound_feerate_update: Option<u32>) -> u32 {
4768                 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
4769                 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
4770                 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
4771                 // more dust balance if the feerate increases when we have several HTLCs pending
4772                 // which are near the dust limit.
4773                 let mut feerate_per_kw = self.feerate_per_kw;
4774                 // If there's a pending update fee, use it to ensure we aren't under-estimating
4775                 // potential feerate updates coming soon.
4776                 if let Some((feerate, _)) = self.pending_update_fee {
4777                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4778                 }
4779                 if let Some(feerate) = outbound_feerate_update {
4780                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4781                 }
4782                 cmp::max(2530, feerate_per_kw * 1250 / 1000)
4783         }
4784
4785         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
4786                 self.cur_holder_commitment_transaction_number + 1
4787         }
4788
4789         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
4790                 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
4791         }
4792
4793         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
4794                 self.cur_counterparty_commitment_transaction_number + 2
4795         }
4796
4797         #[cfg(test)]
4798         pub fn get_signer(&self) -> &Signer {
4799                 &self.holder_signer
4800         }
4801
4802         #[cfg(test)]
4803         pub fn get_value_stat(&self) -> ChannelValueStat {
4804                 ChannelValueStat {
4805                         value_to_self_msat: self.value_to_self_msat,
4806                         channel_value_msat: self.channel_value_satoshis * 1000,
4807                         channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
4808                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4809                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4810                         holding_cell_outbound_amount_msat: {
4811                                 let mut res = 0;
4812                                 for h in self.holding_cell_htlc_updates.iter() {
4813                                         match h {
4814                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
4815                                                         res += amount_msat;
4816                                                 }
4817                                                 _ => {}
4818                                         }
4819                                 }
4820                                 res
4821                         },
4822                         counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
4823                         counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
4824                 }
4825         }
4826
4827         /// Allowed in any state (including after shutdown)
4828         pub fn get_update_time_counter(&self) -> u32 {
4829                 self.update_time_counter
4830         }
4831
4832         pub fn get_latest_monitor_update_id(&self) -> u64 {
4833                 self.latest_monitor_update_id
4834         }
4835
4836         pub fn should_announce(&self) -> bool {
4837                 self.config.announced_channel
4838         }
4839
4840         pub fn is_outbound(&self) -> bool {
4841                 self.channel_transaction_parameters.is_outbound_from_holder
4842         }
4843
4844         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
4845         /// Allowed in any state (including after shutdown)
4846         pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
4847                 self.config.options.forwarding_fee_base_msat
4848         }
4849
4850         /// Returns true if we've ever received a message from the remote end for this Channel
4851         pub fn have_received_message(&self) -> bool {
4852                 self.channel_state > (ChannelState::OurInitSent as u32)
4853         }
4854
4855         /// Returns true if this channel is fully established and not known to be closing.
4856         /// Allowed in any state (including after shutdown)
4857         pub fn is_usable(&self) -> bool {
4858                 let mask = ChannelState::ChannelReady as u32 | BOTH_SIDES_SHUTDOWN_MASK;
4859                 (self.channel_state & mask) == (ChannelState::ChannelReady as u32) && !self.monitor_pending_channel_ready
4860         }
4861
4862         /// Returns true if this channel is currently available for use. This is a superset of
4863         /// is_usable() and considers things like the channel being temporarily disabled.
4864         /// Allowed in any state (including after shutdown)
4865         pub fn is_live(&self) -> bool {
4866                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
4867         }
4868
4869         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
4870         /// Allowed in any state (including after shutdown)
4871         pub fn is_awaiting_monitor_update(&self) -> bool {
4872                 (self.channel_state & ChannelState::MonitorUpdateInProgress as u32) != 0
4873         }
4874
4875         pub fn get_next_monitor_update(&self) -> Option<&ChannelMonitorUpdate> {
4876                 self.pending_monitor_updates.first()
4877         }
4878
4879         /// Returns true if funding_created was sent/received.
4880         pub fn is_funding_initiated(&self) -> bool {
4881                 self.channel_state >= ChannelState::FundingSent as u32
4882         }
4883
4884         /// Returns true if the channel is awaiting the persistence of the initial ChannelMonitor.
4885         /// If the channel is outbound, this implies we have not yet broadcasted the funding
4886         /// transaction. If the channel is inbound, this implies simply that the channel has not
4887         /// advanced state.
4888         pub fn is_awaiting_initial_mon_persist(&self) -> bool {
4889                 if !self.is_awaiting_monitor_update() { return false; }
4890                 if self.channel_state &
4891                         !(ChannelState::TheirChannelReady as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32)
4892                                 == ChannelState::FundingSent as u32 {
4893                         // If we're not a 0conf channel, we'll be waiting on a monitor update with only
4894                         // FundingSent set, though our peer could have sent their channel_ready.
4895                         debug_assert!(self.minimum_depth.unwrap_or(1) > 0);
4896                         return true;
4897                 }
4898                 if self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
4899                         self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
4900                         // If we're a 0-conf channel, we'll move beyond FundingSent immediately even while
4901                         // waiting for the initial monitor persistence. Thus, we check if our commitment
4902                         // transaction numbers have both been iterated only exactly once (for the
4903                         // funding_signed), and we're awaiting monitor update.
4904                         //
4905                         // If we got here, we shouldn't have yet broadcasted the funding transaction (as the
4906                         // only way to get an awaiting-monitor-update state during initial funding is if the
4907                         // initial monitor persistence is still pending).
4908                         //
4909                         // Because deciding we're awaiting initial broadcast spuriously could result in
4910                         // funds-loss (as we don't have a monitor, but have the funding transaction confirmed),
4911                         // we hard-assert here, even in production builds.
4912                         if self.is_outbound() { assert!(self.funding_transaction.is_some()); }
4913                         assert!(self.monitor_pending_channel_ready);
4914                         assert_eq!(self.latest_monitor_update_id, 0);
4915                         return true;
4916                 }
4917                 false
4918         }
4919
4920         /// Returns true if our channel_ready has been sent
4921         pub fn is_our_channel_ready(&self) -> bool {
4922                 (self.channel_state & ChannelState::OurChannelReady as u32) != 0 || self.channel_state >= ChannelState::ChannelReady as u32
4923         }
4924
4925         /// Returns true if our peer has either initiated or agreed to shut down the channel.
4926         pub fn received_shutdown(&self) -> bool {
4927                 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
4928         }
4929
4930         /// Returns true if we either initiated or agreed to shut down the channel.
4931         pub fn sent_shutdown(&self) -> bool {
4932                 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
4933         }
4934
4935         /// Returns true if this channel is fully shut down. True here implies that no further actions
4936         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
4937         /// will be handled appropriately by the chain monitor.
4938         pub fn is_shutdown(&self) -> bool {
4939                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
4940                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
4941                         true
4942                 } else { false }
4943         }
4944
4945         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
4946                 self.channel_update_status
4947         }
4948
4949         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
4950                 self.update_time_counter += 1;
4951                 self.channel_update_status = status;
4952         }
4953
4954         fn check_get_channel_ready(&mut self, height: u32) -> Option<msgs::ChannelReady> {
4955                 // Called:
4956                 //  * always when a new block/transactions are confirmed with the new height
4957                 //  * when funding is signed with a height of 0
4958                 if self.funding_tx_confirmation_height == 0 && self.minimum_depth != Some(0) {
4959                         return None;
4960                 }
4961
4962                 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4963                 if funding_tx_confirmations <= 0 {
4964                         self.funding_tx_confirmation_height = 0;
4965                 }
4966
4967                 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
4968                         return None;
4969                 }
4970
4971                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4972                 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
4973                         self.channel_state |= ChannelState::OurChannelReady as u32;
4974                         true
4975                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirChannelReady as u32) {
4976                         self.channel_state = ChannelState::ChannelReady as u32 | (self.channel_state & MULTI_STATE_FLAGS);
4977                         self.update_time_counter += 1;
4978                         true
4979                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurChannelReady as u32) {
4980                         // We got a reorg but not enough to trigger a force close, just ignore.
4981                         false
4982                 } else {
4983                         if self.funding_tx_confirmation_height != 0 && self.channel_state < ChannelState::ChannelReady as u32 {
4984                                 // We should never see a funding transaction on-chain until we've received
4985                                 // funding_signed (if we're an outbound channel), or seen funding_generated (if we're
4986                                 // an inbound channel - before that we have no known funding TXID). The fuzzer,
4987                                 // however, may do this and we shouldn't treat it as a bug.
4988                                 #[cfg(not(fuzzing))]
4989                                 panic!("Started confirming a channel in a state pre-FundingSent: {}.\n\
4990                                         Do NOT broadcast a funding transaction manually - let LDK do it for you!",
4991                                         self.channel_state);
4992                         }
4993                         // We got a reorg but not enough to trigger a force close, just ignore.
4994                         false
4995                 };
4996
4997                 if need_commitment_update {
4998                         if self.channel_state & (ChannelState::MonitorUpdateInProgress as u32) == 0 {
4999                                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
5000                                         let next_per_commitment_point =
5001                                                 self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &self.secp_ctx);
5002                                         return Some(msgs::ChannelReady {
5003                                                 channel_id: self.channel_id,
5004                                                 next_per_commitment_point,
5005                                                 short_channel_id_alias: Some(self.outbound_scid_alias),
5006                                         });
5007                                 }
5008                         } else {
5009                                 self.monitor_pending_channel_ready = true;
5010                         }
5011                 }
5012                 None
5013         }
5014
5015         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
5016         /// In the first case, we store the confirmation height and calculating the short channel id.
5017         /// In the second, we simply return an Err indicating we need to be force-closed now.
5018         pub fn transactions_confirmed<NS: Deref, L: Deref>(
5019                 &mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData,
5020                 genesis_block_hash: BlockHash, node_signer: &NS, user_config: &UserConfig, logger: &L
5021         ) -> Result<(Option<msgs::ChannelReady>, Option<msgs::AnnouncementSignatures>), ClosureReason>
5022         where
5023                 NS::Target: NodeSigner,
5024                 L::Target: Logger
5025         {
5026                 if let Some(funding_txo) = self.get_funding_txo() {
5027                         for &(index_in_block, tx) in txdata.iter() {
5028                                 // Check if the transaction is the expected funding transaction, and if it is,
5029                                 // check that it pays the right amount to the right script.
5030                                 if self.funding_tx_confirmation_height == 0 {
5031                                         if tx.txid() == funding_txo.txid {
5032                                                 let txo_idx = funding_txo.index as usize;
5033                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
5034                                                                 tx.output[txo_idx].value != self.channel_value_satoshis {
5035                                                         if self.is_outbound() {
5036                                                                 // If we generated the funding transaction and it doesn't match what it
5037                                                                 // should, the client is really broken and we should just panic and
5038                                                                 // tell them off. That said, because hash collisions happen with high
5039                                                                 // probability in fuzzing mode, if we're fuzzing we just close the
5040                                                                 // channel and move on.
5041                                                                 #[cfg(not(fuzzing))]
5042                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
5043                                                         }
5044                                                         self.update_time_counter += 1;
5045                                                         let err_reason = "funding tx had wrong script/value or output index";
5046                                                         return Err(ClosureReason::ProcessingError { err: err_reason.to_owned() });
5047                                                 } else {
5048                                                         if self.is_outbound() {
5049                                                                 for input in tx.input.iter() {
5050                                                                         if input.witness.is_empty() {
5051                                                                                 // We generated a malleable funding transaction, implying we've
5052                                                                                 // just exposed ourselves to funds loss to our counterparty.
5053                                                                                 #[cfg(not(fuzzing))]
5054                                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
5055                                                                         }
5056                                                                 }
5057                                                         }
5058                                                         self.funding_tx_confirmation_height = height;
5059                                                         self.funding_tx_confirmed_in = Some(*block_hash);
5060                                                         self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
5061                                                                 Ok(scid) => Some(scid),
5062                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
5063                                                         }
5064                                                 }
5065                                         }
5066                                         // If we allow 1-conf funding, we may need to check for channel_ready here and
5067                                         // send it immediately instead of waiting for a best_block_updated call (which
5068                                         // may have already happened for this block).
5069                                         if let Some(channel_ready) = self.check_get_channel_ready(height) {
5070                                                 log_info!(logger, "Sending a channel_ready to our peer for channel {}", log_bytes!(self.channel_id));
5071                                                 let announcement_sigs = self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, height, logger);
5072                                                 return Ok((Some(channel_ready), announcement_sigs));
5073                                         }
5074                                 }
5075                                 for inp in tx.input.iter() {
5076                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
5077                                                 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()));
5078                                                 return Err(ClosureReason::CommitmentTxConfirmed);
5079                                         }
5080                                 }
5081                         }
5082                 }
5083                 Ok((None, None))
5084         }
5085
5086         /// When a new block is connected, we check the height of the block against outbound holding
5087         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
5088         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
5089         /// handled by the ChannelMonitor.
5090         ///
5091         /// If we return Err, the channel may have been closed, at which point the standard
5092         /// requirements apply - no calls may be made except those explicitly stated to be allowed
5093         /// post-shutdown.
5094         ///
5095         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
5096         /// back.
5097         pub fn best_block_updated<NS: Deref, L: Deref>(
5098                 &mut self, height: u32, highest_header_time: u32, genesis_block_hash: BlockHash,
5099                 node_signer: &NS, user_config: &UserConfig, logger: &L
5100         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
5101         where
5102                 NS::Target: NodeSigner,
5103                 L::Target: Logger
5104         {
5105                 self.do_best_block_updated(height, highest_header_time, Some((genesis_block_hash, node_signer, user_config)), logger)
5106         }
5107
5108         fn do_best_block_updated<NS: Deref, L: Deref>(
5109                 &mut self, height: u32, highest_header_time: u32,
5110                 genesis_node_signer: Option<(BlockHash, &NS, &UserConfig)>, logger: &L
5111         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
5112         where
5113                 NS::Target: NodeSigner,
5114                 L::Target: Logger
5115         {
5116                 let mut timed_out_htlcs = Vec::new();
5117                 // This mirrors the check in ChannelManager::decode_update_add_htlc_onion, refusing to
5118                 // forward an HTLC when our counterparty should almost certainly just fail it for expiring
5119                 // ~now.
5120                 let unforwarded_htlc_cltv_limit = height + LATENCY_GRACE_PERIOD_BLOCKS;
5121                 self.holding_cell_htlc_updates.retain(|htlc_update| {
5122                         match htlc_update {
5123                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
5124                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
5125                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
5126                                                 false
5127                                         } else { true }
5128                                 },
5129                                 _ => true
5130                         }
5131                 });
5132
5133                 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
5134
5135                 if let Some(channel_ready) = self.check_get_channel_ready(height) {
5136                         let announcement_sigs = if let Some((genesis_block_hash, node_signer, user_config)) = genesis_node_signer {
5137                                 self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, height, logger)
5138                         } else { None };
5139                         log_info!(logger, "Sending a channel_ready to our peer for channel {}", log_bytes!(self.channel_id));
5140                         return Ok((Some(channel_ready), timed_out_htlcs, announcement_sigs));
5141                 }
5142
5143                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
5144                 if non_shutdown_state >= ChannelState::ChannelReady as u32 ||
5145                    (non_shutdown_state & ChannelState::OurChannelReady as u32) == ChannelState::OurChannelReady as u32 {
5146                         let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
5147                         if self.funding_tx_confirmation_height == 0 {
5148                                 // Note that check_get_channel_ready may reset funding_tx_confirmation_height to
5149                                 // zero if it has been reorged out, however in either case, our state flags
5150                                 // indicate we've already sent a channel_ready
5151                                 funding_tx_confirmations = 0;
5152                         }
5153
5154                         // If we've sent channel_ready (or have both sent and received channel_ready), and
5155                         // the funding transaction has become unconfirmed,
5156                         // close the channel and hope we can get the latest state on chain (because presumably
5157                         // the funding transaction is at least still in the mempool of most nodes).
5158                         //
5159                         // Note that ideally we wouldn't force-close if we see *any* reorg on a 1-conf or
5160                         // 0-conf channel, but not doing so may lead to the
5161                         // `ChannelManager::short_to_chan_info` map  being inconsistent, so we currently have
5162                         // to.
5163                         if funding_tx_confirmations == 0 && self.funding_tx_confirmed_in.is_some() {
5164                                 let err_reason = format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.",
5165                                         self.minimum_depth.unwrap(), funding_tx_confirmations);
5166                                 return Err(ClosureReason::ProcessingError { err: err_reason });
5167                         }
5168                 } else if !self.is_outbound() && self.funding_tx_confirmed_in.is_none() &&
5169                                 height >= self.channel_creation_height + FUNDING_CONF_DEADLINE_BLOCKS {
5170                         log_info!(logger, "Closing channel {} due to funding timeout", log_bytes!(self.channel_id));
5171                         // If funding_tx_confirmed_in is unset, the channel must not be active
5172                         assert!(non_shutdown_state <= ChannelState::ChannelReady as u32);
5173                         assert_eq!(non_shutdown_state & ChannelState::OurChannelReady as u32, 0);
5174                         return Err(ClosureReason::FundingTimedOut);
5175                 }
5176
5177                 let announcement_sigs = if let Some((genesis_block_hash, node_signer, user_config)) = genesis_node_signer {
5178                         self.get_announcement_sigs(node_signer, genesis_block_hash, user_config, height, logger)
5179                 } else { None };
5180                 Ok((None, timed_out_htlcs, announcement_sigs))
5181         }
5182
5183         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
5184         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
5185         /// before the channel has reached channel_ready and we can just wait for more blocks.
5186         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
5187                 if self.funding_tx_confirmation_height != 0 {
5188                         // We handle the funding disconnection by calling best_block_updated with a height one
5189                         // below where our funding was connected, implying a reorg back to conf_height - 1.
5190                         let reorg_height = self.funding_tx_confirmation_height - 1;
5191                         // We use the time field to bump the current time we set on channel updates if its
5192                         // larger. If we don't know that time has moved forward, we can just set it to the last
5193                         // time we saw and it will be ignored.
5194                         let best_time = self.update_time_counter;
5195                         match self.do_best_block_updated(reorg_height, best_time, None::<(BlockHash, &&NodeSigner, &UserConfig)>, logger) {
5196                                 Ok((channel_ready, timed_out_htlcs, announcement_sigs)) => {
5197                                         assert!(channel_ready.is_none(), "We can't generate a funding with 0 confirmations?");
5198                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
5199                                         assert!(announcement_sigs.is_none(), "We can't generate an announcement_sigs with 0 confirmations?");
5200                                         Ok(())
5201                                 },
5202                                 Err(e) => Err(e)
5203                         }
5204                 } else {
5205                         // We never learned about the funding confirmation anyway, just ignore
5206                         Ok(())
5207                 }
5208         }
5209
5210         // Methods to get unprompted messages to send to the remote end (or where we already returned
5211         // something in the handler for the message that prompted this message):
5212
5213         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
5214                 if !self.is_outbound() {
5215                         panic!("Tried to open a channel for an inbound channel?");
5216                 }
5217                 if self.channel_state != ChannelState::OurInitSent as u32 {
5218                         panic!("Cannot generate an open_channel after we've moved forward");
5219                 }
5220
5221                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5222                         panic!("Tried to send an open_channel for a channel that has already advanced");
5223                 }
5224
5225                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
5226                 let keys = self.get_holder_pubkeys();
5227
5228                 msgs::OpenChannel {
5229                         chain_hash,
5230                         temporary_channel_id: self.channel_id,
5231                         funding_satoshis: self.channel_value_satoshis,
5232                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
5233                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
5234                         max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
5235                         channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
5236                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
5237                         feerate_per_kw: self.feerate_per_kw as u32,
5238                         to_self_delay: self.get_holder_selected_contest_delay(),
5239                         max_accepted_htlcs: OUR_MAX_HTLCS,
5240                         funding_pubkey: keys.funding_pubkey,
5241                         revocation_basepoint: keys.revocation_basepoint,
5242                         payment_point: keys.payment_point,
5243                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
5244                         htlc_basepoint: keys.htlc_basepoint,
5245                         first_per_commitment_point,
5246                         channel_flags: if self.config.announced_channel {1} else {0},
5247                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
5248                                 Some(script) => script.clone().into_inner(),
5249                                 None => Builder::new().into_script(),
5250                         }),
5251                         channel_type: Some(self.channel_type.clone()),
5252                 }
5253         }
5254
5255         pub fn inbound_is_awaiting_accept(&self) -> bool {
5256                 self.inbound_awaiting_accept
5257         }
5258
5259         /// Sets this channel to accepting 0conf, must be done before `get_accept_channel`
5260         pub fn set_0conf(&mut self) {
5261                 assert!(self.inbound_awaiting_accept);
5262                 self.minimum_depth = Some(0);
5263         }
5264
5265         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannel`] message which
5266         /// should be sent back to the counterparty node.
5267         ///
5268         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5269         pub fn accept_inbound_channel(&mut self, user_id: u128) -> msgs::AcceptChannel {
5270                 if self.is_outbound() {
5271                         panic!("Tried to send accept_channel for an outbound channel?");
5272                 }
5273                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
5274                         panic!("Tried to send accept_channel after channel had moved forward");
5275                 }
5276                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5277                         panic!("Tried to send an accept_channel for a channel that has already advanced");
5278                 }
5279                 if !self.inbound_awaiting_accept {
5280                         panic!("The inbound channel has already been accepted");
5281                 }
5282
5283                 self.user_id = user_id;
5284                 self.inbound_awaiting_accept = false;
5285
5286                 self.generate_accept_channel_message()
5287         }
5288
5289         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
5290         /// inbound channel. If the intention is to accept an inbound channel, use
5291         /// [`Channel::accept_inbound_channel`] instead.
5292         ///
5293         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5294         fn generate_accept_channel_message(&self) -> msgs::AcceptChannel {
5295                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
5296                 let keys = self.get_holder_pubkeys();
5297
5298                 msgs::AcceptChannel {
5299                         temporary_channel_id: self.channel_id,
5300                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
5301                         max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
5302                         channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
5303                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
5304                         minimum_depth: self.minimum_depth.unwrap(),
5305                         to_self_delay: self.get_holder_selected_contest_delay(),
5306                         max_accepted_htlcs: OUR_MAX_HTLCS,
5307                         funding_pubkey: keys.funding_pubkey,
5308                         revocation_basepoint: keys.revocation_basepoint,
5309                         payment_point: keys.payment_point,
5310                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
5311                         htlc_basepoint: keys.htlc_basepoint,
5312                         first_per_commitment_point,
5313                         shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
5314                                 Some(script) => script.clone().into_inner(),
5315                                 None => Builder::new().into_script(),
5316                         }),
5317                         channel_type: Some(self.channel_type.clone()),
5318                 }
5319         }
5320
5321         /// Enables the possibility for tests to extract a [`msgs::AcceptChannel`] message for an
5322         /// inbound channel without accepting it.
5323         ///
5324         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
5325         #[cfg(test)]
5326         pub fn get_accept_channel_message(&self) -> msgs::AcceptChannel {
5327                 self.generate_accept_channel_message()
5328         }
5329
5330         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
5331         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
5332                 let counterparty_keys = self.build_remote_transaction_keys();
5333                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
5334                 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), &self.secp_ctx)
5335                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
5336         }
5337
5338         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
5339         /// a funding_created message for the remote peer.
5340         /// Panics if called at some time other than immediately after initial handshake, if called twice,
5341         /// or if called on an inbound channel.
5342         /// Note that channel_id changes during this call!
5343         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
5344         /// If an Err is returned, it is a ChannelError::Close.
5345         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 {
5346                 if !self.is_outbound() {
5347                         panic!("Tried to create outbound funding_created message on an inbound channel!");
5348                 }
5349                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
5350                         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)");
5351                 }
5352                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
5353                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
5354                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
5355                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
5356                 }
5357
5358                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
5359                 self.holder_signer.provide_channel_parameters(&self.channel_transaction_parameters);
5360
5361                 let signature = match self.get_outbound_funding_created_signature(logger) {
5362                         Ok(res) => res,
5363                         Err(e) => {
5364                                 log_error!(logger, "Got bad signatures: {:?}!", e);
5365                                 self.channel_transaction_parameters.funding_outpoint = None;
5366                                 return Err(e);
5367                         }
5368                 };
5369
5370                 let temporary_channel_id = self.channel_id;
5371
5372                 // Now that we're past error-generating stuff, update our local state:
5373
5374                 self.channel_state = ChannelState::FundingCreated as u32;
5375                 self.channel_id = funding_txo.to_channel_id();
5376                 self.funding_transaction = Some(funding_transaction);
5377
5378                 Ok(msgs::FundingCreated {
5379                         temporary_channel_id,
5380                         funding_txid: funding_txo.txid,
5381                         funding_output_index: funding_txo.index,
5382                         signature
5383                 })
5384         }
5385
5386         /// Gets an UnsignedChannelAnnouncement for this channel. The channel must be publicly
5387         /// announceable and available for use (have exchanged ChannelReady messages in both
5388         /// directions). Should be used for both broadcasted announcements and in response to an
5389         /// AnnouncementSignatures message from the remote peer.
5390         ///
5391         /// Will only fail if we're not in a state where channel_announcement may be sent (including
5392         /// closing).
5393         ///
5394         /// This will only return ChannelError::Ignore upon failure.
5395         fn get_channel_announcement<NS: Deref>(
5396                 &self, node_signer: &NS, chain_hash: BlockHash, user_config: &UserConfig,
5397         ) -> Result<msgs::UnsignedChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
5398                 if !self.config.announced_channel {
5399                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
5400                 }
5401                 if !self.is_usable() {
5402                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel is not currently usable".to_owned()));
5403                 }
5404
5405                 let node_id = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
5406                         .map_err(|_| ChannelError::Ignore("Failed to retrieve own public key".to_owned()))?);
5407                 let counterparty_node_id = NodeId::from_pubkey(&self.get_counterparty_node_id());
5408                 let were_node_one = node_id.as_slice() < counterparty_node_id.as_slice();
5409
5410                 let msg = msgs::UnsignedChannelAnnouncement {
5411                         features: channelmanager::provided_channel_features(&user_config),
5412                         chain_hash,
5413                         short_channel_id: self.get_short_channel_id().unwrap(),
5414                         node_id_1: if were_node_one { node_id } else { counterparty_node_id },
5415                         node_id_2: if were_node_one { counterparty_node_id } else { node_id },
5416                         bitcoin_key_1: NodeId::from_pubkey(if were_node_one { &self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey() }),
5417                         bitcoin_key_2: NodeId::from_pubkey(if were_node_one { self.counterparty_funding_pubkey() } else { &self.get_holder_pubkeys().funding_pubkey }),
5418                         excess_data: Vec::new(),
5419                 };
5420
5421                 Ok(msg)
5422         }
5423
5424         fn get_announcement_sigs<NS: Deref, L: Deref>(
5425                 &mut self, node_signer: &NS, genesis_block_hash: BlockHash, user_config: &UserConfig,
5426                 best_block_height: u32, logger: &L
5427         ) -> Option<msgs::AnnouncementSignatures>
5428         where
5429                 NS::Target: NodeSigner,
5430                 L::Target: Logger
5431         {
5432                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5433                         return None;
5434                 }
5435
5436                 if !self.is_usable() {
5437                         return None;
5438                 }
5439
5440                 if self.channel_state & ChannelState::PeerDisconnected as u32 != 0 {
5441                         log_trace!(logger, "Cannot create an announcement_signatures as our peer is disconnected");
5442                         return None;
5443                 }
5444
5445                 if self.announcement_sigs_state != AnnouncementSigsState::NotSent {
5446                         return None;
5447                 }
5448
5449                 log_trace!(logger, "Creating an announcement_signatures message for channel {}", log_bytes!(self.channel_id()));
5450                 let announcement = match self.get_channel_announcement(node_signer, genesis_block_hash, user_config) {
5451                         Ok(a) => a,
5452                         Err(e) => {
5453                                 log_trace!(logger, "{:?}", e);
5454                                 return None;
5455                         }
5456                 };
5457                 let our_node_sig = match node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement)) {
5458                         Err(_) => {
5459                                 log_error!(logger, "Failed to generate node signature for channel_announcement. Channel will not be announced!");
5460                                 return None;
5461                         },
5462                         Ok(v) => v
5463                 };
5464                 let our_bitcoin_sig = match self.holder_signer.sign_channel_announcement_with_funding_key(&announcement, &self.secp_ctx) {
5465                         Err(_) => {
5466                                 log_error!(logger, "Signer rejected channel_announcement signing. Channel will not be announced!");
5467                                 return None;
5468                         },
5469                         Ok(v) => v
5470                 };
5471                 self.announcement_sigs_state = AnnouncementSigsState::MessageSent;
5472
5473                 Some(msgs::AnnouncementSignatures {
5474                         channel_id: self.channel_id(),
5475                         short_channel_id: self.get_short_channel_id().unwrap(),
5476                         node_signature: our_node_sig,
5477                         bitcoin_signature: our_bitcoin_sig,
5478                 })
5479         }
5480
5481         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
5482         /// available.
5483         fn sign_channel_announcement<NS: Deref>(
5484                 &self, node_signer: &NS, announcement: msgs::UnsignedChannelAnnouncement
5485         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
5486                 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
5487                         let our_node_key = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
5488                                 .map_err(|_| ChannelError::Ignore("Signer failed to retrieve own public key".to_owned()))?);
5489                         let were_node_one = announcement.node_id_1 == our_node_key;
5490
5491                         let our_node_sig = node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement))
5492                                 .map_err(|_| ChannelError::Ignore("Failed to generate node signature for channel_announcement".to_owned()))?;
5493                         let our_bitcoin_sig = self.holder_signer.sign_channel_announcement_with_funding_key(&announcement, &self.secp_ctx)
5494                                 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
5495                         Ok(msgs::ChannelAnnouncement {
5496                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
5497                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
5498                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
5499                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
5500                                 contents: announcement,
5501                         })
5502                 } else {
5503                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
5504                 }
5505         }
5506
5507         /// Processes an incoming announcement_signatures message, providing a fully-signed
5508         /// channel_announcement message which we can broadcast and storing our counterparty's
5509         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
5510         pub fn announcement_signatures<NS: Deref>(
5511                 &mut self, node_signer: &NS, chain_hash: BlockHash, best_block_height: u32,
5512                 msg: &msgs::AnnouncementSignatures, user_config: &UserConfig
5513         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
5514                 let announcement = self.get_channel_announcement(node_signer, chain_hash, user_config)?;
5515
5516                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
5517
5518                 if self.secp_ctx.verify_ecdsa(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
5519                         return Err(ChannelError::Close(format!(
5520                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
5521                                  &announcement, self.get_counterparty_node_id())));
5522                 }
5523                 if self.secp_ctx.verify_ecdsa(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
5524                         return Err(ChannelError::Close(format!(
5525                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
5526                                 &announcement, self.counterparty_funding_pubkey())));
5527                 }
5528
5529                 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
5530                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5531                         return Err(ChannelError::Ignore(
5532                                 "Got announcement_signatures prior to the required six confirmations - we may not have received a block yet that our peer has".to_owned()));
5533                 }
5534
5535                 self.sign_channel_announcement(node_signer, announcement)
5536         }
5537
5538         /// Gets a signed channel_announcement for this channel, if we previously received an
5539         /// announcement_signatures from our counterparty.
5540         pub fn get_signed_channel_announcement<NS: Deref>(
5541                 &self, node_signer: &NS, chain_hash: BlockHash, best_block_height: u32, user_config: &UserConfig
5542         ) -> Option<msgs::ChannelAnnouncement> where NS::Target: NodeSigner {
5543                 if self.funding_tx_confirmation_height == 0 || self.funding_tx_confirmation_height + 5 > best_block_height {
5544                         return None;
5545                 }
5546                 let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
5547                         Ok(res) => res,
5548                         Err(_) => return None,
5549                 };
5550                 match self.sign_channel_announcement(node_signer, announcement) {
5551                         Ok(res) => Some(res),
5552                         Err(_) => None,
5553                 }
5554         }
5555
5556         /// May panic if called on a channel that wasn't immediately-previously
5557         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
5558         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
5559                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
5560                 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
5561                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
5562                 // current to_remote balances. However, it no longer has any use, and thus is now simply
5563                 // set to a dummy (but valid, as required by the spec) public key.
5564                 // fuzzing mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
5565                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
5566                 // valid, and valid in fuzzing mode's arbitrary validity criteria:
5567                 let mut pk = [2; 33]; pk[1] = 0xff;
5568                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
5569                 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
5570                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
5571                         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()));
5572                         OptionalField::Present(DataLossProtect {
5573                                 your_last_per_commitment_secret: remote_last_secret,
5574                                 my_current_per_commitment_point: dummy_pubkey
5575                         })
5576                 } else {
5577                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
5578                         OptionalField::Present(DataLossProtect {
5579                                 your_last_per_commitment_secret: [0;32],
5580                                 my_current_per_commitment_point: dummy_pubkey,
5581                         })
5582                 };
5583                 msgs::ChannelReestablish {
5584                         channel_id: self.channel_id(),
5585                         // The protocol has two different commitment number concepts - the "commitment
5586                         // transaction number", which starts from 0 and counts up, and the "revocation key
5587                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
5588                         // commitment transaction numbers by the index which will be used to reveal the
5589                         // revocation key for that commitment transaction, which means we have to convert them
5590                         // to protocol-level commitment numbers here...
5591
5592                         // next_local_commitment_number is the next commitment_signed number we expect to
5593                         // receive (indicating if they need to resend one that we missed).
5594                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
5595                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
5596                         // receive, however we track it by the next commitment number for a remote transaction
5597                         // (which is one further, as they always revoke previous commitment transaction, not
5598                         // the one we send) so we have to decrement by 1. Note that if
5599                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
5600                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
5601                         // overflow here.
5602                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
5603                         data_loss_protect,
5604                 }
5605         }
5606
5607
5608         // Send stuff to our remote peers:
5609
5610         /// Queues up an outbound HTLC to send by placing it in the holding cell. You should call
5611         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
5612         /// commitment update.
5613         ///
5614         /// `Err`s will only be [`ChannelError::Ignore`].
5615         pub fn queue_add_htlc<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
5616                 onion_routing_packet: msgs::OnionPacket, logger: &L)
5617         -> Result<(), ChannelError> where L::Target: Logger {
5618                 self
5619                         .send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, true, logger)
5620                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
5621                         .map_err(|err| {
5622                                 if let ChannelError::Ignore(_) = err { /* fine */ }
5623                                 else { debug_assert!(false, "Queueing cannot trigger channel failure"); }
5624                                 err
5625                         })
5626         }
5627
5628         /// Adds a pending outbound HTLC to this channel, note that you probably want
5629         /// [`Self::send_htlc_and_commit`] instead cause you'll want both messages at once.
5630         ///
5631         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
5632         /// the wire:
5633         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
5634         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
5635         ///   awaiting ACK.
5636         /// * In cases where we're marked MonitorUpdateInProgress, we cannot commit to a new state as
5637         ///   we may not yet have sent the previous commitment update messages and will need to
5638         ///   regenerate them.
5639         ///
5640         /// You MUST call [`Self::send_commitment_no_state_update`] prior to calling any other methods
5641         /// on this [`Channel`] if `force_holding_cell` is false.
5642         ///
5643         /// `Err`s will only be [`ChannelError::Ignore`].
5644         fn send_htlc<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
5645                 onion_routing_packet: msgs::OnionPacket, mut force_holding_cell: bool, logger: &L)
5646         -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> where L::Target: Logger {
5647                 if (self.channel_state & (ChannelState::ChannelReady as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelReady as u32) {
5648                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
5649                 }
5650                 let channel_total_msat = self.channel_value_satoshis * 1000;
5651                 if amount_msat > channel_total_msat {
5652                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
5653                 }
5654
5655                 if amount_msat == 0 {
5656                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
5657                 }
5658
5659                 if amount_msat < self.counterparty_htlc_minimum_msat {
5660                         return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
5661                 }
5662
5663                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
5664                         // Note that this should never really happen, if we're !is_live() on receipt of an
5665                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
5666                         // the user to send directly into a !is_live() channel. However, if we
5667                         // disconnected during the time the previous hop was doing the commitment dance we may
5668                         // end up getting here after the forwarding delay. In any case, returning an
5669                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
5670                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
5671                 }
5672
5673                 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
5674                 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
5675                 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
5676                         return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
5677                 }
5678                 // Check their_max_htlc_value_in_flight_msat
5679                 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
5680                         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)));
5681                 }
5682
5683                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number);
5684                 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
5685                 if !self.is_outbound() {
5686                         // Check that we won't violate the remote channel reserve by adding this HTLC.
5687                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
5688                         let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5689                         let holder_selected_chan_reserve_msat = self.holder_selected_channel_reserve_satoshis * 1000;
5690                         if commitment_stats.remote_balance_msat < counterparty_commit_tx_fee_msat + holder_selected_chan_reserve_msat {
5691                                 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
5692                         }
5693                 }
5694
5695                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if self.opt_anchors() {
5696                         (0, 0)
5697                 } else {
5698                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
5699                         (dust_buffer_feerate * htlc_success_tx_weight(false) / 1000,
5700                                 dust_buffer_feerate * htlc_timeout_tx_weight(false) / 1000)
5701                 };
5702                 let exposure_dust_limit_success_sats = htlc_success_dust_limit + self.counterparty_dust_limit_satoshis;
5703                 if amount_msat / 1000 < exposure_dust_limit_success_sats {
5704                         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;
5705                         if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
5706                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
5707                                         on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
5708                         }
5709                 }
5710
5711                 let exposure_dust_limit_timeout_sats = htlc_timeout_dust_limit + self.holder_dust_limit_satoshis;
5712                 if amount_msat / 1000 <  exposure_dust_limit_timeout_sats {
5713                         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;
5714                         if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
5715                                 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
5716                                         on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
5717                         }
5718                 }
5719
5720                 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
5721                 if holder_balance_msat < amount_msat {
5722                         return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, holder_balance_msat)));
5723                 }
5724
5725                 // `2 *` and extra HTLC are for the fee spike buffer.
5726                 let commit_tx_fee_msat = if self.is_outbound() {
5727                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
5728                         FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
5729                 } else { 0 };
5730                 if holder_balance_msat - amount_msat < commit_tx_fee_msat {
5731                         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 {}", holder_balance_msat, commit_tx_fee_msat)));
5732                 }
5733
5734                 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
5735                 // reserve for the remote to have something to claim if we misbehave)
5736                 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
5737                 if holder_balance_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
5738                         return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
5739                 }
5740
5741                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateInProgress as u32)) != 0 {
5742                         force_holding_cell = true;
5743                 }
5744
5745                 // Now update local state:
5746                 if force_holding_cell {
5747                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
5748                                 amount_msat,
5749                                 payment_hash,
5750                                 cltv_expiry,
5751                                 source,
5752                                 onion_routing_packet,
5753                         });
5754                         return Ok(None);
5755                 }
5756
5757                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
5758                         htlc_id: self.next_holder_htlc_id,
5759                         amount_msat,
5760                         payment_hash: payment_hash.clone(),
5761                         cltv_expiry,
5762                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
5763                         source,
5764                 });
5765
5766                 let res = msgs::UpdateAddHTLC {
5767                         channel_id: self.channel_id,
5768                         htlc_id: self.next_holder_htlc_id,
5769                         amount_msat,
5770                         payment_hash,
5771                         cltv_expiry,
5772                         onion_routing_packet,
5773                 };
5774                 self.next_holder_htlc_id += 1;
5775
5776                 Ok(Some(res))
5777         }
5778
5779         fn build_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> ChannelMonitorUpdate where L::Target: Logger {
5780                 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
5781                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
5782                 // fail to generate this, we still are at least at a position where upgrading their status
5783                 // is acceptable.
5784                 for htlc in self.pending_inbound_htlcs.iter_mut() {
5785                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
5786                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
5787                         } else { None };
5788                         if let Some(state) = new_state {
5789                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
5790                                 htlc.state = state;
5791                         }
5792                 }
5793                 for htlc in self.pending_outbound_htlcs.iter_mut() {
5794                         if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
5795                                 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
5796                                 // Grab the preimage, if it exists, instead of cloning
5797                                 let mut reason = OutboundHTLCOutcome::Success(None);
5798                                 mem::swap(outcome, &mut reason);
5799                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
5800                         }
5801                 }
5802                 if let Some((feerate, update_state)) = self.pending_update_fee {
5803                         if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
5804                                 debug_assert!(!self.is_outbound());
5805                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
5806                                 self.feerate_per_kw = feerate;
5807                                 self.pending_update_fee = None;
5808                         }
5809                 }
5810                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
5811
5812                 let (counterparty_commitment_txid, mut htlcs_ref) = self.build_commitment_no_state_update(logger);
5813                 let htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
5814                         htlcs_ref.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
5815
5816                 if self.announcement_sigs_state == AnnouncementSigsState::MessageSent {
5817                         self.announcement_sigs_state = AnnouncementSigsState::Committed;
5818                 }
5819
5820                 self.latest_monitor_update_id += 1;
5821                 let monitor_update = ChannelMonitorUpdate {
5822                         update_id: self.latest_monitor_update_id,
5823                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
5824                                 commitment_txid: counterparty_commitment_txid,
5825                                 htlc_outputs: htlcs.clone(),
5826                                 commitment_number: self.cur_counterparty_commitment_transaction_number,
5827                                 their_per_commitment_point: self.counterparty_cur_commitment_point.unwrap()
5828                         }]
5829                 };
5830                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
5831                 monitor_update
5832         }
5833
5834         fn build_commitment_no_state_update<L: Deref>(&self, logger: &L) -> (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
5835                 let counterparty_keys = self.build_remote_transaction_keys();
5836                 let commitment_stats = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
5837                 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
5838
5839                 #[cfg(any(test, fuzzing))]
5840                 {
5841                         if !self.is_outbound() {
5842                                 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
5843                                 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
5844                                 if let Some(info) = projected_commit_tx_info {
5845                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
5846                                         if info.total_pending_htlcs == total_pending_htlcs
5847                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
5848                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
5849                                                 && info.feerate == self.feerate_per_kw {
5850                                                         let actual_fee = Self::commit_tx_fee_msat(self.feerate_per_kw, commitment_stats.num_nondust_htlcs, self.opt_anchors());
5851                                                         assert_eq!(actual_fee, info.fee);
5852                                                 }
5853                                 }
5854                         }
5855                 }
5856
5857                 (counterparty_commitment_txid, commitment_stats.htlcs_included)
5858         }
5859
5860         /// Only fails in case of signer rejection. Used for channel_reestablish commitment_signed
5861         /// generation when we shouldn't change HTLC/channel state.
5862         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
5863                 // Get the fee tests from `build_commitment_no_state_update`
5864                 #[cfg(any(test, fuzzing))]
5865                 self.build_commitment_no_state_update(logger);
5866
5867                 let counterparty_keys = self.build_remote_transaction_keys();
5868                 let commitment_stats = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
5869                 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
5870                 let (signature, htlc_signatures);
5871
5872                 {
5873                         let mut htlcs = Vec::with_capacity(commitment_stats.htlcs_included.len());
5874                         for &(ref htlc, _) in commitment_stats.htlcs_included.iter() {
5875                                 htlcs.push(htlc);
5876                         }
5877
5878                         let res = self.holder_signer.sign_counterparty_commitment(&commitment_stats.tx, commitment_stats.preimages, &self.secp_ctx)
5879                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
5880                         signature = res.0;
5881                         htlc_signatures = res.1;
5882
5883                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
5884                                 encode::serialize_hex(&commitment_stats.tx.trust().built_transaction().transaction),
5885                                 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
5886                                 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
5887
5888                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
5889                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
5890                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, commitment_stats.feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, self.opt_anchors(), false, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
5891                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &counterparty_keys)),
5892                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
5893                                         log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
5894                         }
5895                 }
5896
5897                 Ok((msgs::CommitmentSigned {
5898                         channel_id: self.channel_id,
5899                         signature,
5900                         htlc_signatures,
5901                 }, (counterparty_commitment_txid, commitment_stats.htlcs_included)))
5902         }
5903
5904         /// Adds a pending outbound HTLC to this channel, and builds a new remote commitment
5905         /// transaction and generates the corresponding [`ChannelMonitorUpdate`] in one go.
5906         ///
5907         /// Shorthand for calling [`Self::send_htlc`] followed by a commitment update, see docs on
5908         /// [`Self::send_htlc`] and [`Self::build_commitment_no_state_update`] for more info.
5909         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<&ChannelMonitorUpdate>, ChannelError> where L::Target: Logger {
5910                 let send_res = self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, false, logger);
5911                 if let Err(e) = &send_res { if let ChannelError::Ignore(_) = e {} else { debug_assert!(false, "Sending cannot trigger channel failure"); } }
5912                 match send_res? {
5913                         Some(_) => {
5914                                 let monitor_update = self.build_commitment_no_status_check(logger);
5915                                 self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
5916                                 self.pending_monitor_updates.push(monitor_update);
5917                                 Ok(Some(self.pending_monitor_updates.last().unwrap()))
5918                         },
5919                         None => Ok(None)
5920                 }
5921         }
5922
5923         /// Get forwarding information for the counterparty.
5924         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
5925                 self.counterparty_forwarding_info.clone()
5926         }
5927
5928         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
5929                 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
5930                         return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
5931                 }
5932                 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
5933                         fee_base_msat: msg.contents.fee_base_msat,
5934                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
5935                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
5936                 });
5937
5938                 Ok(())
5939         }
5940
5941         /// Begins the shutdown process, getting a message for the remote peer and returning all
5942         /// holding cell HTLCs for payment failure.
5943         ///
5944         /// May jump to the channel being fully shutdown (see [`Self::is_shutdown`]) in which case no
5945         /// [`ChannelMonitorUpdate`] will be returned).
5946         pub fn get_shutdown<SP: Deref>(&mut self, signer_provider: &SP, their_features: &InitFeatures,
5947                 target_feerate_sats_per_kw: Option<u32>)
5948         -> Result<(msgs::Shutdown, Option<&ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
5949         where SP::Target: SignerProvider {
5950                 for htlc in self.pending_outbound_htlcs.iter() {
5951                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
5952                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
5953                         }
5954                 }
5955                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
5956                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
5957                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
5958                         }
5959                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
5960                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
5961                         }
5962                 }
5963                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
5964                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateInProgress as u32) != 0 {
5965                         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()});
5966                 }
5967
5968                 let update_shutdown_script = match self.shutdown_scriptpubkey {
5969                         Some(_) => false,
5970                         None => {
5971                                 let shutdown_scriptpubkey = signer_provider.get_shutdown_scriptpubkey();
5972                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
5973                                         return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
5974                                 }
5975                                 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
5976                                 true
5977                         },
5978                 };
5979
5980                 // From here on out, we may not fail!
5981                 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
5982                 if self.channel_state < ChannelState::FundingSent as u32 {
5983                         self.channel_state = ChannelState::ShutdownComplete as u32;
5984                 } else {
5985                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
5986                 }
5987                 self.update_time_counter += 1;
5988
5989                 let monitor_update = if update_shutdown_script {
5990                         self.latest_monitor_update_id += 1;
5991                         let monitor_update = ChannelMonitorUpdate {
5992                                 update_id: self.latest_monitor_update_id,
5993                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
5994                                         scriptpubkey: self.get_closing_scriptpubkey(),
5995                                 }],
5996                         };
5997                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
5998                         self.pending_monitor_updates.push(monitor_update);
5999                         Some(self.pending_monitor_updates.last().unwrap())
6000                 } else { None };
6001                 let shutdown = msgs::Shutdown {
6002                         channel_id: self.channel_id,
6003                         scriptpubkey: self.get_closing_scriptpubkey(),
6004                 };
6005
6006                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
6007                 // our shutdown until we've committed all of the pending changes.
6008                 self.holding_cell_update_fee = None;
6009                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
6010                 self.holding_cell_htlc_updates.retain(|htlc_update| {
6011                         match htlc_update {
6012                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
6013                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
6014                                         false
6015                                 },
6016                                 _ => true
6017                         }
6018                 });
6019
6020                 debug_assert!(!self.is_shutdown() || monitor_update.is_none(),
6021                         "we can't both complete shutdown and return a monitor update");
6022
6023                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
6024         }
6025
6026         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
6027         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
6028         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
6029         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
6030         /// immediately (others we will have to allow to time out).
6031         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>) {
6032                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
6033                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
6034                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
6035                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
6036                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
6037
6038                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
6039                 // return them to fail the payment.
6040                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
6041                 let counterparty_node_id = self.get_counterparty_node_id();
6042                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
6043                         match htlc_update {
6044                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
6045                                         dropped_outbound_htlcs.push((source, payment_hash, counterparty_node_id, self.channel_id));
6046                                 },
6047                                 _ => {}
6048                         }
6049                 }
6050                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
6051                         // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
6052                         // returning a channel monitor update here would imply a channel monitor update before
6053                         // we even registered the channel monitor to begin with, which is invalid.
6054                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
6055                         // funding transaction, don't return a funding txo (which prevents providing the
6056                         // monitor update to the user, even if we return one).
6057                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
6058                         if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelReady as u32 | ChannelState::ShutdownComplete as u32) != 0 {
6059                                 self.latest_monitor_update_id += 1;
6060                                 Some((funding_txo, ChannelMonitorUpdate {
6061                                         update_id: self.latest_monitor_update_id,
6062                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
6063                                 }))
6064                         } else { None }
6065                 } else { None };
6066
6067                 self.channel_state = ChannelState::ShutdownComplete as u32;
6068                 self.update_time_counter += 1;
6069                 (monitor_update, dropped_outbound_htlcs)
6070         }
6071
6072         pub fn inflight_htlc_sources(&self) -> impl Iterator<Item=(&HTLCSource, &PaymentHash)> {
6073                 self.holding_cell_htlc_updates.iter()
6074                         .flat_map(|htlc_update| {
6075                                 match htlc_update {
6076                                         HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. }
6077                                                 => Some((source, payment_hash)),
6078                                         _ => None,
6079                                 }
6080                         })
6081                         .chain(self.pending_outbound_htlcs.iter().map(|htlc| (&htlc.source, &htlc.payment_hash)))
6082         }
6083 }
6084
6085 const SERIALIZATION_VERSION: u8 = 3;
6086 const MIN_SERIALIZATION_VERSION: u8 = 2;
6087
6088 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
6089         (0, FailRelay),
6090         (1, FailMalformed),
6091         (2, Fulfill),
6092 );
6093
6094 impl Writeable for ChannelUpdateStatus {
6095         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6096                 // We only care about writing out the current state as it was announced, ie only either
6097                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
6098                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
6099                 match self {
6100                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
6101                         ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
6102                         ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
6103                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
6104                 }
6105                 Ok(())
6106         }
6107 }
6108
6109 impl Readable for ChannelUpdateStatus {
6110         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
6111                 Ok(match <u8 as Readable>::read(reader)? {
6112                         0 => ChannelUpdateStatus::Enabled,
6113                         1 => ChannelUpdateStatus::Disabled,
6114                         _ => return Err(DecodeError::InvalidValue),
6115                 })
6116         }
6117 }
6118
6119 impl Writeable for AnnouncementSigsState {
6120         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6121                 // We only care about writing out the current state as if we had just disconnected, at
6122                 // which point we always set anything but AnnouncementSigsReceived to NotSent.
6123                 match self {
6124                         AnnouncementSigsState::NotSent => 0u8.write(writer),
6125                         AnnouncementSigsState::MessageSent => 0u8.write(writer),
6126                         AnnouncementSigsState::Committed => 0u8.write(writer),
6127                         AnnouncementSigsState::PeerReceived => 1u8.write(writer),
6128                 }
6129         }
6130 }
6131
6132 impl Readable for AnnouncementSigsState {
6133         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
6134                 Ok(match <u8 as Readable>::read(reader)? {
6135                         0 => AnnouncementSigsState::NotSent,
6136                         1 => AnnouncementSigsState::PeerReceived,
6137                         _ => return Err(DecodeError::InvalidValue),
6138                 })
6139         }
6140 }
6141
6142 impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
6143         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6144                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
6145                 // called.
6146
6147                 write_ver_prefix!(writer, MIN_SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6148
6149                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
6150                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We write
6151                 // the low bytes now and the optional high bytes later.
6152                 let user_id_low = self.user_id as u64;
6153                 user_id_low.write(writer)?;
6154
6155                 // Version 1 deserializers expected to read parts of the config object here. Version 2
6156                 // deserializers (0.0.99) now read config through TLVs, and as we now require them for
6157                 // `minimum_depth` we simply write dummy values here.
6158                 writer.write_all(&[0; 8])?;
6159
6160                 self.channel_id.write(writer)?;
6161                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
6162                 self.channel_value_satoshis.write(writer)?;
6163
6164                 self.latest_monitor_update_id.write(writer)?;
6165
6166                 let mut key_data = VecWriter(Vec::new());
6167                 self.holder_signer.write(&mut key_data)?;
6168                 assert!(key_data.0.len() < core::usize::MAX);
6169                 assert!(key_data.0.len() < core::u32::MAX as usize);
6170                 (key_data.0.len() as u32).write(writer)?;
6171                 writer.write_all(&key_data.0[..])?;
6172
6173                 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
6174                 // deserialized from that format.
6175                 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
6176                         Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
6177                         None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
6178                 }
6179                 self.destination_script.write(writer)?;
6180
6181                 self.cur_holder_commitment_transaction_number.write(writer)?;
6182                 self.cur_counterparty_commitment_transaction_number.write(writer)?;
6183                 self.value_to_self_msat.write(writer)?;
6184
6185                 let mut dropped_inbound_htlcs = 0;
6186                 for htlc in self.pending_inbound_htlcs.iter() {
6187                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
6188                                 dropped_inbound_htlcs += 1;
6189                         }
6190                 }
6191                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
6192                 for htlc in self.pending_inbound_htlcs.iter() {
6193                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
6194                                 continue; // Drop
6195                         }
6196                         htlc.htlc_id.write(writer)?;
6197                         htlc.amount_msat.write(writer)?;
6198                         htlc.cltv_expiry.write(writer)?;
6199                         htlc.payment_hash.write(writer)?;
6200                         match &htlc.state {
6201                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
6202                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
6203                                         1u8.write(writer)?;
6204                                         htlc_state.write(writer)?;
6205                                 },
6206                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
6207                                         2u8.write(writer)?;
6208                                         htlc_state.write(writer)?;
6209                                 },
6210                                 &InboundHTLCState::Committed => {
6211                                         3u8.write(writer)?;
6212                                 },
6213                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
6214                                         4u8.write(writer)?;
6215                                         removal_reason.write(writer)?;
6216                                 },
6217                         }
6218                 }
6219
6220                 let mut preimages: Vec<&Option<PaymentPreimage>> = vec![];
6221
6222                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
6223                 for htlc in self.pending_outbound_htlcs.iter() {
6224                         htlc.htlc_id.write(writer)?;
6225                         htlc.amount_msat.write(writer)?;
6226                         htlc.cltv_expiry.write(writer)?;
6227                         htlc.payment_hash.write(writer)?;
6228                         htlc.source.write(writer)?;
6229                         match &htlc.state {
6230                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
6231                                         0u8.write(writer)?;
6232                                         onion_packet.write(writer)?;
6233                                 },
6234                                 &OutboundHTLCState::Committed => {
6235                                         1u8.write(writer)?;
6236                                 },
6237                                 &OutboundHTLCState::RemoteRemoved(_) => {
6238                                         // Treat this as a Committed because we haven't received the CS - they'll
6239                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
6240                                         1u8.write(writer)?;
6241                                 },
6242                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref outcome) => {
6243                                         3u8.write(writer)?;
6244                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
6245                                                 preimages.push(preimage);
6246                                         }
6247                                         let reason: Option<&HTLCFailReason> = outcome.into();
6248                                         reason.write(writer)?;
6249                                 }
6250                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) => {
6251                                         4u8.write(writer)?;
6252                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
6253                                                 preimages.push(preimage);
6254                                         }
6255                                         let reason: Option<&HTLCFailReason> = outcome.into();
6256                                         reason.write(writer)?;
6257                                 }
6258                         }
6259                 }
6260
6261                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
6262                 for update in self.holding_cell_htlc_updates.iter() {
6263                         match update {
6264                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
6265                                         0u8.write(writer)?;
6266                                         amount_msat.write(writer)?;
6267                                         cltv_expiry.write(writer)?;
6268                                         payment_hash.write(writer)?;
6269                                         source.write(writer)?;
6270                                         onion_routing_packet.write(writer)?;
6271                                 },
6272                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
6273                                         1u8.write(writer)?;
6274                                         payment_preimage.write(writer)?;
6275                                         htlc_id.write(writer)?;
6276                                 },
6277                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
6278                                         2u8.write(writer)?;
6279                                         htlc_id.write(writer)?;
6280                                         err_packet.write(writer)?;
6281                                 }
6282                         }
6283                 }
6284
6285                 match self.resend_order {
6286                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
6287                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
6288                 }
6289
6290                 self.monitor_pending_channel_ready.write(writer)?;
6291                 self.monitor_pending_revoke_and_ack.write(writer)?;
6292                 self.monitor_pending_commitment_signed.write(writer)?;
6293
6294                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
6295                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
6296                         pending_forward.write(writer)?;
6297                         htlc_id.write(writer)?;
6298                 }
6299
6300                 (self.monitor_pending_failures.len() as u64).write(writer)?;
6301                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
6302                         htlc_source.write(writer)?;
6303                         payment_hash.write(writer)?;
6304                         fail_reason.write(writer)?;
6305                 }
6306
6307                 if self.is_outbound() {
6308                         self.pending_update_fee.map(|(a, _)| a).write(writer)?;
6309                 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
6310                         Some(feerate).write(writer)?;
6311                 } else {
6312                         // As for inbound HTLCs, if the update was only announced and never committed in a
6313                         // commitment_signed, drop it.
6314                         None::<u32>.write(writer)?;
6315                 }
6316                 self.holding_cell_update_fee.write(writer)?;
6317
6318                 self.next_holder_htlc_id.write(writer)?;
6319                 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
6320                 self.update_time_counter.write(writer)?;
6321                 self.feerate_per_kw.write(writer)?;
6322
6323                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
6324                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
6325                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
6326                 // consider the stale state on reload.
6327                 0u8.write(writer)?;
6328
6329                 self.funding_tx_confirmed_in.write(writer)?;
6330                 self.funding_tx_confirmation_height.write(writer)?;
6331                 self.short_channel_id.write(writer)?;
6332
6333                 self.counterparty_dust_limit_satoshis.write(writer)?;
6334                 self.holder_dust_limit_satoshis.write(writer)?;
6335                 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
6336
6337                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
6338                 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
6339
6340                 self.counterparty_htlc_minimum_msat.write(writer)?;
6341                 self.holder_htlc_minimum_msat.write(writer)?;
6342                 self.counterparty_max_accepted_htlcs.write(writer)?;
6343
6344                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
6345                 self.minimum_depth.unwrap_or(0).write(writer)?;
6346
6347                 match &self.counterparty_forwarding_info {
6348                         Some(info) => {
6349                                 1u8.write(writer)?;
6350                                 info.fee_base_msat.write(writer)?;
6351                                 info.fee_proportional_millionths.write(writer)?;
6352                                 info.cltv_expiry_delta.write(writer)?;
6353                         },
6354                         None => 0u8.write(writer)?
6355                 }
6356
6357                 self.channel_transaction_parameters.write(writer)?;
6358                 self.funding_transaction.write(writer)?;
6359
6360                 self.counterparty_cur_commitment_point.write(writer)?;
6361                 self.counterparty_prev_commitment_point.write(writer)?;
6362                 self.counterparty_node_id.write(writer)?;
6363
6364                 self.counterparty_shutdown_scriptpubkey.write(writer)?;
6365
6366                 self.commitment_secrets.write(writer)?;
6367
6368                 self.channel_update_status.write(writer)?;
6369
6370                 #[cfg(any(test, fuzzing))]
6371                 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
6372                 #[cfg(any(test, fuzzing))]
6373                 for htlc in self.historical_inbound_htlc_fulfills.iter() {
6374                         htlc.write(writer)?;
6375                 }
6376
6377                 // If the channel type is something other than only-static-remote-key, then we need to have
6378                 // older clients fail to deserialize this channel at all. If the type is
6379                 // only-static-remote-key, we simply consider it "default" and don't write the channel type
6380                 // out at all.
6381                 let chan_type = if self.channel_type != ChannelTypeFeatures::only_static_remote_key() {
6382                         Some(&self.channel_type) } else { None };
6383
6384                 // The same logic applies for `holder_selected_channel_reserve_satoshis` values other than
6385                 // the default, and when `holder_max_htlc_value_in_flight_msat` is configured to be set to
6386                 // a different percentage of the channel value then 10%, which older versions of LDK used
6387                 // to set it to before the percentage was made configurable.
6388                 let serialized_holder_selected_reserve =
6389                         if self.holder_selected_channel_reserve_satoshis != Self::get_legacy_default_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis)
6390                         { Some(self.holder_selected_channel_reserve_satoshis) } else { None };
6391
6392                 let mut old_max_in_flight_percent_config = UserConfig::default().channel_handshake_config;
6393                 old_max_in_flight_percent_config.max_inbound_htlc_value_in_flight_percent_of_channel = MAX_IN_FLIGHT_PERCENT_LEGACY;
6394                 let serialized_holder_htlc_max_in_flight =
6395                         if self.holder_max_htlc_value_in_flight_msat != Self::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis, &old_max_in_flight_percent_config)
6396                         { Some(self.holder_max_htlc_value_in_flight_msat) } else { None };
6397
6398                 let channel_ready_event_emitted = Some(self.channel_ready_event_emitted);
6399
6400                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
6401                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. Therefore,
6402                 // we write the high bytes as an option here.
6403                 let user_id_high_opt = Some((self.user_id >> 64) as u64);
6404
6405                 write_tlv_fields!(writer, {
6406                         (0, self.announcement_sigs, option),
6407                         // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
6408                         // default value instead of being Option<>al. Thus, to maintain compatibility we write
6409                         // them twice, once with their original default values above, and once as an option
6410                         // here. On the read side, old versions will simply ignore the odd-type entries here,
6411                         // and new versions map the default values to None and allow the TLV entries here to
6412                         // override that.
6413                         (1, self.minimum_depth, option),
6414                         (2, chan_type, option),
6415                         (3, self.counterparty_selected_channel_reserve_satoshis, option),
6416                         (4, serialized_holder_selected_reserve, option),
6417                         (5, self.config, required),
6418                         (6, serialized_holder_htlc_max_in_flight, option),
6419                         (7, self.shutdown_scriptpubkey, option),
6420                         (9, self.target_closing_feerate_sats_per_kw, option),
6421                         (11, self.monitor_pending_finalized_fulfills, vec_type),
6422                         (13, self.channel_creation_height, required),
6423                         (15, preimages, vec_type),
6424                         (17, self.announcement_sigs_state, required),
6425                         (19, self.latest_inbound_scid_alias, option),
6426                         (21, self.outbound_scid_alias, required),
6427                         (23, channel_ready_event_emitted, option),
6428                         (25, user_id_high_opt, option),
6429                         (27, self.channel_keys_id, required),
6430                 });
6431
6432                 Ok(())
6433         }
6434 }
6435
6436 const MAX_ALLOC_SIZE: usize = 64*1024;
6437 impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)> for Channel<<SP::Target as SignerProvider>::Signer>
6438                 where
6439                         ES::Target: EntropySource,
6440                         SP::Target: SignerProvider
6441 {
6442         fn read<R : io::Read>(reader: &mut R, args: (&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)) -> Result<Self, DecodeError> {
6443                 let (entropy_source, signer_provider, serialized_height, our_supported_features) = args;
6444                 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6445
6446                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
6447                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We read
6448                 // the low bytes now and the high bytes later.
6449                 let user_id_low: u64 = Readable::read(reader)?;
6450
6451                 let mut config = Some(LegacyChannelConfig::default());
6452                 if ver == 1 {
6453                         // Read the old serialization of the ChannelConfig from version 0.0.98.
6454                         config.as_mut().unwrap().options.forwarding_fee_proportional_millionths = Readable::read(reader)?;
6455                         config.as_mut().unwrap().options.cltv_expiry_delta = Readable::read(reader)?;
6456                         config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
6457                         config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
6458                 } else {
6459                         // Read the 8 bytes of backwards-compatibility ChannelConfig data.
6460                         let mut _val: u64 = Readable::read(reader)?;
6461                 }
6462
6463                 let channel_id = Readable::read(reader)?;
6464                 let channel_state = Readable::read(reader)?;
6465                 let channel_value_satoshis = Readable::read(reader)?;
6466
6467                 let latest_monitor_update_id = Readable::read(reader)?;
6468
6469                 let mut keys_data = None;
6470                 if ver <= 2 {
6471                         // Read the serialize signer bytes. We'll choose to deserialize them or not based on whether
6472                         // the `channel_keys_id` TLV is present below.
6473                         let keys_len: u32 = Readable::read(reader)?;
6474                         keys_data = Some(Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE)));
6475                         while keys_data.as_ref().unwrap().len() != keys_len as usize {
6476                                 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
6477                                 let mut data = [0; 1024];
6478                                 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.as_ref().unwrap().len())];
6479                                 reader.read_exact(read_slice)?;
6480                                 keys_data.as_mut().unwrap().extend_from_slice(read_slice);
6481                         }
6482                 }
6483
6484                 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
6485                 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
6486                         Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
6487                         Err(_) => None,
6488                 };
6489                 let destination_script = Readable::read(reader)?;
6490
6491                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
6492                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
6493                 let value_to_self_msat = Readable::read(reader)?;
6494
6495                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
6496                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
6497                 for _ in 0..pending_inbound_htlc_count {
6498                         pending_inbound_htlcs.push(InboundHTLCOutput {
6499                                 htlc_id: Readable::read(reader)?,
6500                                 amount_msat: Readable::read(reader)?,
6501                                 cltv_expiry: Readable::read(reader)?,
6502                                 payment_hash: Readable::read(reader)?,
6503                                 state: match <u8 as Readable>::read(reader)? {
6504                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
6505                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
6506                                         3 => InboundHTLCState::Committed,
6507                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
6508                                         _ => return Err(DecodeError::InvalidValue),
6509                                 },
6510                         });
6511                 }
6512
6513                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
6514                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
6515                 for _ in 0..pending_outbound_htlc_count {
6516                         pending_outbound_htlcs.push(OutboundHTLCOutput {
6517                                 htlc_id: Readable::read(reader)?,
6518                                 amount_msat: Readable::read(reader)?,
6519                                 cltv_expiry: Readable::read(reader)?,
6520                                 payment_hash: Readable::read(reader)?,
6521                                 source: Readable::read(reader)?,
6522                                 state: match <u8 as Readable>::read(reader)? {
6523                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
6524                                         1 => OutboundHTLCState::Committed,
6525                                         2 => {
6526                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6527                                                 OutboundHTLCState::RemoteRemoved(option.into())
6528                                         },
6529                                         3 => {
6530                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6531                                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(option.into())
6532                                         },
6533                                         4 => {
6534                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
6535                                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(option.into())
6536                                         },
6537                                         _ => return Err(DecodeError::InvalidValue),
6538                                 },
6539                         });
6540                 }
6541
6542                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
6543                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
6544                 for _ in 0..holding_cell_htlc_update_count {
6545                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
6546                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
6547                                         amount_msat: Readable::read(reader)?,
6548                                         cltv_expiry: Readable::read(reader)?,
6549                                         payment_hash: Readable::read(reader)?,
6550                                         source: Readable::read(reader)?,
6551                                         onion_routing_packet: Readable::read(reader)?,
6552                                 },
6553                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
6554                                         payment_preimage: Readable::read(reader)?,
6555                                         htlc_id: Readable::read(reader)?,
6556                                 },
6557                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
6558                                         htlc_id: Readable::read(reader)?,
6559                                         err_packet: Readable::read(reader)?,
6560                                 },
6561                                 _ => return Err(DecodeError::InvalidValue),
6562                         });
6563                 }
6564
6565                 let resend_order = match <u8 as Readable>::read(reader)? {
6566                         0 => RAACommitmentOrder::CommitmentFirst,
6567                         1 => RAACommitmentOrder::RevokeAndACKFirst,
6568                         _ => return Err(DecodeError::InvalidValue),
6569                 };
6570
6571                 let monitor_pending_channel_ready = Readable::read(reader)?;
6572                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
6573                 let monitor_pending_commitment_signed = Readable::read(reader)?;
6574
6575                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
6576                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
6577                 for _ in 0..monitor_pending_forwards_count {
6578                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
6579                 }
6580
6581                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
6582                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
6583                 for _ in 0..monitor_pending_failures_count {
6584                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
6585                 }
6586
6587                 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
6588
6589                 let holding_cell_update_fee = Readable::read(reader)?;
6590
6591                 let next_holder_htlc_id = Readable::read(reader)?;
6592                 let next_counterparty_htlc_id = Readable::read(reader)?;
6593                 let update_time_counter = Readable::read(reader)?;
6594                 let feerate_per_kw = Readable::read(reader)?;
6595
6596                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
6597                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
6598                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
6599                 // consider the stale state on reload.
6600                 match <u8 as Readable>::read(reader)? {
6601                         0 => {},
6602                         1 => {
6603                                 let _: u32 = Readable::read(reader)?;
6604                                 let _: u64 = Readable::read(reader)?;
6605                                 let _: Signature = Readable::read(reader)?;
6606                         },
6607                         _ => return Err(DecodeError::InvalidValue),
6608                 }
6609
6610                 let funding_tx_confirmed_in = Readable::read(reader)?;
6611                 let funding_tx_confirmation_height = Readable::read(reader)?;
6612                 let short_channel_id = Readable::read(reader)?;
6613
6614                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
6615                 let holder_dust_limit_satoshis = Readable::read(reader)?;
6616                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
6617                 let mut counterparty_selected_channel_reserve_satoshis = None;
6618                 if ver == 1 {
6619                         // Read the old serialization from version 0.0.98.
6620                         counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
6621                 } else {
6622                         // Read the 8 bytes of backwards-compatibility data.
6623                         let _dummy: u64 = Readable::read(reader)?;
6624                 }
6625                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
6626                 let holder_htlc_minimum_msat = Readable::read(reader)?;
6627                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
6628
6629                 let mut minimum_depth = None;
6630                 if ver == 1 {
6631                         // Read the old serialization from version 0.0.98.
6632                         minimum_depth = Some(Readable::read(reader)?);
6633                 } else {
6634                         // Read the 4 bytes of backwards-compatibility data.
6635                         let _dummy: u32 = Readable::read(reader)?;
6636                 }
6637
6638                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
6639                         0 => None,
6640                         1 => Some(CounterpartyForwardingInfo {
6641                                 fee_base_msat: Readable::read(reader)?,
6642                                 fee_proportional_millionths: Readable::read(reader)?,
6643                                 cltv_expiry_delta: Readable::read(reader)?,
6644                         }),
6645                         _ => return Err(DecodeError::InvalidValue),
6646                 };
6647
6648                 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
6649                 let funding_transaction = Readable::read(reader)?;
6650
6651                 let counterparty_cur_commitment_point = Readable::read(reader)?;
6652
6653                 let counterparty_prev_commitment_point = Readable::read(reader)?;
6654                 let counterparty_node_id = Readable::read(reader)?;
6655
6656                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
6657                 let commitment_secrets = Readable::read(reader)?;
6658
6659                 let channel_update_status = Readable::read(reader)?;
6660
6661                 #[cfg(any(test, fuzzing))]
6662                 let mut historical_inbound_htlc_fulfills = HashSet::new();
6663                 #[cfg(any(test, fuzzing))]
6664                 {
6665                         let htlc_fulfills_len: u64 = Readable::read(reader)?;
6666                         for _ in 0..htlc_fulfills_len {
6667                                 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
6668                         }
6669                 }
6670
6671                 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
6672                         Some((feerate, if channel_parameters.is_outbound_from_holder {
6673                                 FeeUpdateState::Outbound
6674                         } else {
6675                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
6676                         }))
6677                 } else {
6678                         None
6679                 };
6680
6681                 let mut announcement_sigs = None;
6682                 let mut target_closing_feerate_sats_per_kw = None;
6683                 let mut monitor_pending_finalized_fulfills = Some(Vec::new());
6684                 let mut holder_selected_channel_reserve_satoshis = Some(Self::get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis));
6685                 let mut holder_max_htlc_value_in_flight_msat = Some(Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &UserConfig::default().channel_handshake_config));
6686                 // Prior to supporting channel type negotiation, all of our channels were static_remotekey
6687                 // only, so we default to that if none was written.
6688                 let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
6689                 let mut channel_creation_height = Some(serialized_height);
6690                 let mut preimages_opt: Option<Vec<Option<PaymentPreimage>>> = None;
6691
6692                 // If we read an old Channel, for simplicity we just treat it as "we never sent an
6693                 // AnnouncementSignatures" which implies we'll re-send it on reconnect, but that's fine.
6694                 let mut announcement_sigs_state = Some(AnnouncementSigsState::NotSent);
6695                 let mut latest_inbound_scid_alias = None;
6696                 let mut outbound_scid_alias = None;
6697                 let mut channel_ready_event_emitted = None;
6698
6699                 let mut user_id_high_opt: Option<u64> = None;
6700                 let mut channel_keys_id: Option<[u8; 32]> = None;
6701
6702                 read_tlv_fields!(reader, {
6703                         (0, announcement_sigs, option),
6704                         (1, minimum_depth, option),
6705                         (2, channel_type, option),
6706                         (3, counterparty_selected_channel_reserve_satoshis, option),
6707                         (4, holder_selected_channel_reserve_satoshis, option),
6708                         (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
6709                         (6, holder_max_htlc_value_in_flight_msat, option),
6710                         (7, shutdown_scriptpubkey, option),
6711                         (9, target_closing_feerate_sats_per_kw, option),
6712                         (11, monitor_pending_finalized_fulfills, vec_type),
6713                         (13, channel_creation_height, option),
6714                         (15, preimages_opt, vec_type),
6715                         (17, announcement_sigs_state, option),
6716                         (19, latest_inbound_scid_alias, option),
6717                         (21, outbound_scid_alias, option),
6718                         (23, channel_ready_event_emitted, option),
6719                         (25, user_id_high_opt, option),
6720                         (27, channel_keys_id, option),
6721                 });
6722
6723                 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
6724                         let mut holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
6725                         // If we've gotten to the funding stage of the channel, populate the signer with its
6726                         // required channel parameters.
6727                         let non_shutdown_state = channel_state & (!MULTI_STATE_FLAGS);
6728                         if non_shutdown_state >= (ChannelState::FundingCreated as u32) {
6729                                 holder_signer.provide_channel_parameters(&channel_parameters);
6730                         }
6731                         (channel_keys_id, holder_signer)
6732                 } else {
6733                         // `keys_data` can be `None` if we had corrupted data.
6734                         let keys_data = keys_data.ok_or(DecodeError::InvalidValue)?;
6735                         let holder_signer = signer_provider.read_chan_signer(&keys_data)?;
6736                         (holder_signer.channel_keys_id(), holder_signer)
6737                 };
6738
6739                 if let Some(preimages) = preimages_opt {
6740                         let mut iter = preimages.into_iter();
6741                         for htlc in pending_outbound_htlcs.iter_mut() {
6742                                 match &htlc.state {
6743                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(None)) => {
6744                                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
6745                                         }
6746                                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(None)) => {
6747                                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
6748                                         }
6749                                         _ => {}
6750                                 }
6751                         }
6752                         // We expect all preimages to be consumed above
6753                         if iter.next().is_some() {
6754                                 return Err(DecodeError::InvalidValue);
6755                         }
6756                 }
6757
6758                 let chan_features = channel_type.as_ref().unwrap();
6759                 if !chan_features.is_subset(our_supported_features) {
6760                         // If the channel was written by a new version and negotiated with features we don't
6761                         // understand yet, refuse to read it.
6762                         return Err(DecodeError::UnknownRequiredFeature);
6763                 }
6764
6765                 let mut secp_ctx = Secp256k1::new();
6766                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
6767
6768                 // `user_id` used to be a single u64 value. In order to remain backwards
6769                 // compatible with versions prior to 0.0.113, the u128 is serialized as two
6770                 // separate u64 values.
6771                 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);
6772
6773                 Ok(Channel {
6774                         user_id,
6775
6776                         config: config.unwrap(),
6777
6778                         prev_config: None,
6779
6780                         // Note that we don't care about serializing handshake limits as we only ever serialize
6781                         // channel data after the handshake has completed.
6782                         inbound_handshake_limits_override: None,
6783
6784                         channel_id,
6785                         channel_state,
6786                         announcement_sigs_state: announcement_sigs_state.unwrap(),
6787                         secp_ctx,
6788                         channel_value_satoshis,
6789
6790                         latest_monitor_update_id,
6791
6792                         holder_signer,
6793                         shutdown_scriptpubkey,
6794                         destination_script,
6795
6796                         cur_holder_commitment_transaction_number,
6797                         cur_counterparty_commitment_transaction_number,
6798                         value_to_self_msat,
6799
6800                         pending_inbound_htlcs,
6801                         pending_outbound_htlcs,
6802                         holding_cell_htlc_updates,
6803
6804                         resend_order,
6805
6806                         monitor_pending_channel_ready,
6807                         monitor_pending_revoke_and_ack,
6808                         monitor_pending_commitment_signed,
6809                         monitor_pending_forwards,
6810                         monitor_pending_failures,
6811                         monitor_pending_finalized_fulfills: monitor_pending_finalized_fulfills.unwrap(),
6812
6813                         pending_update_fee,
6814                         holding_cell_update_fee,
6815                         next_holder_htlc_id,
6816                         next_counterparty_htlc_id,
6817                         update_time_counter,
6818                         feerate_per_kw,
6819
6820                         #[cfg(debug_assertions)]
6821                         holder_max_commitment_tx_output: Mutex::new((0, 0)),
6822                         #[cfg(debug_assertions)]
6823                         counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
6824
6825                         last_sent_closing_fee: None,
6826                         pending_counterparty_closing_signed: None,
6827                         closing_fee_limits: None,
6828                         target_closing_feerate_sats_per_kw,
6829
6830                         inbound_awaiting_accept: false,
6831
6832                         funding_tx_confirmed_in,
6833                         funding_tx_confirmation_height,
6834                         short_channel_id,
6835                         channel_creation_height: channel_creation_height.unwrap(),
6836
6837                         counterparty_dust_limit_satoshis,
6838                         holder_dust_limit_satoshis,
6839                         counterparty_max_htlc_value_in_flight_msat,
6840                         holder_max_htlc_value_in_flight_msat: holder_max_htlc_value_in_flight_msat.unwrap(),
6841                         counterparty_selected_channel_reserve_satoshis,
6842                         holder_selected_channel_reserve_satoshis: holder_selected_channel_reserve_satoshis.unwrap(),
6843                         counterparty_htlc_minimum_msat,
6844                         holder_htlc_minimum_msat,
6845                         counterparty_max_accepted_htlcs,
6846                         minimum_depth,
6847
6848                         counterparty_forwarding_info,
6849
6850                         channel_transaction_parameters: channel_parameters,
6851                         funding_transaction,
6852
6853                         counterparty_cur_commitment_point,
6854                         counterparty_prev_commitment_point,
6855                         counterparty_node_id,
6856
6857                         counterparty_shutdown_scriptpubkey,
6858
6859                         commitment_secrets,
6860
6861                         channel_update_status,
6862                         closing_signed_in_flight: false,
6863
6864                         announcement_sigs,
6865
6866                         #[cfg(any(test, fuzzing))]
6867                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
6868                         #[cfg(any(test, fuzzing))]
6869                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
6870
6871                         workaround_lnd_bug_4006: None,
6872
6873                         latest_inbound_scid_alias,
6874                         // Later in the ChannelManager deserialization phase we scan for channels and assign scid aliases if its missing
6875                         outbound_scid_alias: outbound_scid_alias.unwrap_or(0),
6876
6877                         channel_ready_event_emitted: channel_ready_event_emitted.unwrap_or(true),
6878
6879                         #[cfg(any(test, fuzzing))]
6880                         historical_inbound_htlc_fulfills,
6881
6882                         channel_type: channel_type.unwrap(),
6883                         channel_keys_id,
6884
6885                         pending_monitor_updates: Vec::new(),
6886                 })
6887         }
6888 }
6889
6890 #[cfg(test)]
6891 mod tests {
6892         use std::cmp;
6893         use bitcoin::blockdata::script::{Script, Builder};
6894         use bitcoin::blockdata::transaction::{Transaction, TxOut};
6895         use bitcoin::blockdata::constants::genesis_block;
6896         use bitcoin::blockdata::opcodes;
6897         use bitcoin::network::constants::Network;
6898         use hex;
6899         use crate::ln::PaymentHash;
6900         use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
6901         #[cfg(anchors)]
6902         use crate::ln::channel::InitFeatures;
6903         use crate::ln::channel::{Channel, InboundHTLCOutput, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator};
6904         use crate::ln::channel::{MAX_FUNDING_SATOSHIS_NO_WUMBO, TOTAL_BITCOIN_SUPPLY_SATOSHIS, MIN_THEIR_CHAN_RESERVE_SATOSHIS};
6905         use crate::ln::features::ChannelTypeFeatures;
6906         use crate::ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate, MAX_VALUE_MSAT};
6907         use crate::ln::script::ShutdownScript;
6908         use crate::ln::chan_utils;
6909         use crate::ln::chan_utils::{htlc_success_tx_weight, htlc_timeout_tx_weight};
6910         use crate::chain::BestBlock;
6911         use crate::chain::chaininterface::{FeeEstimator, LowerBoundedFeeEstimator, ConfirmationTarget};
6912         use crate::chain::keysinterface::{ChannelSigner, InMemorySigner, EntropySource, SignerProvider};
6913         use crate::chain::transaction::OutPoint;
6914         use crate::util::config::UserConfig;
6915         use crate::util::enforcing_trait_impls::EnforcingSigner;
6916         use crate::util::errors::APIError;
6917         use crate::util::test_utils;
6918         use crate::util::test_utils::OnGetShutdownScriptpubkey;
6919         use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
6920         use bitcoin::secp256k1::ffi::Signature as FFISignature;
6921         use bitcoin::secp256k1::{SecretKey,PublicKey};
6922         use bitcoin::hashes::sha256::Hash as Sha256;
6923         use bitcoin::hashes::Hash;
6924         use bitcoin::hash_types::WPubkeyHash;
6925         use bitcoin::PackedLockTime;
6926         use bitcoin::util::address::WitnessVersion;
6927         use crate::prelude::*;
6928
6929         struct TestFeeEstimator {
6930                 fee_est: u32
6931         }
6932         impl FeeEstimator for TestFeeEstimator {
6933                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
6934                         self.fee_est
6935                 }
6936         }
6937
6938         #[test]
6939         fn test_max_funding_satoshis_no_wumbo() {
6940                 assert_eq!(TOTAL_BITCOIN_SUPPLY_SATOSHIS, 21_000_000 * 100_000_000);
6941                 assert!(MAX_FUNDING_SATOSHIS_NO_WUMBO <= TOTAL_BITCOIN_SUPPLY_SATOSHIS,
6942                         "MAX_FUNDING_SATOSHIS_NO_WUMBO is greater than all satoshis in existence");
6943         }
6944
6945         #[test]
6946         fn test_no_fee_check_overflow() {
6947                 // Previously, calling `check_remote_fee` with a fee of 0xffffffff would overflow in
6948                 // arithmetic, causing a panic with debug assertions enabled.
6949                 let fee_est = TestFeeEstimator { fee_est: 42 };
6950                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
6951                 assert!(Channel::<InMemorySigner>::check_remote_fee(&bounded_fee_estimator,
6952                         u32::max_value(), None, &&test_utils::TestLogger::new()).is_err());
6953         }
6954
6955         struct Keys {
6956                 signer: InMemorySigner,
6957         }
6958
6959         impl EntropySource for Keys {
6960                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
6961         }
6962
6963         impl SignerProvider for Keys {
6964                 type Signer = InMemorySigner;
6965
6966                 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
6967                         self.signer.channel_keys_id()
6968                 }
6969
6970                 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer {
6971                         self.signer.clone()
6972                 }
6973
6974                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
6975
6976                 fn get_destination_script(&self) -> Script {
6977                         let secp_ctx = Secp256k1::signing_only();
6978                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
6979                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
6980                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
6981                 }
6982
6983                 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
6984                         let secp_ctx = Secp256k1::signing_only();
6985                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
6986                         ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
6987                 }
6988         }
6989
6990         #[cfg(not(feature = "grind_signatures"))]
6991         fn public_from_secret_hex(secp_ctx: &Secp256k1<bitcoin::secp256k1::All>, hex: &str) -> PublicKey {
6992                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
6993         }
6994
6995         #[test]
6996         fn upfront_shutdown_script_incompatibility() {
6997                 let features = channelmanager::provided_init_features(&UserConfig::default()).clear_shutdown_anysegwit();
6998                 let non_v0_segwit_shutdown_script =
6999                         ShutdownScript::new_witness_program(WitnessVersion::V16, &[0, 40]).unwrap();
7000
7001                 let seed = [42; 32];
7002                 let network = Network::Testnet;
7003                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7004                 keys_provider.expect(OnGetShutdownScriptpubkey {
7005                         returns: non_v0_segwit_shutdown_script.clone(),
7006                 });
7007
7008                 let secp_ctx = Secp256k1::new();
7009                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7010                 let config = UserConfig::default();
7011                 match Channel::<EnforcingSigner>::new_outbound(&LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 253 }), &&keys_provider, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config, 0, 42) {
7012                         Err(APIError::IncompatibleShutdownScript { script }) => {
7013                                 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
7014                         },
7015                         Err(e) => panic!("Unexpected error: {:?}", e),
7016                         Ok(_) => panic!("Expected error"),
7017                 }
7018         }
7019
7020         // Check that, during channel creation, we use the same feerate in the open channel message
7021         // as we do in the Channel object creation itself.
7022         #[test]
7023         fn test_open_channel_msg_fee() {
7024                 let original_fee = 253;
7025                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
7026                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
7027                 let secp_ctx = Secp256k1::new();
7028                 let seed = [42; 32];
7029                 let network = Network::Testnet;
7030                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7031
7032                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7033                 let config = UserConfig::default();
7034                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&bounded_fee_estimator, &&keys_provider, &&keys_provider, node_a_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
7035
7036                 // Now change the fee so we can check that the fee in the open_channel message is the
7037                 // same as the old fee.
7038                 fee_est.fee_est = 500;
7039                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
7040                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
7041         }
7042
7043         #[test]
7044         fn test_holder_vs_counterparty_dust_limit() {
7045                 // Test that when calculating the local and remote commitment transaction fees, the correct
7046                 // dust limits are used.
7047                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7048                 let secp_ctx = Secp256k1::new();
7049                 let seed = [42; 32];
7050                 let network = Network::Testnet;
7051                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7052                 let logger = test_utils::TestLogger::new();
7053
7054                 // Go through the flow of opening a channel between two nodes, making sure
7055                 // they have different dust limits.
7056
7057                 // Create Node A's channel pointing to Node B's pubkey
7058                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7059                 let config = UserConfig::default();
7060                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
7061
7062                 // Create Node B's channel by receiving Node A's open_channel message
7063                 // Make sure A's dust limit is as we expect.
7064                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
7065                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7066                 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
7067
7068                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
7069                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel(0);
7070                 accept_channel_msg.dust_limit_satoshis = 546;
7071                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
7072                 node_a_chan.holder_dust_limit_satoshis = 1560;
7073
7074                 // Put some inbound and outbound HTLCs in A's channel.
7075                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
7076                 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
7077                         htlc_id: 0,
7078                         amount_msat: htlc_amount_msat,
7079                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
7080                         cltv_expiry: 300000000,
7081                         state: InboundHTLCState::Committed,
7082                 });
7083
7084                 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
7085                         htlc_id: 1,
7086                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
7087                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
7088                         cltv_expiry: 200000000,
7089                         state: OutboundHTLCState::Committed,
7090                         source: HTLCSource::OutboundRoute {
7091                                 path: Vec::new(),
7092                                 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
7093                                 first_hop_htlc_msat: 548,
7094                                 payment_id: PaymentId([42; 32]),
7095                                 payment_secret: None,
7096                                 payment_params: None,
7097                         }
7098                 });
7099
7100                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
7101                 // the dust limit check.
7102                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
7103                 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
7104                 let local_commit_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 0, node_a_chan.opt_anchors());
7105                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
7106
7107                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
7108                 // of the HTLCs are seen to be above the dust limit.
7109                 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
7110                 let remote_commit_fee_3_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 3, node_a_chan.opt_anchors());
7111                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
7112                 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
7113                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
7114         }
7115
7116         #[test]
7117         fn test_timeout_vs_success_htlc_dust_limit() {
7118                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
7119                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
7120                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
7121                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
7122                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 253 });
7123                 let secp_ctx = Secp256k1::new();
7124                 let seed = [42; 32];
7125                 let network = Network::Testnet;
7126                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7127
7128                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7129                 let config = UserConfig::default();
7130                 let mut chan = Channel::<EnforcingSigner>::new_outbound(&fee_est, &&keys_provider, &&keys_provider, node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
7131
7132                 let commitment_tx_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 0, chan.opt_anchors());
7133                 let commitment_tx_fee_1_htlc = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 1, chan.opt_anchors());
7134
7135                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
7136                 // counted as dust when it shouldn't be.
7137                 let htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.opt_anchors()) / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
7138                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
7139                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
7140                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
7141
7142                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
7143                 let dust_htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.opt_anchors()) / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
7144                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
7145                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
7146                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
7147
7148                 chan.channel_transaction_parameters.is_outbound_from_holder = false;
7149
7150                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
7151                 let dust_htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.opt_anchors()) / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
7152                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
7153                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
7154                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
7155
7156                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
7157                 let htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.opt_anchors()) / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
7158                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
7159                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
7160                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
7161         }
7162
7163         #[test]
7164         fn channel_reestablish_no_updates() {
7165                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7166                 let logger = test_utils::TestLogger::new();
7167                 let secp_ctx = Secp256k1::new();
7168                 let seed = [42; 32];
7169                 let network = Network::Testnet;
7170                 let best_block = BestBlock::from_genesis(network);
7171                 let chain_hash = best_block.block_hash();
7172                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7173
7174                 // Go through the flow of opening a channel between two nodes.
7175
7176                 // Create Node A's channel pointing to Node B's pubkey
7177                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7178                 let config = UserConfig::default();
7179                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
7180
7181                 // Create Node B's channel by receiving Node A's open_channel message
7182                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
7183                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7184                 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42).unwrap();
7185
7186                 // Node B --> Node A: accept channel
7187                 let accept_channel_msg = node_b_chan.accept_inbound_channel(0);
7188                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
7189
7190                 // Node A --> Node B: funding created
7191                 let output_script = node_a_chan.get_funding_redeemscript();
7192                 let tx = Transaction { version: 1, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
7193                         value: 10000000, script_pubkey: output_script.clone(),
7194                 }]};
7195                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
7196                 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
7197                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).unwrap();
7198
7199                 // Node B --> Node A: funding signed
7200                 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&keys_provider, &&logger);
7201
7202                 // Now disconnect the two nodes and check that the commitment point in
7203                 // Node B's channel_reestablish message is sane.
7204                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
7205                 let msg = node_b_chan.get_channel_reestablish(&&logger);
7206                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
7207                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
7208                 match msg.data_loss_protect {
7209                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
7210                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
7211                         },
7212                         _ => panic!()
7213                 }
7214
7215                 // Check that the commitment point in Node A's channel_reestablish message
7216                 // is sane.
7217                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
7218                 let msg = node_a_chan.get_channel_reestablish(&&logger);
7219                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
7220                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
7221                 match msg.data_loss_protect {
7222                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
7223                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
7224                         },
7225                         _ => panic!()
7226                 }
7227         }
7228
7229         #[test]
7230         fn test_configured_holder_max_htlc_value_in_flight() {
7231                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7232                 let logger = test_utils::TestLogger::new();
7233                 let secp_ctx = Secp256k1::new();
7234                 let seed = [42; 32];
7235                 let network = Network::Testnet;
7236                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7237                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7238                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7239
7240                 let mut config_2_percent = UserConfig::default();
7241                 config_2_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 2;
7242                 let mut config_99_percent = UserConfig::default();
7243                 config_99_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 99;
7244                 let mut config_0_percent = UserConfig::default();
7245                 config_0_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 0;
7246                 let mut config_101_percent = UserConfig::default();
7247                 config_101_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 101;
7248
7249                 // Test that `new_outbound` creates a channel with the correct value for
7250                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
7251                 // which is set to the lower bound + 1 (2%) of the `channel_value`.
7252                 let chan_1 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_2_percent), 10000000, 100000, 42, &config_2_percent, 0, 42).unwrap();
7253                 let chan_1_value_msat = chan_1.channel_value_satoshis * 1000;
7254                 assert_eq!(chan_1.holder_max_htlc_value_in_flight_msat, (chan_1_value_msat as f64 * 0.02) as u64);
7255
7256                 // Test with the upper bound - 1 of valid values (99%).
7257                 let chan_2 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_99_percent), 10000000, 100000, 42, &config_99_percent, 0, 42).unwrap();
7258                 let chan_2_value_msat = chan_2.channel_value_satoshis * 1000;
7259                 assert_eq!(chan_2.holder_max_htlc_value_in_flight_msat, (chan_2_value_msat as f64 * 0.99) as u64);
7260
7261                 let chan_1_open_channel_msg = chan_1.get_open_channel(genesis_block(network).header.block_hash());
7262
7263                 // Test that `new_from_req` creates a channel with the correct value for
7264                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
7265                 // which is set to the lower bound - 1 (2%) of the `channel_value`.
7266                 let chan_3 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_2_percent), &channelmanager::provided_init_features(&config_2_percent), &chan_1_open_channel_msg, 7, &config_2_percent, 0, &&logger, 42).unwrap();
7267                 let chan_3_value_msat = chan_3.channel_value_satoshis * 1000;
7268                 assert_eq!(chan_3.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.02) as u64);
7269
7270                 // Test with the upper bound - 1 of valid values (99%).
7271                 let chan_4 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_99_percent), &channelmanager::provided_init_features(&config_99_percent), &chan_1_open_channel_msg, 7, &config_99_percent, 0, &&logger, 42).unwrap();
7272                 let chan_4_value_msat = chan_4.channel_value_satoshis * 1000;
7273                 assert_eq!(chan_4.holder_max_htlc_value_in_flight_msat, (chan_4_value_msat as f64 * 0.99) as u64);
7274
7275                 // Test that `new_outbound` uses the lower bound of the configurable percentage values (1%)
7276                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
7277                 let chan_5 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_0_percent), 10000000, 100000, 42, &config_0_percent, 0, 42).unwrap();
7278                 let chan_5_value_msat = chan_5.channel_value_satoshis * 1000;
7279                 assert_eq!(chan_5.holder_max_htlc_value_in_flight_msat, (chan_5_value_msat as f64 * 0.01) as u64);
7280
7281                 // Test that `new_outbound` uses the upper bound of the configurable percentage values
7282                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
7283                 // than 100.
7284                 let chan_6 = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_101_percent), 10000000, 100000, 42, &config_101_percent, 0, 42).unwrap();
7285                 let chan_6_value_msat = chan_6.channel_value_satoshis * 1000;
7286                 assert_eq!(chan_6.holder_max_htlc_value_in_flight_msat, chan_6_value_msat);
7287
7288                 // Test that `new_from_req` uses the lower bound of the configurable percentage values (1%)
7289                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
7290                 let chan_7 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_0_percent), &channelmanager::provided_init_features(&config_0_percent), &chan_1_open_channel_msg, 7, &config_0_percent, 0, &&logger, 42).unwrap();
7291                 let chan_7_value_msat = chan_7.channel_value_satoshis * 1000;
7292                 assert_eq!(chan_7.holder_max_htlc_value_in_flight_msat, (chan_7_value_msat as f64 * 0.01) as u64);
7293
7294                 // Test that `new_from_req` uses the upper bound of the configurable percentage values
7295                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
7296                 // than 100.
7297                 let chan_8 = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&config_101_percent), &channelmanager::provided_init_features(&config_101_percent), &chan_1_open_channel_msg, 7, &config_101_percent, 0, &&logger, 42).unwrap();
7298                 let chan_8_value_msat = chan_8.channel_value_satoshis * 1000;
7299                 assert_eq!(chan_8.holder_max_htlc_value_in_flight_msat, chan_8_value_msat);
7300         }
7301
7302         #[test]
7303         fn test_configured_holder_selected_channel_reserve_satoshis() {
7304
7305                 // Test that `new_outbound` and `new_from_req` create a channel with the correct
7306                 // channel reserves, when `their_channel_reserve_proportional_millionths` is configured.
7307                 test_self_and_counterparty_channel_reserve(10_000_000, 0.02, 0.02);
7308
7309                 // Test with valid but unreasonably high channel reserves
7310                 // Requesting and accepting parties have requested for 49%-49% and 60%-30% channel reserve
7311                 test_self_and_counterparty_channel_reserve(10_000_000, 0.49, 0.49);
7312                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.30);
7313
7314                 // Test with calculated channel reserve less than lower bound
7315                 // i.e `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
7316                 test_self_and_counterparty_channel_reserve(100_000, 0.00002, 0.30);
7317
7318                 // Test with invalid channel reserves since sum of both is greater than or equal
7319                 // to channel value
7320                 test_self_and_counterparty_channel_reserve(10_000_000, 0.50, 0.50);
7321                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.50);
7322         }
7323
7324         fn test_self_and_counterparty_channel_reserve(channel_value_satoshis: u64, outbound_selected_channel_reserve_perc: f64, inbound_selected_channel_reserve_perc: f64) {
7325                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 15_000 });
7326                 let logger = test_utils::TestLogger::new();
7327                 let secp_ctx = Secp256k1::new();
7328                 let seed = [42; 32];
7329                 let network = Network::Testnet;
7330                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7331                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7332                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
7333
7334
7335                 let mut outbound_node_config = UserConfig::default();
7336                 outbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (outbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
7337                 let chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&outbound_node_config), channel_value_satoshis, 100_000, 42, &outbound_node_config, 0, 42).unwrap();
7338
7339                 let expected_outbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.channel_value_satoshis as f64 * outbound_selected_channel_reserve_perc) as u64);
7340                 assert_eq!(chan.holder_selected_channel_reserve_satoshis, expected_outbound_selected_chan_reserve);
7341
7342                 let chan_open_channel_msg = chan.get_open_channel(genesis_block(network).header.block_hash());
7343                 let mut inbound_node_config = UserConfig::default();
7344                 inbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (inbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
7345
7346                 if outbound_selected_channel_reserve_perc + inbound_selected_channel_reserve_perc < 1.0 {
7347                         let chan_inbound_node = Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42).unwrap();
7348
7349                         let expected_inbound_selected_chan_reserve = cmp::max(MIN_THEIR_CHAN_RESERVE_SATOSHIS, (chan.channel_value_satoshis as f64 * inbound_selected_channel_reserve_perc) as u64);
7350
7351                         assert_eq!(chan_inbound_node.holder_selected_channel_reserve_satoshis, expected_inbound_selected_chan_reserve);
7352                         assert_eq!(chan_inbound_node.counterparty_selected_channel_reserve_satoshis.unwrap(), expected_outbound_selected_chan_reserve);
7353                 } else {
7354                         // Channel Negotiations failed
7355                         let result = Channel::<EnforcingSigner>::new_from_req(&&fee_est, &&keys_provider, &&keys_provider, inbound_node_id, &channelmanager::provided_channel_type_features(&inbound_node_config), &channelmanager::provided_init_features(&outbound_node_config), &chan_open_channel_msg, 7, &inbound_node_config, 0, &&logger, 42);
7356                         assert!(result.is_err());
7357                 }
7358         }
7359
7360         #[test]
7361         fn channel_update() {
7362                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
7363                 let secp_ctx = Secp256k1::new();
7364                 let seed = [42; 32];
7365                 let network = Network::Testnet;
7366                 let chain_hash = genesis_block(network).header.block_hash();
7367                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
7368
7369                 // Create a channel.
7370                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7371                 let config = UserConfig::default();
7372                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
7373                 assert!(node_a_chan.counterparty_forwarding_info.is_none());
7374                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
7375                 assert!(node_a_chan.counterparty_forwarding_info().is_none());
7376
7377                 // Make sure that receiving a channel update will update the Channel as expected.
7378                 let update = ChannelUpdate {
7379                         contents: UnsignedChannelUpdate {
7380                                 chain_hash,
7381                                 short_channel_id: 0,
7382                                 timestamp: 0,
7383                                 flags: 0,
7384                                 cltv_expiry_delta: 100,
7385                                 htlc_minimum_msat: 5,
7386                                 htlc_maximum_msat: MAX_VALUE_MSAT,
7387                                 fee_base_msat: 110,
7388                                 fee_proportional_millionths: 11,
7389                                 excess_data: Vec::new(),
7390                         },
7391                         signature: Signature::from(unsafe { FFISignature::new() })
7392                 };
7393                 node_a_chan.channel_update(&update).unwrap();
7394
7395                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
7396                 // change our official htlc_minimum_msat.
7397                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
7398                 match node_a_chan.counterparty_forwarding_info() {
7399                         Some(info) => {
7400                                 assert_eq!(info.cltv_expiry_delta, 100);
7401                                 assert_eq!(info.fee_base_msat, 110);
7402                                 assert_eq!(info.fee_proportional_millionths, 11);
7403                         },
7404                         None => panic!("expected counterparty forwarding info to be Some")
7405                 }
7406         }
7407
7408         #[cfg(not(feature = "grind_signatures"))]
7409         #[test]
7410         fn outbound_commitment_test() {
7411                 use bitcoin::util::sighash;
7412                 use bitcoin::consensus::encode::serialize;
7413                 use bitcoin::blockdata::transaction::EcdsaSighashType;
7414                 use bitcoin::hashes::hex::FromHex;
7415                 use bitcoin::hash_types::Txid;
7416                 use bitcoin::secp256k1::Message;
7417                 use crate::chain::keysinterface::EcdsaChannelSigner;
7418                 use crate::ln::PaymentPreimage;
7419                 use crate::ln::channel::{HTLCOutputInCommitment ,TxCreationKeys};
7420                 use crate::ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
7421                 use crate::util::logger::Logger;
7422                 use crate::sync::Arc;
7423
7424                 // Test vectors from BOLT 3 Appendices C and F (anchors):
7425                 let feeest = TestFeeEstimator{fee_est: 15000};
7426                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
7427                 let secp_ctx = Secp256k1::new();
7428
7429                 let mut signer = InMemorySigner::new(
7430                         &secp_ctx,
7431                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
7432                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
7433                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
7434                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
7435                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
7436
7437                         // These aren't set in the test vectors:
7438                         [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],
7439                         10_000_000,
7440                         [0; 32],
7441                 );
7442
7443                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
7444                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
7445                 let keys_provider = Keys { signer: signer.clone() };
7446
7447                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
7448                 let mut config = UserConfig::default();
7449                 config.channel_handshake_config.announced_channel = false;
7450                 let mut chan = Channel::<InMemorySigner>::new_outbound(&LowerBoundedFeeEstimator::new(&feeest), &&keys_provider, &&keys_provider, counterparty_node_id, &channelmanager::provided_init_features(&config), 10_000_000, 100000, 42, &config, 0, 42).unwrap(); // Nothing uses their network key in this test
7451                 chan.holder_dust_limit_satoshis = 546;
7452                 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
7453
7454                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
7455
7456                 let counterparty_pubkeys = ChannelPublicKeys {
7457                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
7458                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
7459                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
7460                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
7461                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
7462                 };
7463                 chan.channel_transaction_parameters.counterparty_parameters = Some(
7464                         CounterpartyChannelTransactionParameters {
7465                                 pubkeys: counterparty_pubkeys.clone(),
7466                                 selected_contest_delay: 144
7467                         });
7468                 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
7469                 signer.provide_channel_parameters(&chan.channel_transaction_parameters);
7470
7471                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
7472                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
7473
7474                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
7475                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
7476
7477                 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
7478                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
7479
7480                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
7481                 // derived from a commitment_seed, so instead we copy it here and call
7482                 // build_commitment_transaction.
7483                 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
7484                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
7485                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
7486                 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
7487                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint);
7488
7489                 macro_rules! test_commitment {
7490                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
7491                                 chan.channel_transaction_parameters.opt_anchors = None;
7492                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, false, $($remain)*);
7493                         };
7494                 }
7495
7496                 macro_rules! test_commitment_with_anchors {
7497                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
7498                                 chan.channel_transaction_parameters.opt_anchors = Some(());
7499                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, true, $($remain)*);
7500                         };
7501                 }
7502
7503                 macro_rules! test_commitment_common {
7504                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $opt_anchors: expr, {
7505                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
7506                         } ) => { {
7507                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
7508                                         let mut commitment_stats = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
7509
7510                                         let htlcs = commitment_stats.htlcs_included.drain(..)
7511                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
7512                                                 .collect();
7513                                         (commitment_stats.tx, htlcs)
7514                                 };
7515                                 let trusted_tx = commitment_tx.trust();
7516                                 let unsigned_tx = trusted_tx.built_transaction();
7517                                 let redeemscript = chan.get_funding_redeemscript();
7518                                 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
7519                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
7520                                 log_trace!(logger, "unsigned_tx = {}", hex::encode(serialize(&unsigned_tx.transaction)));
7521                                 assert!(secp_ctx.verify_ecdsa(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).is_ok(), "verify counterparty commitment sig");
7522
7523                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
7524                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
7525                                 let mut counterparty_htlc_sigs = Vec::new();
7526                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
7527                                 $({
7528                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
7529                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
7530                                         counterparty_htlc_sigs.push(remote_signature);
7531                                 })*
7532                                 assert_eq!(htlcs.len(), per_htlc.len());
7533
7534                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
7535                                         commitment_tx.clone(),
7536                                         counterparty_signature,
7537                                         counterparty_htlc_sigs,
7538                                         &chan.holder_signer.pubkeys().funding_pubkey,
7539                                         chan.counterparty_funding_pubkey()
7540                                 );
7541                                 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
7542                                 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
7543
7544                                 let funding_redeemscript = chan.get_funding_redeemscript();
7545                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
7546                                 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
7547
7548                                 // ((htlc, counterparty_sig), (index, holder_sig))
7549                                 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
7550
7551                                 $({
7552                                         log_trace!(logger, "verifying htlc {}", $htlc_idx);
7553                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
7554
7555                                         let ref htlc = htlcs[$htlc_idx];
7556                                         let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
7557                                                 chan.get_counterparty_selected_contest_delay().unwrap(),
7558                                                 &htlc, $opt_anchors, false, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
7559                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, $opt_anchors, &keys);
7560                                         let htlc_sighashtype = if $opt_anchors { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
7561                                         let htlc_sighash = Message::from_slice(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]).unwrap();
7562                                         assert!(secp_ctx.verify_ecdsa(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).is_ok(), "verify counterparty htlc sig");
7563
7564                                         let mut preimage: Option<PaymentPreimage> = None;
7565                                         if !htlc.offered {
7566                                                 for i in 0..5 {
7567                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
7568                                                         if out == htlc.payment_hash {
7569                                                                 preimage = Some(PaymentPreimage([i; 32]));
7570                                                         }
7571                                                 }
7572
7573                                                 assert!(preimage.is_some());
7574                                         }
7575
7576                                         let htlc_sig = htlc_sig_iter.next().unwrap();
7577                                         let num_anchors = if $opt_anchors { 2 } else { 0 };
7578                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx + num_anchors), "output index");
7579
7580                                         let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
7581                                         assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
7582                                         let index = (htlc_sig.1).0;
7583                                         let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
7584                                         let trusted_tx = holder_commitment_tx.trust();
7585                                         log_trace!(logger, "htlc_tx = {}", hex::encode(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))));
7586                                         assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
7587                                                         hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
7588                                 })*
7589                                 assert!(htlc_sig_iter.next().is_none());
7590                         } }
7591                 }
7592
7593                 // simple commitment tx with no HTLCs
7594                 chan.value_to_self_msat = 7000000000;
7595
7596                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
7597                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
7598                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7599
7600                 // anchors: simple commitment tx with no HTLCs
7601                 test_commitment_with_anchors!("3045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f3",
7602                                                  "30450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f7",
7603                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a508b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f701483045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7604
7605                 chan.pending_inbound_htlcs.push({
7606                         let mut out = InboundHTLCOutput{
7607                                 htlc_id: 0,
7608                                 amount_msat: 1000000,
7609                                 cltv_expiry: 500,
7610                                 payment_hash: PaymentHash([0; 32]),
7611                                 state: InboundHTLCState::Committed,
7612                         };
7613                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
7614                         out
7615                 });
7616                 chan.pending_inbound_htlcs.push({
7617                         let mut out = InboundHTLCOutput{
7618                                 htlc_id: 1,
7619                                 amount_msat: 2000000,
7620                                 cltv_expiry: 501,
7621                                 payment_hash: PaymentHash([0; 32]),
7622                                 state: InboundHTLCState::Committed,
7623                         };
7624                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
7625                         out
7626                 });
7627                 chan.pending_outbound_htlcs.push({
7628                         let mut out = OutboundHTLCOutput{
7629                                 htlc_id: 2,
7630                                 amount_msat: 2000000,
7631                                 cltv_expiry: 502,
7632                                 payment_hash: PaymentHash([0; 32]),
7633                                 state: OutboundHTLCState::Committed,
7634                                 source: HTLCSource::dummy(),
7635                         };
7636                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
7637                         out
7638                 });
7639                 chan.pending_outbound_htlcs.push({
7640                         let mut out = OutboundHTLCOutput{
7641                                 htlc_id: 3,
7642                                 amount_msat: 3000000,
7643                                 cltv_expiry: 503,
7644                                 payment_hash: PaymentHash([0; 32]),
7645                                 state: OutboundHTLCState::Committed,
7646                                 source: HTLCSource::dummy(),
7647                         };
7648                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
7649                         out
7650                 });
7651                 chan.pending_inbound_htlcs.push({
7652                         let mut out = InboundHTLCOutput{
7653                                 htlc_id: 4,
7654                                 amount_msat: 4000000,
7655                                 cltv_expiry: 504,
7656                                 payment_hash: PaymentHash([0; 32]),
7657                                 state: InboundHTLCState::Committed,
7658                         };
7659                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
7660                         out
7661                 });
7662
7663                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
7664                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7665                 chan.feerate_per_kw = 0;
7666
7667                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
7668                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
7669                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7670
7671                                   { 0,
7672                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
7673                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
7674                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
7675
7676                                   { 1,
7677                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
7678                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
7679                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7680
7681                                   { 2,
7682                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
7683                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
7684                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7685
7686                                   { 3,
7687                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
7688                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
7689                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7690
7691                                   { 4,
7692                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
7693                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
7694                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7695                 } );
7696
7697                 // commitment tx with seven outputs untrimmed (maximum feerate)
7698                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7699                 chan.feerate_per_kw = 647;
7700
7701                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
7702                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
7703                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7704
7705                                   { 0,
7706                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
7707                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
7708                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
7709
7710                                   { 1,
7711                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
7712                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
7713                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7714
7715                                   { 2,
7716                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
7717                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
7718                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7719
7720                                   { 3,
7721                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
7722                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
7723                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7724
7725                                   { 4,
7726                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
7727                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
7728                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7729                 } );
7730
7731                 // commitment tx with six outputs untrimmed (minimum feerate)
7732                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7733                 chan.feerate_per_kw = 648;
7734
7735                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
7736                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
7737                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7738
7739                                   { 0,
7740                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
7741                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
7742                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7743
7744                                   { 1,
7745                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
7746                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
7747                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7748
7749                                   { 2,
7750                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
7751                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
7752                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7753
7754                                   { 3,
7755                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
7756                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
7757                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7758                 } );
7759
7760                 // anchors: commitment tx with six outputs untrimmed (minimum dust limit)
7761                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7762                 chan.feerate_per_kw = 645;
7763                 chan.holder_dust_limit_satoshis = 1001;
7764
7765                 test_commitment_with_anchors!("3044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc312",
7766                                  "3045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d0051",
7767                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80084a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994abc996a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d005101473044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc31201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7768
7769                                   { 0,
7770                                   "3045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc282",
7771                                   "3045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef09",
7772                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320002000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc28283483045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef0901008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
7773
7774                                   { 1,
7775                                   "3045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e",
7776                                   "3045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac",
7777                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320003000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e83483045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
7778
7779                                   { 2,
7780                                   "3044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c1",
7781                                   "304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e",
7782                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320004000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c18347304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7783
7784                                   { 3,
7785                                   "3044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc615",
7786                                   "3045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226",
7787                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320005000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc61583483045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7788                 } );
7789
7790                 // commitment tx with six outputs untrimmed (maximum feerate)
7791                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7792                 chan.feerate_per_kw = 2069;
7793                 chan.holder_dust_limit_satoshis = 546;
7794
7795                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
7796                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
7797                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7798
7799                                   { 0,
7800                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
7801                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
7802                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7803
7804                                   { 1,
7805                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
7806                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
7807                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
7808
7809                                   { 2,
7810                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
7811                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
7812                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7813
7814                                   { 3,
7815                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
7816                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
7817                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7818                 } );
7819
7820                 // commitment tx with five outputs untrimmed (minimum feerate)
7821                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7822                 chan.feerate_per_kw = 2070;
7823
7824                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
7825                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
7826                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7827
7828                                   { 0,
7829                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
7830                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
7831                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7832
7833                                   { 1,
7834                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
7835                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
7836                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7837
7838                                   { 2,
7839                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
7840                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
7841                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7842                 } );
7843
7844                 // commitment tx with five outputs untrimmed (maximum feerate)
7845                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7846                 chan.feerate_per_kw = 2194;
7847
7848                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
7849                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
7850                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7851
7852                                   { 0,
7853                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
7854                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
7855                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
7856
7857                                   { 1,
7858                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
7859                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
7860                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7861
7862                                   { 2,
7863                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
7864                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
7865                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7866                 } );
7867
7868                 // commitment tx with four outputs untrimmed (minimum feerate)
7869                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7870                 chan.feerate_per_kw = 2195;
7871
7872                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
7873                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
7874                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7875
7876                                   { 0,
7877                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
7878                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
7879                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7880
7881                                   { 1,
7882                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
7883                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
7884                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7885                 } );
7886
7887                 // anchors: commitment tx with four outputs untrimmed (minimum dust limit)
7888                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7889                 chan.feerate_per_kw = 2185;
7890                 chan.holder_dust_limit_satoshis = 2001;
7891
7892                 test_commitment_with_anchors!("3044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c0",
7893                                  "3045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd5",
7894                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80064a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994b80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ac5916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd501473044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7895
7896                                   { 0,
7897                                   "304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb",
7898                                   "30440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f",
7899                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc02000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb834730440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
7900
7901                                   { 1,
7902                                   "3045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd7271",
7903                                   "3045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688",
7904                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc03000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd727183483045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7905                 } );
7906
7907                 // commitment tx with four outputs untrimmed (maximum feerate)
7908                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7909                 chan.feerate_per_kw = 3702;
7910                 chan.holder_dust_limit_satoshis = 546;
7911
7912                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
7913                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
7914                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7915
7916                                   { 0,
7917                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
7918                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
7919                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
7920
7921                                   { 1,
7922                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
7923                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
7924                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7925                 } );
7926
7927                 // commitment tx with three outputs untrimmed (minimum feerate)
7928                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7929                 chan.feerate_per_kw = 3703;
7930
7931                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
7932                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
7933                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7934
7935                                   { 0,
7936                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
7937                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
7938                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7939                 } );
7940
7941                 // anchors: commitment tx with three outputs untrimmed (minimum dust limit)
7942                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7943                 chan.feerate_per_kw = 3687;
7944                 chan.holder_dust_limit_satoshis = 3001;
7945
7946                 test_commitment_with_anchors!("3045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c228377",
7947                                  "3045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d",
7948                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80054a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aa28b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d01483045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c22837701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7949
7950                                   { 0,
7951                                   "3044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c",
7952                                   "3045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de",
7953                                   "02000000000101542562b326c08e3a076d9cfca2be175041366591da334d8d513ff1686fd95a6002000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c83483045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
7954                 } );
7955
7956                 // commitment tx with three outputs untrimmed (maximum feerate)
7957                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7958                 chan.feerate_per_kw = 4914;
7959                 chan.holder_dust_limit_satoshis = 546;
7960
7961                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
7962                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
7963                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
7964
7965                                   { 0,
7966                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
7967                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
7968                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
7969                 } );
7970
7971                 // commitment tx with two outputs untrimmed (minimum feerate)
7972                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7973                 chan.feerate_per_kw = 4915;
7974                 chan.holder_dust_limit_satoshis = 546;
7975
7976                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
7977                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
7978                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7979
7980                 // anchors: commitment tx with two outputs untrimmed (minimum dust limit)
7981                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7982                 chan.feerate_per_kw = 4894;
7983                 chan.holder_dust_limit_satoshis = 4001;
7984
7985                 test_commitment_with_anchors!("3045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b95",
7986                                  "30450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd",
7987                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ad0886a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd01483045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b9501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7988
7989                 // commitment tx with two outputs untrimmed (maximum feerate)
7990                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
7991                 chan.feerate_per_kw = 9651180;
7992                 chan.holder_dust_limit_satoshis = 546;
7993
7994                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
7995                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
7996                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
7997
7998                 // commitment tx with one output untrimmed (minimum feerate)
7999                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
8000                 chan.feerate_per_kw = 9651181;
8001
8002                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
8003                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
8004                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
8005
8006                 // anchors: commitment tx with one output untrimmed (minimum dust limit)
8007                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
8008                 chan.feerate_per_kw = 6216010;
8009                 chan.holder_dust_limit_satoshis = 4001;
8010
8011                 test_commitment_with_anchors!("30450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf",
8012                                  "30450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1",
8013                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a04004830450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1014830450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
8014
8015                 // commitment tx with fee greater than funder amount
8016                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
8017                 chan.feerate_per_kw = 9651936;
8018                 chan.holder_dust_limit_satoshis = 546;
8019
8020                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
8021                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
8022                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
8023
8024                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
8025                 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
8026                 chan.feerate_per_kw = 253;
8027                 chan.pending_inbound_htlcs.clear();
8028                 chan.pending_inbound_htlcs.push({
8029                         let mut out = InboundHTLCOutput{
8030                                 htlc_id: 1,
8031                                 amount_msat: 2000000,
8032                                 cltv_expiry: 501,
8033                                 payment_hash: PaymentHash([0; 32]),
8034                                 state: InboundHTLCState::Committed,
8035                         };
8036                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
8037                         out
8038                 });
8039                 chan.pending_outbound_htlcs.clear();
8040                 chan.pending_outbound_htlcs.push({
8041                         let mut out = OutboundHTLCOutput{
8042                                 htlc_id: 6,
8043                                 amount_msat: 5000000,
8044                                 cltv_expiry: 506,
8045                                 payment_hash: PaymentHash([0; 32]),
8046                                 state: OutboundHTLCState::Committed,
8047                                 source: HTLCSource::dummy(),
8048                         };
8049                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
8050                         out
8051                 });
8052                 chan.pending_outbound_htlcs.push({
8053                         let mut out = OutboundHTLCOutput{
8054                                 htlc_id: 5,
8055                                 amount_msat: 5000000,
8056                                 cltv_expiry: 505,
8057                                 payment_hash: PaymentHash([0; 32]),
8058                                 state: OutboundHTLCState::Committed,
8059                                 source: HTLCSource::dummy(),
8060                         };
8061                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
8062                         out
8063                 });
8064
8065                 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
8066                                  "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
8067                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
8068
8069                                   { 0,
8070                                   "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
8071                                   "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
8072                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
8073                                   { 1,
8074                                   "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
8075                                   "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
8076                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
8077                                   { 2,
8078                                   "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
8079                                   "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
8080                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
8081                 } );
8082
8083                 test_commitment_with_anchors!("3045022100c592f6b80d35b4f5d1e3bc9788f51141a0065be6013bad53a1977f7c444651660220278ac06ead9016bfb8dc476f186eabace2b02793b2f308442f5b0d5f24a68948",
8084                                  "3045022100c37ac4fc8538677631230c4b286f36b6f54c51fb4b34ef0bd0ba219ba47452630220278e09a745454ea380f3694392ed113762c68dd209b48360f547541088be9e45",
8085                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5e881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aae9c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c37ac4fc8538677631230c4b286f36b6f54c51fb4b34ef0bd0ba219ba47452630220278e09a745454ea380f3694392ed113762c68dd209b48360f547541088be9e4501483045022100c592f6b80d35b4f5d1e3bc9788f51141a0065be6013bad53a1977f7c444651660220278ac06ead9016bfb8dc476f186eabace2b02793b2f308442f5b0d5f24a6894801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
8086
8087                                   { 0,
8088                                   "3045022100de8a0649d54fd2e4fc04502c77df9b65da839bbd01854f818f129338b99564b2022009528dbb12c00e874cb2149b1dccc600c69ea5e4042ebf584984fcb029c2d1ec",
8089                                   "304402203e7c2622fa3ca29355d37a0ea991bfd7cdb54e6122a1d98d3229d092131f55cd022055263f7f8f32f4cd2f86da63ca106bd7badf0b19ee9833d80cd3b9216eeafd74",
8090                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe2902000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100de8a0649d54fd2e4fc04502c77df9b65da839bbd01854f818f129338b99564b2022009528dbb12c00e874cb2149b1dccc600c69ea5e4042ebf584984fcb029c2d1ec8347304402203e7c2622fa3ca29355d37a0ea991bfd7cdb54e6122a1d98d3229d092131f55cd022055263f7f8f32f4cd2f86da63ca106bd7badf0b19ee9833d80cd3b9216eeafd74012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
8091                                   { 1,
8092                                   "3045022100de6eee8474376ea316d007b33103b4543a46bdf6fda5cbd5902b28a5bc14584f022002989e7b4f7813b77acbe4babcf96d7ffbbe0bf14cba24672364f8e591479edb",
8093                                   "3045022100c10688346a9d84647bde7027da07f0d79c6d4129307e4c6c9aea7bdbf25ac3350220269104209793c32c47491698c4e46ebea9c3293a1e4403f9abda39f79698f6b5",
8094                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe290300000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100de6eee8474376ea316d007b33103b4543a46bdf6fda5cbd5902b28a5bc14584f022002989e7b4f7813b77acbe4babcf96d7ffbbe0bf14cba24672364f8e591479edb83483045022100c10688346a9d84647bde7027da07f0d79c6d4129307e4c6c9aea7bdbf25ac3350220269104209793c32c47491698c4e46ebea9c3293a1e4403f9abda39f79698f6b501008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568f9010000" },
8095                                   { 2,
8096                                   "3045022100fe87da8124ceecbcabb9d599c5339f40277c7c7406514fafbccbf180c7c09cf40220429c7fb6d0fd3705e931ab1219ab0432af38ae4d676008cc1964fbeb8cd35d2e",
8097                                   "3044022040ac769a851da31d8e4863e5f94719204f716c82a1ce6d6c52193d9a33b84bce022035df97b078ce80f20dca2109e4c6075af0b50148811452e7290e68b2680fced4",
8098                                   "02000000000101aa443fb63abc1e8c754f98a7b96c27cb02b21d891d1242a16b630dc32c2afe290400000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fe87da8124ceecbcabb9d599c5339f40277c7c7406514fafbccbf180c7c09cf40220429c7fb6d0fd3705e931ab1219ab0432af38ae4d676008cc1964fbeb8cd35d2e83473044022040ac769a851da31d8e4863e5f94719204f716c82a1ce6d6c52193d9a33b84bce022035df97b078ce80f20dca2109e4c6075af0b50148811452e7290e68b2680fced401008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568fa010000" }
8099                 } );
8100         }
8101
8102         #[test]
8103         fn test_per_commitment_secret_gen() {
8104                 // Test vectors from BOLT 3 Appendix D:
8105
8106                 let mut seed = [0; 32];
8107                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
8108                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
8109                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
8110
8111                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
8112                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
8113                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
8114
8115                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
8116                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
8117
8118                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
8119                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
8120
8121                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
8122                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
8123                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
8124         }
8125
8126         #[test]
8127         fn test_key_derivation() {
8128                 // Test vectors from BOLT 3 Appendix E:
8129                 let secp_ctx = Secp256k1::new();
8130
8131                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
8132                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
8133
8134                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
8135                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
8136
8137                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
8138                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
8139
8140                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).serialize()[..],
8141                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
8142
8143                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret),
8144                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
8145
8146                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).serialize()[..],
8147                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
8148
8149                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret),
8150                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
8151         }
8152
8153         #[test]
8154         fn test_zero_conf_channel_type_support() {
8155                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
8156                 let secp_ctx = Secp256k1::new();
8157                 let seed = [42; 32];
8158                 let network = Network::Testnet;
8159                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
8160                 let logger = test_utils::TestLogger::new();
8161
8162                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
8163                 let config = UserConfig::default();
8164                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&feeest, &&keys_provider, &&keys_provider,
8165                         node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42).unwrap();
8166
8167                 let mut channel_type_features = ChannelTypeFeatures::only_static_remote_key();
8168                 channel_type_features.set_zero_conf_required();
8169
8170                 let mut open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
8171                 open_channel_msg.channel_type = Some(channel_type_features);
8172                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
8173                 let res = Channel::<EnforcingSigner>::new_from_req(&feeest, &&keys_provider, &&keys_provider,
8174                         node_b_node_id, &channelmanager::provided_channel_type_features(&config),
8175                         &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, 42);
8176                 assert!(res.is_ok());
8177         }
8178
8179         #[cfg(anchors)]
8180         #[test]
8181         fn test_supports_anchors_zero_htlc_tx_fee() {
8182                 // Tests that if both sides support and negotiate `anchors_zero_fee_htlc_tx`, it is the
8183                 // resulting `channel_type`.
8184                 let secp_ctx = Secp256k1::new();
8185                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
8186                 let network = Network::Testnet;
8187                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
8188                 let logger = test_utils::TestLogger::new();
8189
8190                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
8191                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
8192
8193                 let mut config = UserConfig::default();
8194                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
8195
8196                 // It is not enough for just the initiator to signal `option_anchors_zero_fee_htlc_tx`, both
8197                 // need to signal it.
8198                 let channel_a = Channel::<EnforcingSigner>::new_outbound(
8199                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
8200                         &channelmanager::provided_init_features(&UserConfig::default()), 10000000, 100000, 42,
8201                         &config, 0, 42
8202                 ).unwrap();
8203                 assert!(!channel_a.channel_type.supports_anchors_zero_fee_htlc_tx());
8204
8205                 let mut expected_channel_type = ChannelTypeFeatures::empty();
8206                 expected_channel_type.set_static_remote_key_required();
8207                 expected_channel_type.set_anchors_zero_fee_htlc_tx_required();
8208
8209                 let channel_a = Channel::<EnforcingSigner>::new_outbound(
8210                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
8211                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42
8212                 ).unwrap();
8213
8214                 let open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
8215                 let channel_b = Channel::<EnforcingSigner>::new_from_req(
8216                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
8217                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
8218                         &open_channel_msg, 7, &config, 0, &&logger, 42
8219                 ).unwrap();
8220
8221                 assert_eq!(channel_a.channel_type, expected_channel_type);
8222                 assert_eq!(channel_b.channel_type, expected_channel_type);
8223         }
8224
8225         #[cfg(anchors)]
8226         #[test]
8227         fn test_rejects_implicit_simple_anchors() {
8228                 // Tests that if `option_anchors` is being negotiated implicitly through the intersection of
8229                 // each side's `InitFeatures`, it is rejected.
8230                 let secp_ctx = Secp256k1::new();
8231                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
8232                 let network = Network::Testnet;
8233                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
8234                 let logger = test_utils::TestLogger::new();
8235
8236                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
8237                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
8238
8239                 let config = UserConfig::default();
8240
8241                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
8242                 let static_remote_key_required: u64 = 1 << 12;
8243                 let simple_anchors_required: u64 = 1 << 20;
8244                 let raw_init_features = static_remote_key_required | simple_anchors_required;
8245                 let init_features_with_simple_anchors = InitFeatures::from_le_bytes(raw_init_features.to_le_bytes().to_vec());
8246
8247                 let channel_a = Channel::<EnforcingSigner>::new_outbound(
8248                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
8249                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42
8250                 ).unwrap();
8251
8252                 // Set `channel_type` to `None` to force the implicit feature negotiation.
8253                 let mut open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
8254                 open_channel_msg.channel_type = None;
8255
8256                 // Since A supports both `static_remote_key` and `option_anchors`, but B only accepts
8257                 // `static_remote_key`, it will fail the channel.
8258                 let channel_b = Channel::<EnforcingSigner>::new_from_req(
8259                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
8260                         &channelmanager::provided_channel_type_features(&config), &init_features_with_simple_anchors,
8261                         &open_channel_msg, 7, &config, 0, &&logger, 42
8262                 );
8263                 assert!(channel_b.is_err());
8264         }
8265
8266         #[cfg(anchors)]
8267         #[test]
8268         fn test_rejects_simple_anchors_channel_type() {
8269                 // Tests that if `option_anchors` is being negotiated through the `channel_type` feature,
8270                 // it is rejected.
8271                 let secp_ctx = Secp256k1::new();
8272                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
8273                 let network = Network::Testnet;
8274                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
8275                 let logger = test_utils::TestLogger::new();
8276
8277                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
8278                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
8279
8280                 let config = UserConfig::default();
8281
8282                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
8283                 let static_remote_key_required: u64 = 1 << 12;
8284                 let simple_anchors_required: u64 = 1 << 20;
8285                 let simple_anchors_raw_features = static_remote_key_required | simple_anchors_required;
8286                 let simple_anchors_init = InitFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
8287                 let simple_anchors_channel_type = ChannelTypeFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
8288                 assert!(simple_anchors_init.requires_unknown_bits());
8289                 assert!(simple_anchors_channel_type.requires_unknown_bits());
8290
8291                 // First, we'll try to open a channel between A and B where A requests a channel type for
8292                 // the original `option_anchors` feature (non zero fee htlc tx). This should be rejected by
8293                 // B as it's not supported by LDK.
8294                 let channel_a = Channel::<EnforcingSigner>::new_outbound(
8295                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
8296                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42
8297                 ).unwrap();
8298
8299                 let mut open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
8300                 open_channel_msg.channel_type = Some(simple_anchors_channel_type.clone());
8301
8302                 let res = Channel::<EnforcingSigner>::new_from_req(
8303                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
8304                         &channelmanager::provided_channel_type_features(&config), &simple_anchors_init,
8305                         &open_channel_msg, 7, &config, 0, &&logger, 42
8306                 );
8307                 assert!(res.is_err());
8308
8309                 // Then, we'll try to open another channel where A requests a channel type for
8310                 // `anchors_zero_fee_htlc_tx`. B is malicious and tries to downgrade the channel type to the
8311                 // original `option_anchors` feature, which should be rejected by A as it's not supported by
8312                 // LDK.
8313                 let mut channel_a = Channel::<EnforcingSigner>::new_outbound(
8314                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b, &simple_anchors_init,
8315                         10000000, 100000, 42, &config, 0, 42
8316                 ).unwrap();
8317
8318                 let open_channel_msg = channel_a.get_open_channel(genesis_block(network).header.block_hash());
8319
8320                 let channel_b = Channel::<EnforcingSigner>::new_from_req(
8321                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
8322                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
8323                         &open_channel_msg, 7, &config, 0, &&logger, 42
8324                 ).unwrap();
8325
8326                 let mut accept_channel_msg = channel_b.get_accept_channel_message();
8327                 accept_channel_msg.channel_type = Some(simple_anchors_channel_type.clone());
8328
8329                 let res = channel_a.accept_channel(
8330                         &accept_channel_msg, &config.channel_handshake_limits, &simple_anchors_init
8331                 );
8332                 assert!(res.is_err());
8333         }
8334 }