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