ea807a5cb5aae0680d2d1162232fb64aeadc8704
[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::constants::ChainHash;
11 use bitcoin::blockdata::script::{Script, ScriptBuf, Builder};
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::sighash;
14 use bitcoin::sighash::EcdsaSighashType;
15 use bitcoin::consensus::encode;
16
17 use bitcoin::hashes::Hash;
18 use bitcoin::hashes::sha256::Hash as Sha256;
19 use bitcoin::hashes::sha256d::Hash as Sha256d;
20 use bitcoin::hash_types::{Txid, BlockHash};
21
22 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
23 use bitcoin::secp256k1::{PublicKey,SecretKey};
24 use bitcoin::secp256k1::{Secp256k1,ecdsa::Signature};
25 use bitcoin::secp256k1;
26
27 use crate::ln::types::{ChannelId, PaymentPreimage, PaymentHash};
28 use crate::ln::features::{ChannelTypeFeatures, InitFeatures};
29 use crate::ln::msgs;
30 use crate::ln::msgs::DecodeError;
31 use crate::ln::script::{self, ShutdownScript};
32 use crate::ln::channelmanager::{self, CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, SentHTLCId, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT, ChannelShutdownState};
33 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};
34 use crate::ln::chan_utils;
35 use crate::ln::onion_utils::HTLCFailReason;
36 use crate::chain::BestBlock;
37 use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, LowerBoundedFeeEstimator};
38 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS, CLOSED_CHANNEL_UPDATE_ID};
39 use crate::chain::transaction::{OutPoint, TransactionData};
40 use crate::sign::ecdsa::EcdsaChannelSigner;
41 use crate::sign::{EntropySource, ChannelSigner, SignerProvider, NodeSigner, Recipient};
42 use crate::events::ClosureReason;
43 use crate::routing::gossip::NodeId;
44 use crate::util::ser::{Readable, ReadableArgs, Writeable, Writer};
45 use crate::util::logger::{Logger, Record, WithContext};
46 use crate::util::errors::APIError;
47 use crate::util::config::{UserConfig, ChannelConfig, LegacyChannelConfig, ChannelHandshakeConfig, ChannelHandshakeLimits, MaxDustHTLCExposure};
48 use crate::util::scid_utils::scid_from_parts;
49
50 use crate::io;
51 use crate::prelude::*;
52 use core::{cmp,mem,fmt};
53 use core::ops::Deref;
54 #[cfg(any(test, fuzzing, debug_assertions))]
55 use crate::sync::Mutex;
56 use crate::sign::type_resolver::ChannelSignerType;
57
58 use super::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint, RevocationBasepoint};
59
60 #[cfg(test)]
61 pub struct ChannelValueStat {
62         pub value_to_self_msat: u64,
63         pub channel_value_msat: u64,
64         pub channel_reserve_msat: u64,
65         pub pending_outbound_htlcs_amount_msat: u64,
66         pub pending_inbound_htlcs_amount_msat: u64,
67         pub holding_cell_outbound_amount_msat: u64,
68         pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
69         pub counterparty_dust_limit_msat: u64,
70 }
71
72 pub struct AvailableBalances {
73         /// The amount that would go to us if we close the channel, ignoring any on-chain fees.
74         pub balance_msat: u64,
75         /// Total amount available for our counterparty to send to us.
76         pub inbound_capacity_msat: u64,
77         /// Total amount available for us to send to our counterparty.
78         pub outbound_capacity_msat: u64,
79         /// The maximum value we can assign to the next outbound HTLC
80         pub next_outbound_htlc_limit_msat: u64,
81         /// The minimum value we can assign to the next outbound HTLC
82         pub next_outbound_htlc_minimum_msat: u64,
83 }
84
85 #[derive(Debug, Clone, Copy, PartialEq)]
86 enum FeeUpdateState {
87         // Inbound states mirroring InboundHTLCState
88         RemoteAnnounced,
89         AwaitingRemoteRevokeToAnnounce,
90         // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
91         // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
92         // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
93         // the fee update anywhere, we can simply consider the fee update `Committed` immediately
94         // instead of setting it to AwaitingAnnouncedRemoteRevoke.
95
96         // Outbound state can only be `LocalAnnounced` or `Committed`
97         Outbound,
98 }
99
100 enum InboundHTLCRemovalReason {
101         FailRelay(msgs::OnionErrorPacket),
102         FailMalformed(([u8; 32], u16)),
103         Fulfill(PaymentPreimage),
104 }
105
106 /// Represents the resolution status of an inbound HTLC.
107 #[derive(Clone)]
108 enum InboundHTLCResolution {
109         /// Resolved implies the action we must take with the inbound HTLC has already been determined,
110         /// i.e., we already know whether it must be failed back or forwarded.
111         //
112         // TODO: Once this variant is removed, we should also clean up
113         // [`MonitorRestoreUpdates::accepted_htlcs`] as the path will be unreachable.
114         Resolved {
115                 pending_htlc_status: PendingHTLCStatus,
116         },
117         /// Pending implies we will attempt to resolve the inbound HTLC once it has been fully committed
118         /// to by both sides of the channel, i.e., once a `revoke_and_ack` has been processed by both
119         /// nodes for the state update in which it was proposed.
120         Pending {
121                 update_add_htlc: msgs::UpdateAddHTLC,
122         },
123 }
124
125 impl_writeable_tlv_based_enum!(InboundHTLCResolution,
126         (0, Resolved) => {
127                 (0, pending_htlc_status, required),
128         },
129         (2, Pending) => {
130                 (0, update_add_htlc, required),
131         };
132 );
133
134 enum InboundHTLCState {
135         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
136         /// update_add_htlc message for this HTLC.
137         RemoteAnnounced(InboundHTLCResolution),
138         /// Included in a received commitment_signed message (implying we've
139         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
140         /// state (see the example below). We have not yet included this HTLC in a
141         /// commitment_signed message because we are waiting on the remote's
142         /// aforementioned state revocation. One reason this missing remote RAA
143         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
144         /// is because every time we create a new "state", i.e. every time we sign a
145         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
146         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
147         /// sent provided the per_commitment_point for our current commitment tx.
148         /// The other reason we should not send a commitment_signed without their RAA
149         /// is because their RAA serves to ACK our previous commitment_signed.
150         ///
151         /// Here's an example of how an HTLC could come to be in this state:
152         /// remote --> update_add_htlc(prev_htlc)   --> local
153         /// remote --> commitment_signed(prev_htlc) --> local
154         /// remote <-- revoke_and_ack               <-- local
155         /// remote <-- commitment_signed(prev_htlc) <-- local
156         /// [note that here, the remote does not respond with a RAA]
157         /// remote --> update_add_htlc(this_htlc)   --> local
158         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
159         /// Now `this_htlc` will be assigned this state. It's unable to be officially
160         /// accepted, i.e. included in a commitment_signed, because we're missing the
161         /// RAA that provides our next per_commitment_point. The per_commitment_point
162         /// is used to derive commitment keys, which are used to construct the
163         /// signatures in a commitment_signed message.
164         /// Implies AwaitingRemoteRevoke.
165         ///
166         /// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
167         AwaitingRemoteRevokeToAnnounce(InboundHTLCResolution),
168         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
169         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
170         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
171         /// channel (before it can then get forwarded and/or removed).
172         /// Implies AwaitingRemoteRevoke.
173         AwaitingAnnouncedRemoteRevoke(InboundHTLCResolution),
174         Committed,
175         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
176         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
177         /// we'll drop it.
178         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
179         /// commitment transaction without it as otherwise we'll have to force-close the channel to
180         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
181         /// anyway). That said, ChannelMonitor does this for us (see
182         /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
183         /// our own local state before then, once we're sure that the next commitment_signed and
184         /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
185         LocalRemoved(InboundHTLCRemovalReason),
186 }
187
188 /// Exposes the state of pending inbound HTLCs.
189 ///
190 /// At a high level, an HTLC being forwarded from one Lightning node to another Lightning node goes
191 /// through the following states in the state machine:
192 /// - Announced for addition by the originating node through the update_add_htlc message.
193 /// - Added to the commitment transaction of the receiving node and originating node in turn
194 ///   through the exchange of commitment_signed and revoke_and_ack messages.
195 /// - Announced for resolution (fulfillment or failure) by the receiving node through either one of
196 ///   the update_fulfill_htlc, update_fail_htlc, and update_fail_malformed_htlc messages.
197 /// - Removed from the commitment transaction of the originating node and receiving node in turn
198 ///   through the exchange of commitment_signed and revoke_and_ack messages.
199 ///
200 /// This can be used to inspect what next message an HTLC is waiting for to advance its state.
201 #[derive(Clone, Debug, PartialEq)]
202 pub enum InboundHTLCStateDetails {
203         /// We have added this HTLC in our commitment transaction by receiving commitment_signed and
204         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
205         /// before this HTLC is included on the remote commitment transaction.
206         AwaitingRemoteRevokeToAdd,
207         /// This HTLC has been included in the commitment_signed and revoke_and_ack messages on both sides
208         /// and is included in both commitment transactions.
209         ///
210         /// This HTLC is now safe to either forward or be claimed as a payment by us. The HTLC will
211         /// remain in this state until the forwarded upstream HTLC has been resolved and we resolve this
212         /// HTLC correspondingly, or until we claim it as a payment. If it is part of a multipart
213         /// payment, it will only be claimed together with other required parts.
214         Committed,
215         /// We have received the preimage for this HTLC and it is being removed by fulfilling it with
216         /// update_fulfill_htlc. This HTLC is still on both commitment transactions, but we are awaiting
217         /// the appropriate revoke_and_ack's from the remote before this HTLC is removed from the remote
218         /// commitment transaction after update_fulfill_htlc.
219         AwaitingRemoteRevokeToRemoveFulfill,
220         /// The HTLC is being removed by failing it with update_fail_htlc or update_fail_malformed_htlc.
221         /// This HTLC is still on both commitment transactions, but we are awaiting the appropriate
222         /// revoke_and_ack's from the remote before this HTLC is removed from the remote commitment
223         /// transaction.
224         AwaitingRemoteRevokeToRemoveFail,
225 }
226
227 impl From<&InboundHTLCState> for Option<InboundHTLCStateDetails> {
228         fn from(state: &InboundHTLCState) -> Option<InboundHTLCStateDetails> {
229                 match state {
230                         InboundHTLCState::RemoteAnnounced(_) => None,
231                         InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) =>
232                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
233                         InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) =>
234                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
235                         InboundHTLCState::Committed =>
236                                 Some(InboundHTLCStateDetails::Committed),
237                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(_)) =>
238                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail),
239                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed(_)) =>
240                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail),
241                         InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) =>
242                                 Some(InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFulfill),
243                 }
244         }
245 }
246
247 impl_writeable_tlv_based_enum_upgradable!(InboundHTLCStateDetails,
248         (0, AwaitingRemoteRevokeToAdd) => {},
249         (2, Committed) => {},
250         (4, AwaitingRemoteRevokeToRemoveFulfill) => {},
251         (6, AwaitingRemoteRevokeToRemoveFail) => {};
252 );
253
254 struct InboundHTLCOutput {
255         htlc_id: u64,
256         amount_msat: u64,
257         cltv_expiry: u32,
258         payment_hash: PaymentHash,
259         state: InboundHTLCState,
260 }
261
262 /// Exposes details around pending inbound HTLCs.
263 #[derive(Clone, Debug, PartialEq)]
264 pub struct InboundHTLCDetails {
265         /// The HTLC ID.
266         /// The IDs are incremented by 1 starting from 0 for each offered HTLC.
267         /// They are unique per channel and inbound/outbound direction, unless an HTLC was only announced
268         /// and not part of any commitment transaction.
269         pub htlc_id: u64,
270         /// The amount in msat.
271         pub amount_msat: u64,
272         /// The block height at which this HTLC expires.
273         pub cltv_expiry: u32,
274         /// The payment hash.
275         pub payment_hash: PaymentHash,
276         /// The state of the HTLC in the state machine.
277         ///
278         /// Determines on which commitment transactions the HTLC is included and what message the HTLC is
279         /// waiting for to advance to the next state.
280         ///
281         /// See [`InboundHTLCStateDetails`] for information on the specific states.
282         ///
283         /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new
284         /// states may result in `None` here.
285         pub state: Option<InboundHTLCStateDetails>,
286         /// Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed
287         /// from the local commitment transaction and added to the commitment transaction fee.
288         /// For non-anchor channels, this takes into account the cost of the second-stage HTLC
289         /// transactions as well.
290         ///
291         /// When the local commitment transaction is broadcasted as part of a unilateral closure,
292         /// the value of this HTLC will therefore not be claimable but instead burned as a transaction
293         /// fee.
294         ///
295         /// Note that dust limits are specific to each party. An HTLC can be dust for the local
296         /// commitment transaction but not for the counterparty's commitment transaction and vice versa.
297         pub is_dust: bool,
298 }
299
300 impl_writeable_tlv_based!(InboundHTLCDetails, {
301         (0, htlc_id, required),
302         (2, amount_msat, required),
303         (4, cltv_expiry, required),
304         (6, payment_hash, required),
305         (7, state, upgradable_option),
306         (8, is_dust, required),
307 });
308
309 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
310 enum OutboundHTLCState {
311         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
312         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
313         /// we will promote to Committed (note that they may not accept it until the next time we
314         /// revoke, but we don't really care about that:
315         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
316         ///    money back (though we won't), and,
317         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
318         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
319         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
320         ///    we'll never get out of sync).
321         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
322         /// OutboundHTLCOutput's size just for a temporary bit
323         LocalAnnounced(Box<msgs::OnionPacket>),
324         Committed,
325         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
326         /// the change (though they'll need to revoke before we fail the payment).
327         RemoteRemoved(OutboundHTLCOutcome),
328         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
329         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
330         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
331         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
332         /// remote revoke_and_ack on a previous state before we can do so.
333         AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome),
334         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
335         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
336         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
337         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
338         /// revoke_and_ack to drop completely.
339         AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome),
340 }
341
342 /// Exposes the state of pending outbound HTLCs.
343 ///
344 /// At a high level, an HTLC being forwarded from one Lightning node to another Lightning node goes
345 /// through the following states in the state machine:
346 /// - Announced for addition by the originating node through the update_add_htlc message.
347 /// - Added to the commitment transaction of the receiving node and originating node in turn
348 ///   through the exchange of commitment_signed and revoke_and_ack messages.
349 /// - Announced for resolution (fulfillment or failure) by the receiving node through either one of
350 ///   the update_fulfill_htlc, update_fail_htlc, and update_fail_malformed_htlc messages.
351 /// - Removed from the commitment transaction of the originating node and receiving node in turn
352 ///   through the exchange of commitment_signed and revoke_and_ack messages.
353 ///
354 /// This can be used to inspect what next message an HTLC is waiting for to advance its state.
355 #[derive(Clone, Debug, PartialEq)]
356 pub enum OutboundHTLCStateDetails {
357         /// We are awaiting the appropriate revoke_and_ack's from the remote before the HTLC is added
358         /// on the remote's commitment transaction after update_add_htlc.
359         AwaitingRemoteRevokeToAdd,
360         /// The HTLC has been added to the remote's commitment transaction by sending commitment_signed
361         /// and receiving revoke_and_ack in return.
362         ///
363         /// The HTLC will remain in this state until the remote node resolves the HTLC, or until we
364         /// unilaterally close the channel due to a timeout with an uncooperative remote node.
365         Committed,
366         /// The HTLC has been fulfilled successfully by the remote with a preimage in update_fulfill_htlc,
367         /// and we removed the HTLC from our commitment transaction by receiving commitment_signed and
368         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
369         /// for the removal from its commitment transaction.
370         AwaitingRemoteRevokeToRemoveSuccess,
371         /// The HTLC has been failed by the remote with update_fail_htlc or update_fail_malformed_htlc,
372         /// and we removed the HTLC from our commitment transaction by receiving commitment_signed and
373         /// returning revoke_and_ack. We are awaiting the appropriate revoke_and_ack's from the remote
374         /// for the removal from its commitment transaction.
375         AwaitingRemoteRevokeToRemoveFailure,
376 }
377
378 impl From<&OutboundHTLCState> for OutboundHTLCStateDetails {
379         fn from(state: &OutboundHTLCState) -> OutboundHTLCStateDetails {
380                 match state {
381                         OutboundHTLCState::LocalAnnounced(_) =>
382                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToAdd,
383                         OutboundHTLCState::Committed =>
384                                 OutboundHTLCStateDetails::Committed,
385                         // RemoteRemoved states are ignored as the state is transient and the remote has not committed to
386                         // the state yet.
387                         OutboundHTLCState::RemoteRemoved(_) =>
388                                 OutboundHTLCStateDetails::Committed,
389                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) =>
390                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveSuccess,
391                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Failure(_)) =>
392                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFailure,
393                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) =>
394                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveSuccess,
395                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Failure(_)) =>
396                                 OutboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFailure,
397                 }
398         }
399 }
400
401 impl_writeable_tlv_based_enum_upgradable!(OutboundHTLCStateDetails,
402         (0, AwaitingRemoteRevokeToAdd) => {},
403         (2, Committed) => {},
404         (4, AwaitingRemoteRevokeToRemoveSuccess) => {},
405         (6, AwaitingRemoteRevokeToRemoveFailure) => {};
406 );
407
408 #[derive(Clone)]
409 #[cfg_attr(test, derive(Debug, PartialEq))]
410 enum OutboundHTLCOutcome {
411         /// LDK version 0.0.105+ will always fill in the preimage here.
412         Success(Option<PaymentPreimage>),
413         Failure(HTLCFailReason),
414 }
415
416 impl From<Option<HTLCFailReason>> for OutboundHTLCOutcome {
417         fn from(o: Option<HTLCFailReason>) -> Self {
418                 match o {
419                         None => OutboundHTLCOutcome::Success(None),
420                         Some(r) => OutboundHTLCOutcome::Failure(r)
421                 }
422         }
423 }
424
425 impl<'a> Into<Option<&'a HTLCFailReason>> for &'a OutboundHTLCOutcome {
426         fn into(self) -> Option<&'a HTLCFailReason> {
427                 match self {
428                         OutboundHTLCOutcome::Success(_) => None,
429                         OutboundHTLCOutcome::Failure(ref r) => Some(r)
430                 }
431         }
432 }
433
434 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
435 struct OutboundHTLCOutput {
436         htlc_id: u64,
437         amount_msat: u64,
438         cltv_expiry: u32,
439         payment_hash: PaymentHash,
440         state: OutboundHTLCState,
441         source: HTLCSource,
442         blinding_point: Option<PublicKey>,
443         skimmed_fee_msat: Option<u64>,
444 }
445
446 /// Exposes details around pending outbound HTLCs.
447 #[derive(Clone, Debug, PartialEq)]
448 pub struct OutboundHTLCDetails {
449         /// The HTLC ID.
450         /// The IDs are incremented by 1 starting from 0 for each offered HTLC.
451         /// They are unique per channel and inbound/outbound direction, unless an HTLC was only announced
452         /// and not part of any commitment transaction.
453         ///
454         /// Not present when we are awaiting a remote revocation and the HTLC is not added yet.
455         pub htlc_id: Option<u64>,
456         /// The amount in msat.
457         pub amount_msat: u64,
458         /// The block height at which this HTLC expires.
459         pub cltv_expiry: u32,
460         /// The payment hash.
461         pub payment_hash: PaymentHash,
462         /// The state of the HTLC in the state machine.
463         ///
464         /// Determines on which commitment transactions the HTLC is included and what message the HTLC is
465         /// waiting for to advance to the next state.
466         ///
467         /// See [`OutboundHTLCStateDetails`] for information on the specific states.
468         ///
469         /// LDK will always fill this field in, but when downgrading to prior versions of LDK, new
470         /// states may result in `None` here.
471         pub state: Option<OutboundHTLCStateDetails>,
472         /// The extra fee being skimmed off the top of this HTLC.
473         pub skimmed_fee_msat: Option<u64>,
474         /// Whether the HTLC has an output below the local dust limit. If so, the output will be trimmed
475         /// from the local commitment transaction and added to the commitment transaction fee.
476         /// For non-anchor channels, this takes into account the cost of the second-stage HTLC
477         /// transactions as well.
478         ///
479         /// When the local commitment transaction is broadcasted as part of a unilateral closure,
480         /// the value of this HTLC will therefore not be claimable but instead burned as a transaction
481         /// fee.
482         ///
483         /// Note that dust limits are specific to each party. An HTLC can be dust for the local
484         /// commitment transaction but not for the counterparty's commitment transaction and vice versa.
485         pub is_dust: bool,
486 }
487
488 impl_writeable_tlv_based!(OutboundHTLCDetails, {
489         (0, htlc_id, required),
490         (2, amount_msat, required),
491         (4, cltv_expiry, required),
492         (6, payment_hash, required),
493         (7, state, upgradable_option),
494         (8, skimmed_fee_msat, required),
495         (10, is_dust, required),
496 });
497
498 /// See AwaitingRemoteRevoke ChannelState for more info
499 #[cfg_attr(test, derive(Clone, Debug, PartialEq))]
500 enum HTLCUpdateAwaitingACK {
501         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
502                 // always outbound
503                 amount_msat: u64,
504                 cltv_expiry: u32,
505                 payment_hash: PaymentHash,
506                 source: HTLCSource,
507                 onion_routing_packet: msgs::OnionPacket,
508                 // The extra fee we're skimming off the top of this HTLC.
509                 skimmed_fee_msat: Option<u64>,
510                 blinding_point: Option<PublicKey>,
511         },
512         ClaimHTLC {
513                 payment_preimage: PaymentPreimage,
514                 htlc_id: u64,
515         },
516         FailHTLC {
517                 htlc_id: u64,
518                 err_packet: msgs::OnionErrorPacket,
519         },
520         FailMalformedHTLC {
521                 htlc_id: u64,
522                 failure_code: u16,
523                 sha256_of_onion: [u8; 32],
524         },
525 }
526
527 macro_rules! define_state_flags {
528         ($flag_type_doc: expr, $flag_type: ident, [$(($flag_doc: expr, $flag: ident, $value: expr, $get: ident, $set: ident, $clear: ident)),+], $extra_flags: expr) => {
529                 #[doc = $flag_type_doc]
530                 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Eq)]
531                 struct $flag_type(u32);
532
533                 impl $flag_type {
534                         $(
535                                 #[doc = $flag_doc]
536                                 const $flag: $flag_type = $flag_type($value);
537                         )*
538
539                         /// All flags that apply to the specified [`ChannelState`] variant.
540                         #[allow(unused)]
541                         const ALL: $flag_type = Self($(Self::$flag.0 | )* $extra_flags);
542
543                         #[allow(unused)]
544                         fn new() -> Self { Self(0) }
545
546                         #[allow(unused)]
547                         fn from_u32(flags: u32) -> Result<Self, ()> {
548                                 if flags & !Self::ALL.0 != 0 {
549                                         Err(())
550                                 } else {
551                                         Ok($flag_type(flags))
552                                 }
553                         }
554
555                         #[allow(unused)]
556                         fn is_empty(&self) -> bool { self.0 == 0 }
557                         #[allow(unused)]
558                         fn is_set(&self, flag: Self) -> bool { *self & flag == flag }
559                         #[allow(unused)]
560                         fn set(&mut self, flag: Self) { *self |= flag }
561                         #[allow(unused)]
562                         fn clear(&mut self, flag: Self) -> Self { self.0 &= !flag.0; *self }
563                 }
564
565                 $(
566                         define_state_flags!($flag_type, Self::$flag, $get, $set, $clear);
567                 )*
568
569                 impl core::ops::BitOr for $flag_type {
570                         type Output = Self;
571                         fn bitor(self, rhs: Self) -> Self::Output { Self(self.0 | rhs.0) }
572                 }
573                 impl core::ops::BitOrAssign for $flag_type {
574                         fn bitor_assign(&mut self, rhs: Self) { self.0 |= rhs.0; }
575                 }
576                 impl core::ops::BitAnd for $flag_type {
577                         type Output = Self;
578                         fn bitand(self, rhs: Self) -> Self::Output { Self(self.0 & rhs.0) }
579                 }
580                 impl core::ops::BitAndAssign for $flag_type {
581                         fn bitand_assign(&mut self, rhs: Self) { self.0 &= rhs.0; }
582                 }
583         };
584         ($flag_type_doc: expr, $flag_type: ident, $flags: tt) => {
585                 define_state_flags!($flag_type_doc, $flag_type, $flags, 0);
586         };
587         ($flag_type: ident, $flag: expr, $get: ident, $set: ident, $clear: ident) => {
588                 impl $flag_type {
589                         #[allow(unused)]
590                         fn $get(&self) -> bool { self.is_set($flag_type::new() | $flag) }
591                         #[allow(unused)]
592                         fn $set(&mut self) { self.set($flag_type::new() | $flag) }
593                         #[allow(unused)]
594                         fn $clear(&mut self) -> Self { self.clear($flag_type::new() | $flag) }
595                 }
596         };
597         ($flag_type_doc: expr, FUNDED_STATE, $flag_type: ident, $flags: tt) => {
598                 define_state_flags!($flag_type_doc, $flag_type, $flags, FundedStateFlags::ALL.0);
599
600                 define_state_flags!($flag_type, FundedStateFlags::PEER_DISCONNECTED,
601                         is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected);
602                 define_state_flags!($flag_type, FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS,
603                         is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress);
604                 define_state_flags!($flag_type, FundedStateFlags::REMOTE_SHUTDOWN_SENT,
605                         is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent);
606                 define_state_flags!($flag_type, FundedStateFlags::LOCAL_SHUTDOWN_SENT,
607                         is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent);
608
609                 impl core::ops::BitOr<FundedStateFlags> for $flag_type {
610                         type Output = Self;
611                         fn bitor(self, rhs: FundedStateFlags) -> Self::Output { Self(self.0 | rhs.0) }
612                 }
613                 impl core::ops::BitOrAssign<FundedStateFlags> for $flag_type {
614                         fn bitor_assign(&mut self, rhs: FundedStateFlags) { self.0 |= rhs.0; }
615                 }
616                 impl core::ops::BitAnd<FundedStateFlags> for $flag_type {
617                         type Output = Self;
618                         fn bitand(self, rhs: FundedStateFlags) -> Self::Output { Self(self.0 & rhs.0) }
619                 }
620                 impl core::ops::BitAndAssign<FundedStateFlags> for $flag_type {
621                         fn bitand_assign(&mut self, rhs: FundedStateFlags) { self.0 &= rhs.0; }
622                 }
623                 impl PartialEq<FundedStateFlags> for $flag_type {
624                         fn eq(&self, other: &FundedStateFlags) -> bool { self.0 == other.0 }
625                 }
626                 impl From<FundedStateFlags> for $flag_type {
627                         fn from(flags: FundedStateFlags) -> Self { Self(flags.0) }
628                 }
629         };
630 }
631
632 /// We declare all the states/flags here together to help determine which bits are still available
633 /// to choose.
634 mod state_flags {
635         pub const OUR_INIT_SENT: u32 = 1 << 0;
636         pub const THEIR_INIT_SENT: u32 = 1 << 1;
637         pub const FUNDING_NEGOTIATED: u32 = 1 << 2;
638         pub const AWAITING_CHANNEL_READY: u32 = 1 << 3;
639         pub const THEIR_CHANNEL_READY: u32 = 1 << 4;
640         pub const OUR_CHANNEL_READY: u32 = 1 << 5;
641         pub const CHANNEL_READY: u32 = 1 << 6;
642         pub const PEER_DISCONNECTED: u32 = 1 << 7;
643         pub const MONITOR_UPDATE_IN_PROGRESS: u32 = 1 << 8;
644         pub const AWAITING_REMOTE_REVOKE: u32 = 1 << 9;
645         pub const REMOTE_SHUTDOWN_SENT: u32 = 1 << 10;
646         pub const LOCAL_SHUTDOWN_SENT: u32 = 1 << 11;
647         pub const SHUTDOWN_COMPLETE: u32 = 1 << 12;
648         pub const WAITING_FOR_BATCH: u32 = 1 << 13;
649 }
650
651 define_state_flags!(
652         "Flags that apply to all [`ChannelState`] variants in which the channel is funded.",
653         FundedStateFlags, [
654                 ("Indicates the remote side is considered \"disconnected\" and no updates are allowed \
655                         until after we've done a `channel_reestablish` dance.", PEER_DISCONNECTED, state_flags::PEER_DISCONNECTED,
656                         is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected),
657                 ("Indicates the user has told us a `ChannelMonitor` update is pending async persistence \
658                         somewhere and we should pause sending any outbound messages until they've managed to \
659                         complete it.", MONITOR_UPDATE_IN_PROGRESS, state_flags::MONITOR_UPDATE_IN_PROGRESS,
660                         is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress),
661                 ("Indicates we received a `shutdown` message from the remote end. If set, they may not add \
662                         any new HTLCs to the channel, and we are expected to respond with our own `shutdown` \
663                         message when possible.", REMOTE_SHUTDOWN_SENT, state_flags::REMOTE_SHUTDOWN_SENT,
664                         is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent),
665                 ("Indicates we sent a `shutdown` message. At this point, we may not add any new HTLCs to \
666                         the channel.", LOCAL_SHUTDOWN_SENT, state_flags::LOCAL_SHUTDOWN_SENT,
667                         is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent)
668         ]
669 );
670
671 define_state_flags!(
672         "Flags that only apply to [`ChannelState::NegotiatingFunding`].",
673         NegotiatingFundingFlags, [
674                 ("Indicates we have (or are prepared to) send our `open_channel`/`accept_channel` message.",
675                         OUR_INIT_SENT, state_flags::OUR_INIT_SENT, is_our_init_sent, set_our_init_sent, clear_our_init_sent),
676                 ("Indicates we have received their `open_channel`/`accept_channel` message.",
677                         THEIR_INIT_SENT, state_flags::THEIR_INIT_SENT, is_their_init_sent, set_their_init_sent, clear_their_init_sent)
678         ]
679 );
680
681 define_state_flags!(
682         "Flags that only apply to [`ChannelState::AwaitingChannelReady`].",
683         FUNDED_STATE, AwaitingChannelReadyFlags, [
684                 ("Indicates they sent us a `channel_ready` message. Once both `THEIR_CHANNEL_READY` and \
685                         `OUR_CHANNEL_READY` are set, our state moves on to `ChannelReady`.",
686                         THEIR_CHANNEL_READY, state_flags::THEIR_CHANNEL_READY,
687                         is_their_channel_ready, set_their_channel_ready, clear_their_channel_ready),
688                 ("Indicates we sent them a `channel_ready` message. Once both `THEIR_CHANNEL_READY` and \
689                         `OUR_CHANNEL_READY` are set, our state moves on to `ChannelReady`.",
690                         OUR_CHANNEL_READY, state_flags::OUR_CHANNEL_READY,
691                         is_our_channel_ready, set_our_channel_ready, clear_our_channel_ready),
692                 ("Indicates the channel was funded in a batch and the broadcast of the funding transaction \
693                         is being held until all channels in the batch have received `funding_signed` and have \
694                         their monitors persisted.", WAITING_FOR_BATCH, state_flags::WAITING_FOR_BATCH,
695                         is_waiting_for_batch, set_waiting_for_batch, clear_waiting_for_batch)
696         ]
697 );
698
699 define_state_flags!(
700         "Flags that only apply to [`ChannelState::ChannelReady`].",
701         FUNDED_STATE, ChannelReadyFlags, [
702                 ("Indicates that we have sent a `commitment_signed` but are awaiting the responding \
703                         `revoke_and_ack` message. During this period, we can't generate new `commitment_signed` \
704                         messages as we'd be unable to determine which HTLCs they included in their `revoke_and_ack` \
705                         implicit ACK, so instead we have to hold them away temporarily to be sent later.",
706                         AWAITING_REMOTE_REVOKE, state_flags::AWAITING_REMOTE_REVOKE,
707                         is_awaiting_remote_revoke, set_awaiting_remote_revoke, clear_awaiting_remote_revoke)
708         ]
709 );
710
711 // Note that the order of this enum is implicitly defined by where each variant is placed. Take this
712 // into account when introducing new states and update `test_channel_state_order` accordingly.
713 #[derive(Copy, Clone, Debug, PartialEq, PartialOrd, Eq)]
714 enum ChannelState {
715         /// We are negotiating the parameters required for the channel prior to funding it.
716         NegotiatingFunding(NegotiatingFundingFlags),
717         /// We have sent `funding_created` and are awaiting a `funding_signed` to advance to
718         /// `AwaitingChannelReady`. Note that this is nonsense for an inbound channel as we immediately generate
719         /// `funding_signed` upon receipt of `funding_created`, so simply skip this state.
720         FundingNegotiated,
721         /// We've received/sent `funding_created` and `funding_signed` and are thus now waiting on the
722         /// funding transaction to confirm.
723         AwaitingChannelReady(AwaitingChannelReadyFlags),
724         /// Both we and our counterparty consider the funding transaction confirmed and the channel is
725         /// now operational.
726         ChannelReady(ChannelReadyFlags),
727         /// We've successfully negotiated a `closing_signed` dance. At this point, the `ChannelManager`
728         /// is about to drop us, but we store this anyway.
729         ShutdownComplete,
730 }
731
732 macro_rules! impl_state_flag {
733         ($get: ident, $set: ident, $clear: ident, [$($state: ident),+]) => {
734                 #[allow(unused)]
735                 fn $get(&self) -> bool {
736                         match self {
737                                 $(
738                                         ChannelState::$state(flags) => flags.$get(),
739                                 )*
740                                 _ => false,
741                         }
742                 }
743                 #[allow(unused)]
744                 fn $set(&mut self) {
745                         match self {
746                                 $(
747                                         ChannelState::$state(flags) => flags.$set(),
748                                 )*
749                                 _ => debug_assert!(false, "Attempted to set flag on unexpected ChannelState"),
750                         }
751                 }
752                 #[allow(unused)]
753                 fn $clear(&mut self) {
754                         match self {
755                                 $(
756                                         ChannelState::$state(flags) => { let _ = flags.$clear(); },
757                                 )*
758                                 _ => debug_assert!(false, "Attempted to clear flag on unexpected ChannelState"),
759                         }
760                 }
761         };
762         ($get: ident, $set: ident, $clear: ident, FUNDED_STATES) => {
763                 impl_state_flag!($get, $set, $clear, [AwaitingChannelReady, ChannelReady]);
764         };
765         ($get: ident, $set: ident, $clear: ident, $state: ident) => {
766                 impl_state_flag!($get, $set, $clear, [$state]);
767         };
768 }
769
770 impl ChannelState {
771         fn from_u32(state: u32) -> Result<Self, ()> {
772                 match state {
773                         state_flags::FUNDING_NEGOTIATED => Ok(ChannelState::FundingNegotiated),
774                         state_flags::SHUTDOWN_COMPLETE => Ok(ChannelState::ShutdownComplete),
775                         val => {
776                                 if val & state_flags::AWAITING_CHANNEL_READY == state_flags::AWAITING_CHANNEL_READY {
777                                         AwaitingChannelReadyFlags::from_u32(val & !state_flags::AWAITING_CHANNEL_READY)
778                                                 .map(|flags| ChannelState::AwaitingChannelReady(flags))
779                                 } else if val & state_flags::CHANNEL_READY == state_flags::CHANNEL_READY {
780                                         ChannelReadyFlags::from_u32(val & !state_flags::CHANNEL_READY)
781                                                 .map(|flags| ChannelState::ChannelReady(flags))
782                                 } else if let Ok(flags) = NegotiatingFundingFlags::from_u32(val) {
783                                         Ok(ChannelState::NegotiatingFunding(flags))
784                                 } else {
785                                         Err(())
786                                 }
787                         },
788                 }
789         }
790
791         fn to_u32(&self) -> u32 {
792                 match self {
793                         ChannelState::NegotiatingFunding(flags) => flags.0,
794                         ChannelState::FundingNegotiated => state_flags::FUNDING_NEGOTIATED,
795                         ChannelState::AwaitingChannelReady(flags) => state_flags::AWAITING_CHANNEL_READY | flags.0,
796                         ChannelState::ChannelReady(flags) => state_flags::CHANNEL_READY | flags.0,
797                         ChannelState::ShutdownComplete => state_flags::SHUTDOWN_COMPLETE,
798                 }
799         }
800
801         fn is_pre_funded_state(&self) -> bool {
802                 matches!(self, ChannelState::NegotiatingFunding(_)|ChannelState::FundingNegotiated)
803         }
804
805         fn is_both_sides_shutdown(&self) -> bool {
806                 self.is_local_shutdown_sent() && self.is_remote_shutdown_sent()
807         }
808
809         fn with_funded_state_flags_mask(&self) -> FundedStateFlags {
810                 match self {
811                         ChannelState::AwaitingChannelReady(flags) => FundedStateFlags((*flags & FundedStateFlags::ALL).0),
812                         ChannelState::ChannelReady(flags) => FundedStateFlags((*flags & FundedStateFlags::ALL).0),
813                         _ => FundedStateFlags::new(),
814                 }
815         }
816
817         fn can_generate_new_commitment(&self) -> bool {
818                 match self {
819                         ChannelState::ChannelReady(flags) =>
820                                 !flags.is_set(ChannelReadyFlags::AWAITING_REMOTE_REVOKE) &&
821                                         !flags.is_set(FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS.into()) &&
822                                         !flags.is_set(FundedStateFlags::PEER_DISCONNECTED.into()),
823                         _ => {
824                                 debug_assert!(false, "Can only generate new commitment within ChannelReady");
825                                 false
826                         },
827                 }
828         }
829
830         impl_state_flag!(is_peer_disconnected, set_peer_disconnected, clear_peer_disconnected, FUNDED_STATES);
831         impl_state_flag!(is_monitor_update_in_progress, set_monitor_update_in_progress, clear_monitor_update_in_progress, FUNDED_STATES);
832         impl_state_flag!(is_local_shutdown_sent, set_local_shutdown_sent, clear_local_shutdown_sent, FUNDED_STATES);
833         impl_state_flag!(is_remote_shutdown_sent, set_remote_shutdown_sent, clear_remote_shutdown_sent, FUNDED_STATES);
834         impl_state_flag!(is_our_channel_ready, set_our_channel_ready, clear_our_channel_ready, AwaitingChannelReady);
835         impl_state_flag!(is_their_channel_ready, set_their_channel_ready, clear_their_channel_ready, AwaitingChannelReady);
836         impl_state_flag!(is_waiting_for_batch, set_waiting_for_batch, clear_waiting_for_batch, AwaitingChannelReady);
837         impl_state_flag!(is_awaiting_remote_revoke, set_awaiting_remote_revoke, clear_awaiting_remote_revoke, ChannelReady);
838 }
839
840 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
841
842 pub const DEFAULT_MAX_HTLCS: u16 = 50;
843
844 pub(crate) fn commitment_tx_base_weight(channel_type_features: &ChannelTypeFeatures) -> u64 {
845         const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
846         const COMMITMENT_TX_BASE_ANCHOR_WEIGHT: u64 = 1124;
847         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { COMMITMENT_TX_BASE_ANCHOR_WEIGHT } else { COMMITMENT_TX_BASE_WEIGHT }
848 }
849
850 #[cfg(not(test))]
851 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
852 #[cfg(test)]
853 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
854
855 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
856
857 /// The percentage of the channel value `holder_max_htlc_value_in_flight_msat` used to be set to,
858 /// before this was made configurable. The percentage was made configurable in LDK 0.0.107,
859 /// although LDK 0.0.104+ enabled serialization of channels with a different value set for
860 /// `holder_max_htlc_value_in_flight_msat`.
861 pub const MAX_IN_FLIGHT_PERCENT_LEGACY: u8 = 10;
862
863 /// Maximum `funding_satoshis` value according to the BOLT #2 specification, if
864 /// `option_support_large_channel` (aka wumbo channels) is not supported.
865 /// It's 2^24 - 1.
866 pub const MAX_FUNDING_SATOSHIS_NO_WUMBO: u64 = (1 << 24) - 1;
867
868 /// Total bitcoin supply in satoshis.
869 pub const TOTAL_BITCOIN_SUPPLY_SATOSHIS: u64 = 21_000_000 * 1_0000_0000;
870
871 /// The maximum network dust limit for standard script formats. This currently represents the
872 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
873 /// transaction non-standard and thus refuses to relay it.
874 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
875 /// implementations use this value for their dust limit today.
876 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
877
878 /// The maximum channel dust limit we will accept from our counterparty.
879 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
880
881 /// The dust limit is used for both the commitment transaction outputs as well as the closing
882 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
883 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
884 /// In order to avoid having to concern ourselves with standardness during the closing process, we
885 /// simply require our counterparty to use a dust limit which will leave any segwit output
886 /// standard.
887 /// See <https://github.com/lightning/bolts/issues/905> for more details.
888 pub const MIN_CHAN_DUST_LIMIT_SATOSHIS: u64 = 354;
889
890 // Just a reasonable implementation-specific safe lower bound, higher than the dust limit.
891 pub const MIN_THEIR_CHAN_RESERVE_SATOSHIS: u64 = 1000;
892
893 /// Used to return a simple Error back to ChannelManager. Will get converted to a
894 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
895 /// channel_id in ChannelManager.
896 pub(super) enum ChannelError {
897         Ignore(String),
898         Warn(String),
899         Close(String),
900 }
901
902 impl fmt::Debug for ChannelError {
903         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
904                 match self {
905                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
906                         &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
907                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
908                 }
909         }
910 }
911
912 impl fmt::Display for ChannelError {
913         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
914                 match self {
915                         &ChannelError::Ignore(ref e) => write!(f, "{}", e),
916                         &ChannelError::Warn(ref e) => write!(f, "{}", e),
917                         &ChannelError::Close(ref e) => write!(f, "{}", e),
918                 }
919         }
920 }
921
922 pub(super) struct WithChannelContext<'a, L: Deref> where L::Target: Logger {
923         pub logger: &'a L,
924         pub peer_id: Option<PublicKey>,
925         pub channel_id: Option<ChannelId>,
926         pub payment_hash: Option<PaymentHash>,
927 }
928
929 impl<'a, L: Deref> Logger for WithChannelContext<'a, L> where L::Target: Logger {
930         fn log(&self, mut record: Record) {
931                 record.peer_id = self.peer_id;
932                 record.channel_id = self.channel_id;
933                 record.payment_hash = self.payment_hash;
934                 self.logger.log(record)
935         }
936 }
937
938 impl<'a, 'b, L: Deref> WithChannelContext<'a, L>
939 where L::Target: Logger {
940         pub(super) fn from<S: Deref>(logger: &'a L, context: &'b ChannelContext<S>, payment_hash: Option<PaymentHash>) -> Self
941         where S::Target: SignerProvider
942         {
943                 WithChannelContext {
944                         logger,
945                         peer_id: Some(context.counterparty_node_id),
946                         channel_id: Some(context.channel_id),
947                         payment_hash
948                 }
949         }
950 }
951
952 macro_rules! secp_check {
953         ($res: expr, $err: expr) => {
954                 match $res {
955                         Ok(thing) => thing,
956                         Err(_) => return Err(ChannelError::Close($err)),
957                 }
958         };
959 }
960
961 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
962 /// our counterparty or not. However, we don't want to announce updates right away to avoid
963 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
964 /// our channel_update message and track the current state here.
965 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
966 #[derive(Clone, Copy, PartialEq)]
967 pub(super) enum ChannelUpdateStatus {
968         /// We've announced the channel as enabled and are connected to our peer.
969         Enabled,
970         /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
971         DisabledStaged(u8),
972         /// Our channel is live again, but we haven't announced the channel as enabled yet.
973         EnabledStaged(u8),
974         /// We've announced the channel as disabled.
975         Disabled,
976 }
977
978 /// We track when we sent an `AnnouncementSignatures` to our peer in a few states, described here.
979 #[derive(PartialEq)]
980 pub enum AnnouncementSigsState {
981         /// We have not sent our peer an `AnnouncementSignatures` yet, or our peer disconnected since
982         /// we sent the last `AnnouncementSignatures`.
983         NotSent,
984         /// We sent an `AnnouncementSignatures` to our peer since the last time our peer disconnected.
985         /// This state never appears on disk - instead we write `NotSent`.
986         MessageSent,
987         /// We sent a `CommitmentSigned` after the last `AnnouncementSignatures` we sent. Because we
988         /// only ever have a single `CommitmentSigned` pending at once, if we sent one after sending
989         /// `AnnouncementSignatures` then we know the peer received our `AnnouncementSignatures` if
990         /// they send back a `RevokeAndACK`.
991         /// This state never appears on disk - instead we write `NotSent`.
992         Committed,
993         /// We received a `RevokeAndACK`, effectively ack-ing our `AnnouncementSignatures`, at this
994         /// point we no longer need to re-send our `AnnouncementSignatures` again on reconnect.
995         PeerReceived,
996 }
997
998 /// An enum indicating whether the local or remote side offered a given HTLC.
999 enum HTLCInitiator {
1000         LocalOffered,
1001         RemoteOffered,
1002 }
1003
1004 /// Current counts of various HTLCs, useful for calculating current balances available exactly.
1005 struct HTLCStats {
1006         pending_inbound_htlcs: usize,
1007         pending_outbound_htlcs: usize,
1008         pending_inbound_htlcs_value_msat: u64,
1009         pending_outbound_htlcs_value_msat: u64,
1010         on_counterparty_tx_dust_exposure_msat: u64,
1011         on_holder_tx_dust_exposure_msat: u64,
1012         outbound_holding_cell_msat: u64,
1013         on_holder_tx_outbound_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
1014 }
1015
1016 /// An enum gathering stats on commitment transaction, either local or remote.
1017 struct CommitmentStats<'a> {
1018         tx: CommitmentTransaction, // the transaction info
1019         feerate_per_kw: u32, // the feerate included to build the transaction
1020         total_fee_sat: u64, // the total fee included in the transaction
1021         num_nondust_htlcs: usize,  // the number of HTLC outputs (dust HTLCs *non*-included)
1022         htlcs_included: Vec<(HTLCOutputInCommitment, Option<&'a HTLCSource>)>, // the list of HTLCs (dust HTLCs *included*) which were not ignored when building the transaction
1023         local_balance_msat: u64, // local balance before fees *not* considering dust limits
1024         remote_balance_msat: u64, // remote balance before fees *not* considering dust limits
1025         outbound_htlc_preimages: Vec<PaymentPreimage>, // preimages for successful offered HTLCs since last commitment
1026         inbound_htlc_preimages: Vec<PaymentPreimage>, // preimages for successful received HTLCs since last commitment
1027 }
1028
1029 /// Used when calculating whether we or the remote can afford an additional HTLC.
1030 struct HTLCCandidate {
1031         amount_msat: u64,
1032         origin: HTLCInitiator,
1033 }
1034
1035 impl HTLCCandidate {
1036         fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
1037                 Self {
1038                         amount_msat,
1039                         origin,
1040                 }
1041         }
1042 }
1043
1044 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
1045 /// description
1046 enum UpdateFulfillFetch {
1047         NewClaim {
1048                 monitor_update: ChannelMonitorUpdate,
1049                 htlc_value_msat: u64,
1050                 msg: Option<msgs::UpdateFulfillHTLC>,
1051         },
1052         DuplicateClaim {},
1053 }
1054
1055 /// The return type of get_update_fulfill_htlc_and_commit.
1056 pub enum UpdateFulfillCommitFetch {
1057         /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
1058         /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
1059         /// previously placed in the holding cell (and has since been removed).
1060         NewClaim {
1061                 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
1062                 monitor_update: ChannelMonitorUpdate,
1063                 /// The value of the HTLC which was claimed, in msat.
1064                 htlc_value_msat: u64,
1065         },
1066         /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
1067         /// or has been forgotten (presumably previously claimed).
1068         DuplicateClaim {},
1069 }
1070
1071 /// The return value of `monitor_updating_restored`
1072 pub(super) struct MonitorRestoreUpdates {
1073         pub raa: Option<msgs::RevokeAndACK>,
1074         pub commitment_update: Option<msgs::CommitmentUpdate>,
1075         pub order: RAACommitmentOrder,
1076         pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
1077         pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
1078         pub finalized_claimed_htlcs: Vec<HTLCSource>,
1079         pub pending_update_adds: Vec<msgs::UpdateAddHTLC>,
1080         pub funding_broadcastable: Option<Transaction>,
1081         pub channel_ready: Option<msgs::ChannelReady>,
1082         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
1083 }
1084
1085 /// The return value of `signer_maybe_unblocked`
1086 #[allow(unused)]
1087 pub(super) struct SignerResumeUpdates {
1088         pub commitment_update: Option<msgs::CommitmentUpdate>,
1089         pub funding_signed: Option<msgs::FundingSigned>,
1090         pub channel_ready: Option<msgs::ChannelReady>,
1091 }
1092
1093 /// The return value of `channel_reestablish`
1094 pub(super) struct ReestablishResponses {
1095         pub channel_ready: Option<msgs::ChannelReady>,
1096         pub raa: Option<msgs::RevokeAndACK>,
1097         pub commitment_update: Option<msgs::CommitmentUpdate>,
1098         pub order: RAACommitmentOrder,
1099         pub announcement_sigs: Option<msgs::AnnouncementSignatures>,
1100         pub shutdown_msg: Option<msgs::Shutdown>,
1101 }
1102
1103 /// The result of a shutdown that should be handled.
1104 #[must_use]
1105 pub(crate) struct ShutdownResult {
1106         pub(crate) closure_reason: ClosureReason,
1107         /// A channel monitor update to apply.
1108         pub(crate) monitor_update: Option<(PublicKey, OutPoint, ChannelId, ChannelMonitorUpdate)>,
1109         /// A list of dropped outbound HTLCs that can safely be failed backwards immediately.
1110         pub(crate) dropped_outbound_htlcs: Vec<(HTLCSource, PaymentHash, PublicKey, ChannelId)>,
1111         /// An unbroadcasted batch funding transaction id. The closure of this channel should be
1112         /// propagated to the remainder of the batch.
1113         pub(crate) unbroadcasted_batch_funding_txid: Option<Txid>,
1114         pub(crate) channel_id: ChannelId,
1115         pub(crate) user_channel_id: u128,
1116         pub(crate) channel_capacity_satoshis: u64,
1117         pub(crate) counterparty_node_id: PublicKey,
1118         pub(crate) unbroadcasted_funding_tx: Option<Transaction>,
1119         pub(crate) channel_funding_txo: Option<OutPoint>,
1120 }
1121
1122 /// Tracks the transaction number, along with current and next commitment points.
1123 /// This consolidates the logic to advance our commitment number and request new
1124 /// commitment points from our signer.
1125 #[derive(Debug, Copy, Clone)]
1126 enum HolderCommitmentPoint {
1127         // TODO: add a variant for before our first commitment point is retrieved
1128         /// We've advanced our commitment number and are waiting on the next commitment point.
1129         /// Until the `get_per_commitment_point` signer method becomes async, this variant
1130         /// will not be used.
1131         PendingNext { transaction_number: u64, current: PublicKey },
1132         /// Our current commitment point is ready, we've cached our next point,
1133         /// and we are not pending a new one.
1134         Available { transaction_number: u64, current: PublicKey, next: PublicKey },
1135 }
1136
1137 impl HolderCommitmentPoint {
1138         pub fn new<SP: Deref>(signer: &ChannelSignerType<SP>, secp_ctx: &Secp256k1<secp256k1::All>) -> Self
1139                 where SP::Target: SignerProvider
1140         {
1141                 HolderCommitmentPoint::Available {
1142                         transaction_number: INITIAL_COMMITMENT_NUMBER,
1143                         current: signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER, secp_ctx),
1144                         next: signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, secp_ctx),
1145                 }
1146         }
1147
1148         pub fn is_available(&self) -> bool {
1149                 if let HolderCommitmentPoint::Available { .. } = self { true } else { false }
1150         }
1151
1152         pub fn transaction_number(&self) -> u64 {
1153                 match self {
1154                         HolderCommitmentPoint::PendingNext { transaction_number, .. } => *transaction_number,
1155                         HolderCommitmentPoint::Available { transaction_number, .. } => *transaction_number,
1156                 }
1157         }
1158
1159         pub fn current_point(&self) -> PublicKey {
1160                 match self {
1161                         HolderCommitmentPoint::PendingNext { current, .. } => *current,
1162                         HolderCommitmentPoint::Available { current, .. } => *current,
1163                 }
1164         }
1165
1166         pub fn next_point(&self) -> Option<PublicKey> {
1167                 match self {
1168                         HolderCommitmentPoint::PendingNext { .. } => None,
1169                         HolderCommitmentPoint::Available { next, .. } => Some(*next),
1170                 }
1171         }
1172
1173         pub fn advance<SP: Deref, L: Deref>(&mut self, signer: &ChannelSignerType<SP>, secp_ctx: &Secp256k1<secp256k1::All>, logger: &L)
1174                 where SP::Target: SignerProvider, L::Target: Logger
1175         {
1176                 if let HolderCommitmentPoint::Available { transaction_number, next, .. } = self {
1177                         *self = HolderCommitmentPoint::PendingNext {
1178                                 transaction_number: *transaction_number - 1,
1179                                 current: *next,
1180                         };
1181                 }
1182
1183                 if let HolderCommitmentPoint::PendingNext { transaction_number, current } = self {
1184                         let next = signer.as_ref().get_per_commitment_point(*transaction_number - 1, secp_ctx);
1185                         log_trace!(logger, "Retrieved next per-commitment point {}", *transaction_number - 1);
1186                         *self = HolderCommitmentPoint::Available { transaction_number: *transaction_number, current: *current, next };
1187                 }
1188         }
1189 }
1190
1191 /// If the majority of the channels funds are to the fundee and the initiator holds only just
1192 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
1193 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
1194 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
1195 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
1196 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
1197 /// by this multiple without hitting this case, before sending.
1198 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
1199 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
1200 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
1201 /// leave the channel less usable as we hold a bigger reserve.
1202 #[cfg(any(fuzzing, test))]
1203 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
1204 #[cfg(not(any(fuzzing, test)))]
1205 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
1206
1207 /// If we fail to see a funding transaction confirmed on-chain within this many blocks after the
1208 /// channel creation on an inbound channel, we simply force-close and move on.
1209 /// This constant is the one suggested in BOLT 2.
1210 pub(crate) const FUNDING_CONF_DEADLINE_BLOCKS: u32 = 2016;
1211
1212 /// In case of a concurrent update_add_htlc proposed by our counterparty, we might
1213 /// not have enough balance value remaining to cover the onchain cost of this new
1214 /// HTLC weight. If this happens, our counterparty fails the reception of our
1215 /// commitment_signed including this new HTLC due to infringement on the channel
1216 /// reserve.
1217 /// To prevent this case, we compute our outbound update_fee with an HTLC buffer of
1218 /// size 2. However, if the number of concurrent update_add_htlc is higher, this still
1219 /// leads to a channel force-close. Ultimately, this is an issue coming from the
1220 /// design of LN state machines, allowing asynchronous updates.
1221 pub(crate) const CONCURRENT_INBOUND_HTLC_FEE_BUFFER: u32 = 2;
1222
1223 /// When a channel is opened, we check that the funding amount is enough to pay for relevant
1224 /// commitment transaction fees, with at least this many HTLCs present on the commitment
1225 /// transaction (not counting the value of the HTLCs themselves).
1226 pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
1227
1228 /// When a [`Channel`] has its [`ChannelConfig`] updated, its existing one is stashed for up to this
1229 /// number of ticks to allow forwarding HTLCs by nodes that have yet to receive the new
1230 /// ChannelUpdate prompted by the config update. This value was determined as follows:
1231 ///
1232 ///   * The expected interval between ticks (1 minute).
1233 ///   * The average convergence delay of updates across the network, i.e., ~300 seconds on average
1234 ///      for a node to see an update as seen on `<https://arxiv.org/pdf/2205.12737.pdf>`.
1235 ///   * `EXPIRE_PREV_CONFIG_TICKS` = convergence_delay / tick_interval
1236 pub(crate) const EXPIRE_PREV_CONFIG_TICKS: usize = 5;
1237
1238 /// The number of ticks that may elapse while we're waiting for a response to a
1239 /// [`msgs::RevokeAndACK`] or [`msgs::ChannelReestablish`] message before we attempt to disconnect
1240 /// them.
1241 ///
1242 /// See [`ChannelContext::sent_message_awaiting_response`] for more information.
1243 pub(crate) const DISCONNECT_PEER_AWAITING_RESPONSE_TICKS: usize = 2;
1244
1245 /// The number of ticks that may elapse while we're waiting for an unfunded outbound/inbound channel
1246 /// to be promoted to a [`Channel`] since the unfunded channel was created. An unfunded channel
1247 /// exceeding this age limit will be force-closed and purged from memory.
1248 pub(crate) const UNFUNDED_CHANNEL_AGE_LIMIT_TICKS: usize = 60;
1249
1250 /// Number of blocks needed for an output from a coinbase transaction to be spendable.
1251 pub(crate) const COINBASE_MATURITY: u32 = 100;
1252
1253 struct PendingChannelMonitorUpdate {
1254         update: ChannelMonitorUpdate,
1255 }
1256
1257 impl_writeable_tlv_based!(PendingChannelMonitorUpdate, {
1258         (0, update, required),
1259 });
1260
1261 /// The `ChannelPhase` enum describes the current phase in life of a lightning channel with each of
1262 /// its variants containing an appropriate channel struct.
1263 pub(super) enum ChannelPhase<SP: Deref> where SP::Target: SignerProvider {
1264         UnfundedOutboundV1(OutboundV1Channel<SP>),
1265         UnfundedInboundV1(InboundV1Channel<SP>),
1266         #[cfg(any(dual_funding, splicing))]
1267         UnfundedOutboundV2(OutboundV2Channel<SP>),
1268         #[cfg(any(dual_funding, splicing))]
1269         UnfundedInboundV2(InboundV2Channel<SP>),
1270         Funded(Channel<SP>),
1271 }
1272
1273 impl<'a, SP: Deref> ChannelPhase<SP> where
1274         SP::Target: SignerProvider,
1275         <SP::Target as SignerProvider>::EcdsaSigner: ChannelSigner,
1276 {
1277         pub fn context(&'a self) -> &'a ChannelContext<SP> {
1278                 match self {
1279                         ChannelPhase::Funded(chan) => &chan.context,
1280                         ChannelPhase::UnfundedOutboundV1(chan) => &chan.context,
1281                         ChannelPhase::UnfundedInboundV1(chan) => &chan.context,
1282                         #[cfg(any(dual_funding, splicing))]
1283                         ChannelPhase::UnfundedOutboundV2(chan) => &chan.context,
1284                         #[cfg(any(dual_funding, splicing))]
1285                         ChannelPhase::UnfundedInboundV2(chan) => &chan.context,
1286                 }
1287         }
1288
1289         pub fn context_mut(&'a mut self) -> &'a mut ChannelContext<SP> {
1290                 match self {
1291                         ChannelPhase::Funded(ref mut chan) => &mut chan.context,
1292                         ChannelPhase::UnfundedOutboundV1(ref mut chan) => &mut chan.context,
1293                         ChannelPhase::UnfundedInboundV1(ref mut chan) => &mut chan.context,
1294                         #[cfg(any(dual_funding, splicing))]
1295                         ChannelPhase::UnfundedOutboundV2(ref mut chan) => &mut chan.context,
1296                         #[cfg(any(dual_funding, splicing))]
1297                         ChannelPhase::UnfundedInboundV2(ref mut chan) => &mut chan.context,
1298                 }
1299         }
1300 }
1301
1302 /// Contains all state common to unfunded inbound/outbound channels.
1303 pub(super) struct UnfundedChannelContext {
1304         /// A counter tracking how many ticks have elapsed since this unfunded channel was
1305         /// created. If this unfunded channel reaches peer has yet to respond after reaching
1306         /// `UNFUNDED_CHANNEL_AGE_LIMIT_TICKS`, it will be force-closed and purged from memory.
1307         ///
1308         /// This is so that we don't keep channels around that haven't progressed to a funded state
1309         /// in a timely manner.
1310         unfunded_channel_age_ticks: usize,
1311 }
1312
1313 impl UnfundedChannelContext {
1314         /// Determines whether we should force-close and purge this unfunded channel from memory due to it
1315         /// having reached the unfunded channel age limit.
1316         ///
1317         /// This should be called on every [`super::channelmanager::ChannelManager::timer_tick_occurred`].
1318         pub fn should_expire_unfunded_channel(&mut self) -> bool {
1319                 self.unfunded_channel_age_ticks += 1;
1320                 self.unfunded_channel_age_ticks >= UNFUNDED_CHANNEL_AGE_LIMIT_TICKS
1321         }
1322 }
1323
1324 /// Contains everything about the channel including state, and various flags.
1325 pub(super) struct ChannelContext<SP: Deref> where SP::Target: SignerProvider {
1326         config: LegacyChannelConfig,
1327
1328         // Track the previous `ChannelConfig` so that we can continue forwarding HTLCs that were
1329         // constructed using it. The second element in the tuple corresponds to the number of ticks that
1330         // have elapsed since the update occurred.
1331         prev_config: Option<(ChannelConfig, usize)>,
1332
1333         inbound_handshake_limits_override: Option<ChannelHandshakeLimits>,
1334
1335         user_id: u128,
1336
1337         /// The current channel ID.
1338         channel_id: ChannelId,
1339         /// The temporary channel ID used during channel setup. Value kept even after transitioning to a final channel ID.
1340         /// Will be `None` for channels created prior to 0.0.115.
1341         temporary_channel_id: Option<ChannelId>,
1342         channel_state: ChannelState,
1343
1344         // When we reach max(6 blocks, minimum_depth), we need to send an AnnouncementSigs message to
1345         // our peer. However, we want to make sure they received it, or else rebroadcast it when we
1346         // next connect.
1347         // We do so here, see `AnnouncementSigsSent` for more details on the state(s).
1348         // Note that a number of our tests were written prior to the behavior here which retransmits
1349         // AnnouncementSignatures until after an RAA completes, so the behavior is short-circuited in
1350         // many tests.
1351         #[cfg(any(test, feature = "_test_utils"))]
1352         pub(crate) announcement_sigs_state: AnnouncementSigsState,
1353         #[cfg(not(any(test, feature = "_test_utils")))]
1354         announcement_sigs_state: AnnouncementSigsState,
1355
1356         secp_ctx: Secp256k1<secp256k1::All>,
1357         channel_value_satoshis: u64,
1358
1359         latest_monitor_update_id: u64,
1360
1361         holder_signer: ChannelSignerType<SP>,
1362         shutdown_scriptpubkey: Option<ShutdownScript>,
1363         destination_script: ScriptBuf,
1364
1365         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
1366         // generation start at 0 and count up...this simplifies some parts of implementation at the
1367         // cost of others, but should really just be changed.
1368
1369         holder_commitment_point: HolderCommitmentPoint,
1370         cur_counterparty_commitment_transaction_number: u64,
1371         value_to_self_msat: u64, // Excluding all pending_htlcs, fees, and anchor outputs
1372         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
1373         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
1374         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
1375
1376         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
1377         /// need to ensure we resend them in the order we originally generated them. Note that because
1378         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
1379         /// sufficient to simply set this to the opposite of any message we are generating as we
1380         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
1381         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
1382         /// send it first.
1383         resend_order: RAACommitmentOrder,
1384
1385         monitor_pending_channel_ready: bool,
1386         monitor_pending_revoke_and_ack: bool,
1387         monitor_pending_commitment_signed: bool,
1388
1389         // TODO: If a channel is drop'd, we don't know whether the `ChannelMonitor` is ultimately
1390         // responsible for some of the HTLCs here or not - we don't know whether the update in question
1391         // completed or not. We currently ignore these fields entirely when force-closing a channel,
1392         // but need to handle this somehow or we run the risk of losing HTLCs!
1393         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
1394         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
1395         monitor_pending_finalized_fulfills: Vec<HTLCSource>,
1396         monitor_pending_update_adds: Vec<msgs::UpdateAddHTLC>,
1397
1398         /// If we went to send a commitment update (ie some messages then [`msgs::CommitmentSigned`])
1399         /// but our signer (initially) refused to give us a signature, we should retry at some point in
1400         /// the future when the signer indicates it may have a signature for us.
1401         ///
1402         /// This flag is set in such a case. Note that we don't need to persist this as we'll end up
1403         /// setting it again as a side-effect of [`Channel::channel_reestablish`].
1404         signer_pending_commitment_update: bool,
1405         /// Similar to [`Self::signer_pending_commitment_update`] but we're waiting to send either a
1406         /// [`msgs::FundingCreated`] or [`msgs::FundingSigned`] depending on if this channel is
1407         /// outbound or inbound.
1408         signer_pending_funding: bool,
1409
1410         // pending_update_fee is filled when sending and receiving update_fee.
1411         //
1412         // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
1413         // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
1414         // generating new commitment transactions with exactly the same criteria as inbound/outbound
1415         // HTLCs with similar state.
1416         pending_update_fee: Option<(u32, FeeUpdateState)>,
1417         // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
1418         // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
1419         // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
1420         // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
1421         // further `send_update_fee` calls, dropping the previous holding cell update entirely.
1422         holding_cell_update_fee: Option<u32>,
1423         next_holder_htlc_id: u64,
1424         next_counterparty_htlc_id: u64,
1425         feerate_per_kw: u32,
1426
1427         /// The timestamp set on our latest `channel_update` message for this channel. It is updated
1428         /// when the channel is updated in ways which may impact the `channel_update` message or when a
1429         /// new block is received, ensuring it's always at least moderately close to the current real
1430         /// time.
1431         update_time_counter: u32,
1432
1433         #[cfg(debug_assertions)]
1434         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
1435         holder_max_commitment_tx_output: Mutex<(u64, u64)>,
1436         #[cfg(debug_assertions)]
1437         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
1438         counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
1439
1440         last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
1441         target_closing_feerate_sats_per_kw: Option<u32>,
1442
1443         /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
1444         /// update, we need to delay processing it until later. We do that here by simply storing the
1445         /// closing_signed message and handling it in `maybe_propose_closing_signed`.
1446         pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
1447
1448         /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
1449         /// transaction. These are set once we reach `closing_negotiation_ready`.
1450         #[cfg(test)]
1451         pub(crate) closing_fee_limits: Option<(u64, u64)>,
1452         #[cfg(not(test))]
1453         closing_fee_limits: Option<(u64, u64)>,
1454
1455         /// If we remove an HTLC (or fee update), commit, and receive our counterparty's
1456         /// `revoke_and_ack`, we remove all knowledge of said HTLC (or fee update). However, the latest
1457         /// local commitment transaction that we can broadcast still contains the HTLC (or old fee)
1458         /// until we receive a further `commitment_signed`. Thus we are not eligible for initiating the
1459         /// `closing_signed` negotiation if we're expecting a counterparty `commitment_signed`.
1460         ///
1461         /// To ensure we don't send a `closing_signed` too early, we track this state here, waiting
1462         /// until we see a `commitment_signed` before doing so.
1463         ///
1464         /// We don't bother to persist this - we anticipate this state won't last longer than a few
1465         /// milliseconds, so any accidental force-closes here should be exceedingly rare.
1466         expecting_peer_commitment_signed: bool,
1467
1468         /// The hash of the block in which the funding transaction was included.
1469         funding_tx_confirmed_in: Option<BlockHash>,
1470         funding_tx_confirmation_height: u32,
1471         short_channel_id: Option<u64>,
1472         /// Either the height at which this channel was created or the height at which it was last
1473         /// serialized if it was serialized by versions prior to 0.0.103.
1474         /// We use this to close if funding is never broadcasted.
1475         pub(super) channel_creation_height: u32,
1476
1477         counterparty_dust_limit_satoshis: u64,
1478
1479         #[cfg(test)]
1480         pub(super) holder_dust_limit_satoshis: u64,
1481         #[cfg(not(test))]
1482         holder_dust_limit_satoshis: u64,
1483
1484         #[cfg(test)]
1485         pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
1486         #[cfg(not(test))]
1487         counterparty_max_htlc_value_in_flight_msat: u64,
1488
1489         #[cfg(test)]
1490         pub(super) holder_max_htlc_value_in_flight_msat: u64,
1491         #[cfg(not(test))]
1492         holder_max_htlc_value_in_flight_msat: u64,
1493
1494         /// minimum channel reserve for self to maintain - set by them.
1495         counterparty_selected_channel_reserve_satoshis: Option<u64>,
1496
1497         #[cfg(test)]
1498         pub(super) holder_selected_channel_reserve_satoshis: u64,
1499         #[cfg(not(test))]
1500         holder_selected_channel_reserve_satoshis: u64,
1501
1502         counterparty_htlc_minimum_msat: u64,
1503         holder_htlc_minimum_msat: u64,
1504         #[cfg(test)]
1505         pub counterparty_max_accepted_htlcs: u16,
1506         #[cfg(not(test))]
1507         counterparty_max_accepted_htlcs: u16,
1508         holder_max_accepted_htlcs: u16,
1509         minimum_depth: Option<u32>,
1510
1511         counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
1512
1513         pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
1514         funding_transaction: Option<Transaction>,
1515         is_batch_funding: Option<()>,
1516
1517         counterparty_cur_commitment_point: Option<PublicKey>,
1518         counterparty_prev_commitment_point: Option<PublicKey>,
1519         counterparty_node_id: PublicKey,
1520
1521         counterparty_shutdown_scriptpubkey: Option<ScriptBuf>,
1522
1523         commitment_secrets: CounterpartyCommitmentSecrets,
1524
1525         channel_update_status: ChannelUpdateStatus,
1526         /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
1527         /// not complete within a single timer tick (one minute), we should force-close the channel.
1528         /// This prevents us from keeping unusable channels around forever if our counterparty wishes
1529         /// to DoS us.
1530         /// Note that this field is reset to false on deserialization to give us a chance to connect to
1531         /// our peer and start the closing_signed negotiation fresh.
1532         closing_signed_in_flight: bool,
1533
1534         /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
1535         /// This can be used to rebroadcast the channel_announcement message later.
1536         announcement_sigs: Option<(Signature, Signature)>,
1537
1538         // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
1539         // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
1540         // be, by comparing the cached values to the fee of the tranaction generated by
1541         // `build_commitment_transaction`.
1542         #[cfg(any(test, fuzzing))]
1543         next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
1544         #[cfg(any(test, fuzzing))]
1545         next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
1546
1547         /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
1548         /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
1549         /// channel_ready *before* sending the channel_reestablish (which is clearly a violation of
1550         /// the BOLT specs). We copy c-lightning's workaround here and simply store the channel_ready
1551         /// message until we receive a channel_reestablish.
1552         ///
1553         /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
1554         pub workaround_lnd_bug_4006: Option<msgs::ChannelReady>,
1555
1556         /// An option set when we wish to track how many ticks have elapsed while waiting for a response
1557         /// from our counterparty after sending a message. If the peer has yet to respond after reaching
1558         /// `DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`, a reconnection should be attempted to try to
1559         /// unblock the state machine.
1560         ///
1561         /// This behavior is mostly motivated by a lnd bug in which we don't receive a message we expect
1562         /// to in a timely manner, which may lead to channels becoming unusable and/or force-closed. An
1563         /// example of such can be found at <https://github.com/lightningnetwork/lnd/issues/7682>.
1564         ///
1565         /// This is currently only used when waiting for a [`msgs::ChannelReestablish`] or
1566         /// [`msgs::RevokeAndACK`] message from the counterparty.
1567         sent_message_awaiting_response: Option<usize>,
1568
1569         #[cfg(any(test, fuzzing))]
1570         // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
1571         // corresponding HTLC on the inbound path. If, then, the outbound path channel is
1572         // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
1573         // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
1574         // is fine, but as a sanity check in our failure to generate the second claim, we check here
1575         // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
1576         historical_inbound_htlc_fulfills: HashSet<u64>,
1577
1578         /// This channel's type, as negotiated during channel open
1579         channel_type: ChannelTypeFeatures,
1580
1581         // Our counterparty can offer us SCID aliases which they will map to this channel when routing
1582         // outbound payments. These can be used in invoice route hints to avoid explicitly revealing
1583         // the channel's funding UTXO.
1584         //
1585         // We also use this when sending our peer a channel_update that isn't to be broadcasted
1586         // publicly - allowing them to re-use their map of SCID -> channel for channel_update ->
1587         // associated channel mapping.
1588         //
1589         // We only bother storing the most recent SCID alias at any time, though our counterparty has
1590         // to store all of them.
1591         latest_inbound_scid_alias: Option<u64>,
1592
1593         // We always offer our counterparty a static SCID alias, which we recognize as for this channel
1594         // if we see it in HTLC forwarding instructions. We don't bother rotating the alias given we
1595         // don't currently support node id aliases and eventually privacy should be provided with
1596         // blinded paths instead of simple scid+node_id aliases.
1597         outbound_scid_alias: u64,
1598
1599         // We track whether we already emitted a `ChannelPending` event.
1600         channel_pending_event_emitted: bool,
1601
1602         // We track whether we already emitted a `ChannelReady` event.
1603         channel_ready_event_emitted: bool,
1604
1605         /// Some if we initiated to shut down the channel.
1606         local_initiated_shutdown: Option<()>,
1607
1608         /// The unique identifier used to re-derive the private key material for the channel through
1609         /// [`SignerProvider::derive_channel_signer`].
1610         #[cfg(not(test))]
1611         channel_keys_id: [u8; 32],
1612         #[cfg(test)]
1613         pub channel_keys_id: [u8; 32],
1614
1615         /// If we can't release a [`ChannelMonitorUpdate`] until some external action completes, we
1616         /// store it here and only release it to the `ChannelManager` once it asks for it.
1617         blocked_monitor_updates: Vec<PendingChannelMonitorUpdate>,
1618 }
1619
1620 impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider  {
1621         fn new_for_inbound_channel<'a, ES: Deref, F: Deref, L: Deref>(
1622                 fee_estimator: &'a LowerBoundedFeeEstimator<F>,
1623                 entropy_source: &'a ES,
1624                 signer_provider: &'a SP,
1625                 counterparty_node_id: PublicKey,
1626                 their_features: &'a InitFeatures,
1627                 user_id: u128,
1628                 config: &'a UserConfig,
1629                 current_chain_height: u32,
1630                 logger: &'a L,
1631                 is_0conf: bool,
1632                 our_funding_satoshis: u64,
1633                 counterparty_pubkeys: ChannelPublicKeys,
1634                 channel_type: ChannelTypeFeatures,
1635                 holder_selected_channel_reserve_satoshis: u64,
1636                 msg_channel_reserve_satoshis: u64,
1637                 msg_push_msat: u64,
1638                 open_channel_fields: msgs::CommonOpenChannelFields,
1639         ) -> Result<ChannelContext<SP>, ChannelError>
1640                 where
1641                         ES::Target: EntropySource,
1642                         F::Target: FeeEstimator,
1643                         L::Target: Logger,
1644                         SP::Target: SignerProvider,
1645         {
1646                 let logger = WithContext::from(logger, Some(counterparty_node_id), Some(open_channel_fields.temporary_channel_id), None);
1647                 let announced_channel = if (open_channel_fields.channel_flags & 1) == 1 { true } else { false };
1648
1649                 let channel_value_satoshis = our_funding_satoshis.saturating_add(open_channel_fields.funding_satoshis);
1650
1651                 let channel_keys_id = signer_provider.generate_channel_keys_id(true, channel_value_satoshis, user_id);
1652                 let holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1653                 let pubkeys = holder_signer.pubkeys().clone();
1654
1655                 if config.channel_handshake_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
1656                         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)));
1657                 }
1658
1659                 // Check sanity of message fields:
1660                 if channel_value_satoshis > config.channel_handshake_limits.max_funding_satoshis {
1661                         return Err(ChannelError::Close(format!(
1662                                 "Per our config, funding must be at most {}. It was {}. Peer contribution: {}. Our contribution: {}",
1663                                 config.channel_handshake_limits.max_funding_satoshis, channel_value_satoshis,
1664                                 open_channel_fields.funding_satoshis, our_funding_satoshis)));
1665                 }
1666                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1667                         return Err(ChannelError::Close(format!("Funding must be smaller than the total bitcoin supply. It was {}", channel_value_satoshis)));
1668                 }
1669                 if msg_channel_reserve_satoshis > channel_value_satoshis {
1670                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be no greater than channel_value_satoshis: {}", msg_channel_reserve_satoshis, channel_value_satoshis)));
1671                 }
1672                 let full_channel_value_msat = (channel_value_satoshis - msg_channel_reserve_satoshis) * 1000;
1673                 if msg_push_msat > full_channel_value_msat {
1674                         return Err(ChannelError::Close(format!("push_msat {} was larger than channel amount minus reserve ({})", msg_push_msat, full_channel_value_msat)));
1675                 }
1676                 if open_channel_fields.dust_limit_satoshis > channel_value_satoshis {
1677                         return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than channel_value_satoshis {}. Peer never wants payout outputs?", open_channel_fields.dust_limit_satoshis, channel_value_satoshis)));
1678                 }
1679                 if open_channel_fields.htlc_minimum_msat >= full_channel_value_msat {
1680                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", open_channel_fields.htlc_minimum_msat, full_channel_value_msat)));
1681                 }
1682                 Channel::<SP>::check_remote_fee(&channel_type, fee_estimator, open_channel_fields.commitment_feerate_sat_per_1000_weight, None, &&logger)?;
1683
1684                 let max_counterparty_selected_contest_delay = u16::min(config.channel_handshake_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1685                 if open_channel_fields.to_self_delay > max_counterparty_selected_contest_delay {
1686                         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, open_channel_fields.to_self_delay)));
1687                 }
1688                 if open_channel_fields.max_accepted_htlcs < 1 {
1689                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1690                 }
1691                 if open_channel_fields.max_accepted_htlcs > MAX_HTLCS {
1692                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", open_channel_fields.max_accepted_htlcs, MAX_HTLCS)));
1693                 }
1694
1695                 // Now check against optional parameters as set by config...
1696                 if channel_value_satoshis < config.channel_handshake_limits.min_funding_satoshis {
1697                         return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", channel_value_satoshis, config.channel_handshake_limits.min_funding_satoshis)));
1698                 }
1699                 if open_channel_fields.htlc_minimum_msat > config.channel_handshake_limits.max_htlc_minimum_msat {
1700                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", open_channel_fields.htlc_minimum_msat, config.channel_handshake_limits.max_htlc_minimum_msat)));
1701                 }
1702                 if open_channel_fields.max_htlc_value_in_flight_msat < config.channel_handshake_limits.min_max_htlc_value_in_flight_msat {
1703                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", open_channel_fields.max_htlc_value_in_flight_msat, config.channel_handshake_limits.min_max_htlc_value_in_flight_msat)));
1704                 }
1705                 if msg_channel_reserve_satoshis > config.channel_handshake_limits.max_channel_reserve_satoshis {
1706                         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)));
1707                 }
1708                 if open_channel_fields.max_accepted_htlcs < config.channel_handshake_limits.min_max_accepted_htlcs {
1709                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", open_channel_fields.max_accepted_htlcs, config.channel_handshake_limits.min_max_accepted_htlcs)));
1710                 }
1711                 if open_channel_fields.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1712                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", open_channel_fields.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1713                 }
1714                 if open_channel_fields.dust_limit_satoshis >  MAX_CHAN_DUST_LIMIT_SATOSHIS {
1715                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", open_channel_fields.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1716                 }
1717
1718                 // Convert things into internal flags and prep our state:
1719
1720                 if config.channel_handshake_limits.force_announced_channel_preference {
1721                         if config.channel_handshake_config.announced_channel != announced_channel {
1722                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
1723                         }
1724                 }
1725
1726                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1727                         // Protocol level safety check in place, although it should never happen because
1728                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
1729                         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)));
1730                 }
1731                 if holder_selected_channel_reserve_satoshis * 1000 >= full_channel_value_msat {
1732                         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)));
1733                 }
1734                 if msg_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1735                         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.",
1736                                 msg_channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
1737                 }
1738                 if holder_selected_channel_reserve_satoshis < open_channel_fields.dust_limit_satoshis {
1739                         return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", open_channel_fields.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
1740                 }
1741
1742                 // check if the funder's amount for the initial commitment tx is sufficient
1743                 // for full fee payment plus a few HTLCs to ensure the channel will be useful.
1744                 let anchor_outputs_value = if channel_type.supports_anchors_zero_fee_htlc_tx() {
1745                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2
1746                 } else {
1747                         0
1748                 };
1749                 let funders_amount_msat = open_channel_fields.funding_satoshis * 1000 - msg_push_msat;
1750                 let commitment_tx_fee = commit_tx_fee_msat(open_channel_fields.commitment_feerate_sat_per_1000_weight, MIN_AFFORDABLE_HTLC_COUNT, &channel_type) / 1000;
1751                 if (funders_amount_msat / 1000).saturating_sub(anchor_outputs_value) < commitment_tx_fee {
1752                         return Err(ChannelError::Close(format!("Funding amount ({} sats) can't even pay fee for initial commitment transaction fee of {} sats.", (funders_amount_msat / 1000).saturating_sub(anchor_outputs_value), commitment_tx_fee)));
1753                 }
1754
1755                 let to_remote_satoshis = funders_amount_msat / 1000 - commitment_tx_fee - anchor_outputs_value;
1756                 // While it's reasonable for us to not meet the channel reserve initially (if they don't
1757                 // want to push much to us), our counterparty should always have more than our reserve.
1758                 if to_remote_satoshis < holder_selected_channel_reserve_satoshis {
1759                         return Err(ChannelError::Close("Insufficient funding amount for initial reserve".to_owned()));
1760                 }
1761
1762                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1763                         match &open_channel_fields.shutdown_scriptpubkey {
1764                                 &Some(ref script) => {
1765                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1766                                         if script.len() == 0 {
1767                                                 None
1768                                         } else {
1769                                                 if !script::is_bolt2_compliant(&script, their_features) {
1770                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
1771                                                 }
1772                                                 Some(script.clone())
1773                                         }
1774                                 },
1775                                 // 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
1776                                 &None => {
1777                                         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()));
1778                                 }
1779                         }
1780                 } else { None };
1781
1782                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
1783                         match signer_provider.get_shutdown_scriptpubkey() {
1784                                 Ok(scriptpubkey) => Some(scriptpubkey),
1785                                 Err(_) => return Err(ChannelError::Close("Failed to get upfront shutdown scriptpubkey".to_owned())),
1786                         }
1787                 } else { None };
1788
1789                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1790                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
1791                                 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
1792                         }
1793                 }
1794
1795                 let destination_script = match signer_provider.get_destination_script(channel_keys_id) {
1796                         Ok(script) => script,
1797                         Err(_) => return Err(ChannelError::Close("Failed to get destination script".to_owned())),
1798                 };
1799
1800                 let mut secp_ctx = Secp256k1::new();
1801                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1802
1803                 let minimum_depth = if is_0conf {
1804                         Some(0)
1805                 } else {
1806                         Some(cmp::max(config.channel_handshake_config.minimum_depth, 1))
1807                 };
1808
1809                 let value_to_self_msat = our_funding_satoshis * 1000 + msg_push_msat;
1810
1811                 let holder_signer = ChannelSignerType::Ecdsa(holder_signer);
1812                 let holder_commitment_point = HolderCommitmentPoint::new(&holder_signer, &secp_ctx);
1813
1814                 // TODO(dual_funding): Checks for `funding_feerate_sat_per_1000_weight`?
1815
1816                 let channel_context = ChannelContext {
1817                         user_id,
1818
1819                         config: LegacyChannelConfig {
1820                                 options: config.channel_config.clone(),
1821                                 announced_channel,
1822                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
1823                         },
1824
1825                         prev_config: None,
1826
1827                         inbound_handshake_limits_override: None,
1828
1829                         temporary_channel_id: Some(open_channel_fields.temporary_channel_id),
1830                         channel_id: open_channel_fields.temporary_channel_id,
1831                         channel_state: ChannelState::NegotiatingFunding(
1832                                 NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT
1833                         ),
1834                         announcement_sigs_state: AnnouncementSigsState::NotSent,
1835                         secp_ctx,
1836
1837                         latest_monitor_update_id: 0,
1838
1839                         holder_signer,
1840                         shutdown_scriptpubkey,
1841                         destination_script,
1842
1843                         holder_commitment_point,
1844                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1845                         value_to_self_msat,
1846
1847                         pending_inbound_htlcs: Vec::new(),
1848                         pending_outbound_htlcs: Vec::new(),
1849                         holding_cell_htlc_updates: Vec::new(),
1850                         pending_update_fee: None,
1851                         holding_cell_update_fee: None,
1852                         next_holder_htlc_id: 0,
1853                         next_counterparty_htlc_id: 0,
1854                         update_time_counter: 1,
1855
1856                         resend_order: RAACommitmentOrder::CommitmentFirst,
1857
1858                         monitor_pending_channel_ready: false,
1859                         monitor_pending_revoke_and_ack: false,
1860                         monitor_pending_commitment_signed: false,
1861                         monitor_pending_forwards: Vec::new(),
1862                         monitor_pending_failures: Vec::new(),
1863                         monitor_pending_finalized_fulfills: Vec::new(),
1864                         monitor_pending_update_adds: Vec::new(),
1865
1866                         signer_pending_commitment_update: false,
1867                         signer_pending_funding: false,
1868
1869
1870                         #[cfg(debug_assertions)]
1871                         holder_max_commitment_tx_output: Mutex::new((value_to_self_msat, (channel_value_satoshis * 1000 - msg_push_msat).saturating_sub(value_to_self_msat))),
1872                         #[cfg(debug_assertions)]
1873                         counterparty_max_commitment_tx_output: Mutex::new((value_to_self_msat, (channel_value_satoshis * 1000 - msg_push_msat).saturating_sub(value_to_self_msat))),
1874
1875                         last_sent_closing_fee: None,
1876                         pending_counterparty_closing_signed: None,
1877                         expecting_peer_commitment_signed: false,
1878                         closing_fee_limits: None,
1879                         target_closing_feerate_sats_per_kw: None,
1880
1881                         funding_tx_confirmed_in: None,
1882                         funding_tx_confirmation_height: 0,
1883                         short_channel_id: None,
1884                         channel_creation_height: current_chain_height,
1885
1886                         feerate_per_kw: open_channel_fields.commitment_feerate_sat_per_1000_weight,
1887                         channel_value_satoshis,
1888                         counterparty_dust_limit_satoshis: open_channel_fields.dust_limit_satoshis,
1889                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1890                         counterparty_max_htlc_value_in_flight_msat: cmp::min(open_channel_fields.max_htlc_value_in_flight_msat, channel_value_satoshis * 1000),
1891                         holder_max_htlc_value_in_flight_msat: get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
1892                         counterparty_selected_channel_reserve_satoshis: Some(msg_channel_reserve_satoshis),
1893                         holder_selected_channel_reserve_satoshis,
1894                         counterparty_htlc_minimum_msat: open_channel_fields.htlc_minimum_msat,
1895                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
1896                         counterparty_max_accepted_htlcs: open_channel_fields.max_accepted_htlcs,
1897                         holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
1898                         minimum_depth,
1899
1900                         counterparty_forwarding_info: None,
1901
1902                         channel_transaction_parameters: ChannelTransactionParameters {
1903                                 holder_pubkeys: pubkeys,
1904                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
1905                                 is_outbound_from_holder: false,
1906                                 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1907                                         selected_contest_delay: open_channel_fields.to_self_delay,
1908                                         pubkeys: counterparty_pubkeys,
1909                                 }),
1910                                 funding_outpoint: None,
1911                                 channel_type_features: channel_type.clone()
1912                         },
1913                         funding_transaction: None,
1914                         is_batch_funding: None,
1915
1916                         counterparty_cur_commitment_point: Some(open_channel_fields.first_per_commitment_point),
1917                         counterparty_prev_commitment_point: None,
1918                         counterparty_node_id,
1919
1920                         counterparty_shutdown_scriptpubkey,
1921
1922                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1923
1924                         channel_update_status: ChannelUpdateStatus::Enabled,
1925                         closing_signed_in_flight: false,
1926
1927                         announcement_sigs: None,
1928
1929                         #[cfg(any(test, fuzzing))]
1930                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1931                         #[cfg(any(test, fuzzing))]
1932                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1933
1934                         workaround_lnd_bug_4006: None,
1935                         sent_message_awaiting_response: None,
1936
1937                         latest_inbound_scid_alias: None,
1938                         outbound_scid_alias: 0,
1939
1940                         channel_pending_event_emitted: false,
1941                         channel_ready_event_emitted: false,
1942
1943                         #[cfg(any(test, fuzzing))]
1944                         historical_inbound_htlc_fulfills: new_hash_set(),
1945
1946                         channel_type,
1947                         channel_keys_id,
1948
1949                         local_initiated_shutdown: None,
1950
1951                         blocked_monitor_updates: Vec::new(),
1952                 };
1953
1954                 Ok(channel_context)
1955         }
1956
1957         fn new_for_outbound_channel<'a, ES: Deref, F: Deref>(
1958                 fee_estimator: &'a LowerBoundedFeeEstimator<F>,
1959                 entropy_source: &'a ES,
1960                 signer_provider: &'a SP,
1961                 counterparty_node_id: PublicKey,
1962                 their_features: &'a InitFeatures,
1963                 funding_satoshis: u64,
1964                 push_msat: u64,
1965                 user_id: u128,
1966                 config: &'a UserConfig,
1967                 current_chain_height: u32,
1968                 outbound_scid_alias: u64,
1969                 temporary_channel_id: Option<ChannelId>,
1970                 holder_selected_channel_reserve_satoshis: u64,
1971                 channel_keys_id: [u8; 32],
1972                 holder_signer: <SP::Target as SignerProvider>::EcdsaSigner,
1973                 pubkeys: ChannelPublicKeys,
1974         ) -> Result<ChannelContext<SP>, APIError>
1975                 where
1976                         ES::Target: EntropySource,
1977                         F::Target: FeeEstimator,
1978                         SP::Target: SignerProvider,
1979         {
1980                 // This will be updated with the counterparty contribution if this is a dual-funded channel
1981                 let channel_value_satoshis = funding_satoshis;
1982
1983                 let holder_selected_contest_delay = config.channel_handshake_config.our_to_self_delay;
1984
1985                 if !their_features.supports_wumbo() && channel_value_satoshis > MAX_FUNDING_SATOSHIS_NO_WUMBO {
1986                         return Err(APIError::APIMisuseError{err: format!("funding_value must not exceed {}, it was {}", MAX_FUNDING_SATOSHIS_NO_WUMBO, channel_value_satoshis)});
1987                 }
1988                 if channel_value_satoshis >= TOTAL_BITCOIN_SUPPLY_SATOSHIS {
1989                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than the total bitcoin supply, it was {}", channel_value_satoshis)});
1990                 }
1991                 let channel_value_msat = channel_value_satoshis * 1000;
1992                 if push_msat > channel_value_msat {
1993                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
1994                 }
1995                 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
1996                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
1997                 }
1998
1999                 let channel_type = get_initial_channel_type(&config, their_features);
2000                 debug_assert!(channel_type.is_subset(&channelmanager::provided_channel_type_features(&config)));
2001
2002                 let (commitment_conf_target, anchor_outputs_value_msat)  = if channel_type.supports_anchors_zero_fee_htlc_tx() {
2003                         (ConfirmationTarget::AnchorChannelFee, ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000)
2004                 } else {
2005                         (ConfirmationTarget::NonAnchorChannelFee, 0)
2006                 };
2007                 let commitment_feerate = fee_estimator.bounded_sat_per_1000_weight(commitment_conf_target);
2008
2009                 let value_to_self_msat = channel_value_satoshis * 1000 - push_msat;
2010                 let commitment_tx_fee = commit_tx_fee_msat(commitment_feerate, MIN_AFFORDABLE_HTLC_COUNT, &channel_type);
2011                 if value_to_self_msat.saturating_sub(anchor_outputs_value_msat) < commitment_tx_fee {
2012                         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) });
2013                 }
2014
2015                 let mut secp_ctx = Secp256k1::new();
2016                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
2017
2018                 let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
2019                         match signer_provider.get_shutdown_scriptpubkey() {
2020                                 Ok(scriptpubkey) => Some(scriptpubkey),
2021                                 Err(_) => return Err(APIError::ChannelUnavailable { err: "Failed to get shutdown scriptpubkey".to_owned()}),
2022                         }
2023                 } else { None };
2024
2025                 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
2026                         if !shutdown_scriptpubkey.is_compatible(&their_features) {
2027                                 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
2028                         }
2029                 }
2030
2031                 let destination_script = match signer_provider.get_destination_script(channel_keys_id) {
2032                         Ok(script) => script,
2033                         Err(_) => return Err(APIError::ChannelUnavailable { err: "Failed to get destination script".to_owned()}),
2034                 };
2035
2036                 let temporary_channel_id = temporary_channel_id.unwrap_or_else(|| ChannelId::temporary_from_entropy_source(entropy_source));
2037
2038                 let holder_signer = ChannelSignerType::Ecdsa(holder_signer);
2039                 let holder_commitment_point = HolderCommitmentPoint::new(&holder_signer, &secp_ctx);
2040
2041                 Ok(Self {
2042                         user_id,
2043
2044                         config: LegacyChannelConfig {
2045                                 options: config.channel_config.clone(),
2046                                 announced_channel: config.channel_handshake_config.announced_channel,
2047                                 commit_upfront_shutdown_pubkey: config.channel_handshake_config.commit_upfront_shutdown_pubkey,
2048                         },
2049
2050                         prev_config: None,
2051
2052                         inbound_handshake_limits_override: Some(config.channel_handshake_limits.clone()),
2053
2054                         channel_id: temporary_channel_id,
2055                         temporary_channel_id: Some(temporary_channel_id),
2056                         channel_state: ChannelState::NegotiatingFunding(NegotiatingFundingFlags::OUR_INIT_SENT),
2057                         announcement_sigs_state: AnnouncementSigsState::NotSent,
2058                         secp_ctx,
2059                         // We'll add our counterparty's `funding_satoshis` when we receive `accept_channel2`.
2060                         channel_value_satoshis,
2061
2062                         latest_monitor_update_id: 0,
2063
2064                         holder_signer,
2065                         shutdown_scriptpubkey,
2066                         destination_script,
2067
2068                         holder_commitment_point,
2069                         cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
2070                         value_to_self_msat,
2071
2072                         pending_inbound_htlcs: Vec::new(),
2073                         pending_outbound_htlcs: Vec::new(),
2074                         holding_cell_htlc_updates: Vec::new(),
2075                         pending_update_fee: None,
2076                         holding_cell_update_fee: None,
2077                         next_holder_htlc_id: 0,
2078                         next_counterparty_htlc_id: 0,
2079                         update_time_counter: 1,
2080
2081                         resend_order: RAACommitmentOrder::CommitmentFirst,
2082
2083                         monitor_pending_channel_ready: false,
2084                         monitor_pending_revoke_and_ack: false,
2085                         monitor_pending_commitment_signed: false,
2086                         monitor_pending_forwards: Vec::new(),
2087                         monitor_pending_failures: Vec::new(),
2088                         monitor_pending_finalized_fulfills: Vec::new(),
2089                         monitor_pending_update_adds: Vec::new(),
2090
2091                         signer_pending_commitment_update: false,
2092                         signer_pending_funding: false,
2093
2094                         // We'll add our counterparty's `funding_satoshis` to these max commitment output assertions
2095                         // when we receive `accept_channel2`.
2096                         #[cfg(debug_assertions)]
2097                         holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
2098                         #[cfg(debug_assertions)]
2099                         counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
2100
2101                         last_sent_closing_fee: None,
2102                         pending_counterparty_closing_signed: None,
2103                         expecting_peer_commitment_signed: false,
2104                         closing_fee_limits: None,
2105                         target_closing_feerate_sats_per_kw: None,
2106
2107                         funding_tx_confirmed_in: None,
2108                         funding_tx_confirmation_height: 0,
2109                         short_channel_id: None,
2110                         channel_creation_height: current_chain_height,
2111
2112                         feerate_per_kw: commitment_feerate,
2113                         counterparty_dust_limit_satoshis: 0,
2114                         holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
2115                         counterparty_max_htlc_value_in_flight_msat: 0,
2116                         // We'll adjust this to include our counterparty's `funding_satoshis` when we
2117                         // receive `accept_channel2`.
2118                         holder_max_htlc_value_in_flight_msat: get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis, &config.channel_handshake_config),
2119                         counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
2120                         holder_selected_channel_reserve_satoshis,
2121                         counterparty_htlc_minimum_msat: 0,
2122                         holder_htlc_minimum_msat: if config.channel_handshake_config.our_htlc_minimum_msat == 0 { 1 } else { config.channel_handshake_config.our_htlc_minimum_msat },
2123                         counterparty_max_accepted_htlcs: 0,
2124                         holder_max_accepted_htlcs: cmp::min(config.channel_handshake_config.our_max_accepted_htlcs, MAX_HTLCS),
2125                         minimum_depth: None, // Filled in in accept_channel
2126
2127                         counterparty_forwarding_info: None,
2128
2129                         channel_transaction_parameters: ChannelTransactionParameters {
2130                                 holder_pubkeys: pubkeys,
2131                                 holder_selected_contest_delay: config.channel_handshake_config.our_to_self_delay,
2132                                 is_outbound_from_holder: true,
2133                                 counterparty_parameters: None,
2134                                 funding_outpoint: None,
2135                                 channel_type_features: channel_type.clone()
2136                         },
2137                         funding_transaction: None,
2138                         is_batch_funding: None,
2139
2140                         counterparty_cur_commitment_point: None,
2141                         counterparty_prev_commitment_point: None,
2142                         counterparty_node_id,
2143
2144                         counterparty_shutdown_scriptpubkey: None,
2145
2146                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
2147
2148                         channel_update_status: ChannelUpdateStatus::Enabled,
2149                         closing_signed_in_flight: false,
2150
2151                         announcement_sigs: None,
2152
2153                         #[cfg(any(test, fuzzing))]
2154                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
2155                         #[cfg(any(test, fuzzing))]
2156                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
2157
2158                         workaround_lnd_bug_4006: None,
2159                         sent_message_awaiting_response: None,
2160
2161                         latest_inbound_scid_alias: None,
2162                         outbound_scid_alias,
2163
2164                         channel_pending_event_emitted: false,
2165                         channel_ready_event_emitted: false,
2166
2167                         #[cfg(any(test, fuzzing))]
2168                         historical_inbound_htlc_fulfills: new_hash_set(),
2169
2170                         channel_type,
2171                         channel_keys_id,
2172
2173                         blocked_monitor_updates: Vec::new(),
2174                         local_initiated_shutdown: None,
2175                 })
2176         }
2177
2178         /// Allowed in any state (including after shutdown)
2179         pub fn get_update_time_counter(&self) -> u32 {
2180                 self.update_time_counter
2181         }
2182
2183         pub fn get_latest_monitor_update_id(&self) -> u64 {
2184                 self.latest_monitor_update_id
2185         }
2186
2187         pub fn should_announce(&self) -> bool {
2188                 self.config.announced_channel
2189         }
2190
2191         pub fn is_outbound(&self) -> bool {
2192                 self.channel_transaction_parameters.is_outbound_from_holder
2193         }
2194
2195         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2196         /// Allowed in any state (including after shutdown)
2197         pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
2198                 self.config.options.forwarding_fee_base_msat
2199         }
2200
2201         /// Returns true if we've ever received a message from the remote end for this Channel
2202         pub fn have_received_message(&self) -> bool {
2203                 self.channel_state > ChannelState::NegotiatingFunding(NegotiatingFundingFlags::OUR_INIT_SENT)
2204         }
2205
2206         /// Returns true if this channel is fully established and not known to be closing.
2207         /// Allowed in any state (including after shutdown)
2208         pub fn is_usable(&self) -> bool {
2209                 matches!(self.channel_state, ChannelState::ChannelReady(_)) &&
2210                         !self.channel_state.is_local_shutdown_sent() &&
2211                         !self.channel_state.is_remote_shutdown_sent() &&
2212                         !self.monitor_pending_channel_ready
2213         }
2214
2215         /// shutdown state returns the state of the channel in its various stages of shutdown
2216         pub fn shutdown_state(&self) -> ChannelShutdownState {
2217                 match self.channel_state {
2218                         ChannelState::AwaitingChannelReady(_)|ChannelState::ChannelReady(_) =>
2219                                 if self.channel_state.is_local_shutdown_sent() && !self.channel_state.is_remote_shutdown_sent() {
2220                                         ChannelShutdownState::ShutdownInitiated
2221                                 } else if (self.channel_state.is_local_shutdown_sent() || self.channel_state.is_remote_shutdown_sent()) && !self.closing_negotiation_ready() {
2222                                         ChannelShutdownState::ResolvingHTLCs
2223                                 } else if (self.channel_state.is_local_shutdown_sent() || self.channel_state.is_remote_shutdown_sent()) && self.closing_negotiation_ready() {
2224                                         ChannelShutdownState::NegotiatingClosingFee
2225                                 } else {
2226                                         ChannelShutdownState::NotShuttingDown
2227                                 },
2228                         ChannelState::ShutdownComplete => ChannelShutdownState::ShutdownComplete,
2229                         _ => ChannelShutdownState::NotShuttingDown,
2230                 }
2231         }
2232
2233         fn closing_negotiation_ready(&self) -> bool {
2234                 let is_ready_to_close = match self.channel_state {
2235                         ChannelState::AwaitingChannelReady(flags) =>
2236                                 flags & FundedStateFlags::ALL == FundedStateFlags::LOCAL_SHUTDOWN_SENT | FundedStateFlags::REMOTE_SHUTDOWN_SENT,
2237                         ChannelState::ChannelReady(flags) =>
2238                                 flags == FundedStateFlags::LOCAL_SHUTDOWN_SENT | FundedStateFlags::REMOTE_SHUTDOWN_SENT,
2239                         _ => false,
2240                 };
2241                 self.pending_inbound_htlcs.is_empty() &&
2242                         self.pending_outbound_htlcs.is_empty() &&
2243                         self.pending_update_fee.is_none() &&
2244                         is_ready_to_close
2245         }
2246
2247         /// Returns true if this channel is currently available for use. This is a superset of
2248         /// is_usable() and considers things like the channel being temporarily disabled.
2249         /// Allowed in any state (including after shutdown)
2250         pub fn is_live(&self) -> bool {
2251                 self.is_usable() && !self.channel_state.is_peer_disconnected()
2252         }
2253
2254         // Public utilities:
2255
2256         pub fn channel_id(&self) -> ChannelId {
2257                 self.channel_id
2258         }
2259
2260         // Return the `temporary_channel_id` used during channel establishment.
2261         //
2262         // Will return `None` for channels created prior to LDK version 0.0.115.
2263         pub fn temporary_channel_id(&self) -> Option<ChannelId> {
2264                 self.temporary_channel_id
2265         }
2266
2267         pub fn minimum_depth(&self) -> Option<u32> {
2268                 self.minimum_depth
2269         }
2270
2271         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2272         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2273         pub fn get_user_id(&self) -> u128 {
2274                 self.user_id
2275         }
2276
2277         /// Gets the channel's type
2278         pub fn get_channel_type(&self) -> &ChannelTypeFeatures {
2279                 &self.channel_type
2280         }
2281
2282         /// Gets the channel's `short_channel_id`.
2283         ///
2284         /// Will return `None` if the channel hasn't been confirmed yet.
2285         pub fn get_short_channel_id(&self) -> Option<u64> {
2286                 self.short_channel_id
2287         }
2288
2289         /// Allowed in any state (including after shutdown)
2290         pub fn latest_inbound_scid_alias(&self) -> Option<u64> {
2291                 self.latest_inbound_scid_alias
2292         }
2293
2294         /// Allowed in any state (including after shutdown)
2295         pub fn outbound_scid_alias(&self) -> u64 {
2296                 self.outbound_scid_alias
2297         }
2298
2299         /// Returns the holder signer for this channel.
2300         #[cfg(test)]
2301         pub fn get_signer(&self) -> &ChannelSignerType<SP> {
2302                 return &self.holder_signer
2303         }
2304
2305         /// Only allowed immediately after deserialization if get_outbound_scid_alias returns 0,
2306         /// indicating we were written by LDK prior to 0.0.106 which did not set outbound SCID aliases
2307         /// or prior to any channel actions during `Channel` initialization.
2308         pub fn set_outbound_scid_alias(&mut self, outbound_scid_alias: u64) {
2309                 debug_assert_eq!(self.outbound_scid_alias, 0);
2310                 self.outbound_scid_alias = outbound_scid_alias;
2311         }
2312
2313         /// Returns the funding_txo we either got from our peer, or were given by
2314         /// get_funding_created.
2315         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2316                 self.channel_transaction_parameters.funding_outpoint
2317         }
2318
2319         /// Returns the height in which our funding transaction was confirmed.
2320         pub fn get_funding_tx_confirmation_height(&self) -> Option<u32> {
2321                 let conf_height = self.funding_tx_confirmation_height;
2322                 if conf_height > 0 {
2323                         Some(conf_height)
2324                 } else {
2325                         None
2326                 }
2327         }
2328
2329         /// Returns the block hash in which our funding transaction was confirmed.
2330         pub fn get_funding_tx_confirmed_in(&self) -> Option<BlockHash> {
2331                 self.funding_tx_confirmed_in
2332         }
2333
2334         /// Returns the current number of confirmations on the funding transaction.
2335         pub fn get_funding_tx_confirmations(&self, height: u32) -> u32 {
2336                 if self.funding_tx_confirmation_height == 0 {
2337                         // We either haven't seen any confirmation yet, or observed a reorg.
2338                         return 0;
2339                 }
2340
2341                 height.checked_sub(self.funding_tx_confirmation_height).map_or(0, |c| c + 1)
2342         }
2343
2344         fn get_holder_selected_contest_delay(&self) -> u16 {
2345                 self.channel_transaction_parameters.holder_selected_contest_delay
2346         }
2347
2348         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
2349                 &self.channel_transaction_parameters.holder_pubkeys
2350         }
2351
2352         pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
2353                 self.channel_transaction_parameters.counterparty_parameters
2354                         .as_ref().map(|params| params.selected_contest_delay)
2355         }
2356
2357         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
2358                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
2359         }
2360
2361         /// Allowed in any state (including after shutdown)
2362         pub fn get_counterparty_node_id(&self) -> PublicKey {
2363                 self.counterparty_node_id
2364         }
2365
2366         /// Allowed in any state (including after shutdown)
2367         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
2368                 self.holder_htlc_minimum_msat
2369         }
2370
2371         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
2372         pub fn get_holder_htlc_maximum_msat(&self) -> Option<u64> {
2373                 self.get_htlc_maximum_msat(self.holder_max_htlc_value_in_flight_msat)
2374         }
2375
2376         /// Allowed in any state (including after shutdown)
2377         pub fn get_announced_htlc_max_msat(&self) -> u64 {
2378                 return cmp::min(
2379                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
2380                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
2381                         // channel might have been used to route very small values (either by honest users or as DoS).
2382                         self.channel_value_satoshis * 1000 * 9 / 10,
2383
2384                         self.counterparty_max_htlc_value_in_flight_msat
2385                 );
2386         }
2387
2388         /// Allowed in any state (including after shutdown)
2389         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
2390                 self.counterparty_htlc_minimum_msat
2391         }
2392
2393         /// Allowed in any state (including after shutdown), but will return none before TheirInitSent
2394         pub fn get_counterparty_htlc_maximum_msat(&self) -> Option<u64> {
2395                 self.get_htlc_maximum_msat(self.counterparty_max_htlc_value_in_flight_msat)
2396         }
2397
2398         fn get_htlc_maximum_msat(&self, party_max_htlc_value_in_flight_msat: u64) -> Option<u64> {
2399                 self.counterparty_selected_channel_reserve_satoshis.map(|counterparty_reserve| {
2400                         let holder_reserve = self.holder_selected_channel_reserve_satoshis;
2401                         cmp::min(
2402                                 (self.channel_value_satoshis - counterparty_reserve - holder_reserve) * 1000,
2403                                 party_max_htlc_value_in_flight_msat
2404                         )
2405                 })
2406         }
2407
2408         pub fn get_value_satoshis(&self) -> u64 {
2409                 self.channel_value_satoshis
2410         }
2411
2412         pub fn get_fee_proportional_millionths(&self) -> u32 {
2413                 self.config.options.forwarding_fee_proportional_millionths
2414         }
2415
2416         pub fn get_cltv_expiry_delta(&self) -> u16 {
2417                 cmp::max(self.config.options.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
2418         }
2419
2420         fn get_dust_exposure_limiting_feerate<F: Deref>(&self,
2421                 fee_estimator: &LowerBoundedFeeEstimator<F>,
2422         ) -> u32 where F::Target: FeeEstimator {
2423                 fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::OnChainSweep)
2424         }
2425
2426         pub fn get_max_dust_htlc_exposure_msat(&self, limiting_feerate_sat_per_kw: u32) -> u64 {
2427                 match self.config.options.max_dust_htlc_exposure {
2428                         MaxDustHTLCExposure::FeeRateMultiplier(multiplier) => {
2429                                 (limiting_feerate_sat_per_kw as u64).saturating_mul(multiplier)
2430                         },
2431                         MaxDustHTLCExposure::FixedLimitMsat(limit) => limit,
2432                 }
2433         }
2434
2435         /// Returns the previous [`ChannelConfig`] applied to this channel, if any.
2436         pub fn prev_config(&self) -> Option<ChannelConfig> {
2437                 self.prev_config.map(|prev_config| prev_config.0)
2438         }
2439
2440         // Checks whether we should emit a `ChannelPending` event.
2441         pub(crate) fn should_emit_channel_pending_event(&mut self) -> bool {
2442                 self.is_funding_broadcast() && !self.channel_pending_event_emitted
2443         }
2444
2445         // Returns whether we already emitted a `ChannelPending` event.
2446         pub(crate) fn channel_pending_event_emitted(&self) -> bool {
2447                 self.channel_pending_event_emitted
2448         }
2449
2450         // Remembers that we already emitted a `ChannelPending` event.
2451         pub(crate) fn set_channel_pending_event_emitted(&mut self) {
2452                 self.channel_pending_event_emitted = true;
2453         }
2454
2455         // Checks whether we should emit a `ChannelReady` event.
2456         pub(crate) fn should_emit_channel_ready_event(&mut self) -> bool {
2457                 self.is_usable() && !self.channel_ready_event_emitted
2458         }
2459
2460         // Remembers that we already emitted a `ChannelReady` event.
2461         pub(crate) fn set_channel_ready_event_emitted(&mut self) {
2462                 self.channel_ready_event_emitted = true;
2463         }
2464
2465         /// Tracks the number of ticks elapsed since the previous [`ChannelConfig`] was updated. Once
2466         /// [`EXPIRE_PREV_CONFIG_TICKS`] is reached, the previous config is considered expired and will
2467         /// no longer be considered when forwarding HTLCs.
2468         pub fn maybe_expire_prev_config(&mut self) {
2469                 if self.prev_config.is_none() {
2470                         return;
2471                 }
2472                 let prev_config = self.prev_config.as_mut().unwrap();
2473                 prev_config.1 += 1;
2474                 if prev_config.1 == EXPIRE_PREV_CONFIG_TICKS {
2475                         self.prev_config = None;
2476                 }
2477         }
2478
2479         /// Returns the current [`ChannelConfig`] applied to the channel.
2480         pub fn config(&self) -> ChannelConfig {
2481                 self.config.options
2482         }
2483
2484         /// Updates the channel's config. A bool is returned indicating whether the config update
2485         /// applied resulted in a new ChannelUpdate message.
2486         pub fn update_config(&mut self, config: &ChannelConfig) -> bool {
2487                 let did_channel_update =
2488                         self.config.options.forwarding_fee_proportional_millionths != config.forwarding_fee_proportional_millionths ||
2489                         self.config.options.forwarding_fee_base_msat != config.forwarding_fee_base_msat ||
2490                         self.config.options.cltv_expiry_delta != config.cltv_expiry_delta;
2491                 if did_channel_update {
2492                         self.prev_config = Some((self.config.options, 0));
2493                         // Update the counter, which backs the ChannelUpdate timestamp, to allow the relay
2494                         // policy change to propagate throughout the network.
2495                         self.update_time_counter += 1;
2496                 }
2497                 self.config.options = *config;
2498                 did_channel_update
2499         }
2500
2501         /// Returns true if funding_signed was sent/received and the
2502         /// funding transaction has been broadcast if necessary.
2503         pub fn is_funding_broadcast(&self) -> bool {
2504                 !self.channel_state.is_pre_funded_state() &&
2505                         !matches!(self.channel_state, ChannelState::AwaitingChannelReady(flags) if flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH))
2506         }
2507
2508         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
2509         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
2510         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
2511         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
2512         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
2513         /// an HTLC to a).
2514         /// @local is used only to convert relevant internal structures which refer to remote vs local
2515         /// to decide value of outputs and direction of HTLCs.
2516         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
2517         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
2518         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
2519         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
2520         /// which peer generated this transaction and "to whom" this transaction flows.
2521         #[inline]
2522         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
2523                 where L::Target: Logger
2524         {
2525                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
2526                 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2527                 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
2528
2529                 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
2530                 let mut remote_htlc_total_msat = 0;
2531                 let mut local_htlc_total_msat = 0;
2532                 let mut value_to_self_msat_offset = 0;
2533
2534                 let mut feerate_per_kw = self.feerate_per_kw;
2535                 if let Some((feerate, update_state)) = self.pending_update_fee {
2536                         if match update_state {
2537                                 // Note that these match the inclusion criteria when scanning
2538                                 // pending_inbound_htlcs below.
2539                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
2540                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
2541                                 FeeUpdateState::Outbound => { assert!(self.is_outbound());  generated_by_local },
2542                         } {
2543                                 feerate_per_kw = feerate;
2544                         }
2545                 }
2546
2547                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
2548                         commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
2549                         get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
2550                         &self.channel_id,
2551                         if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
2552
2553                 macro_rules! get_htlc_in_commitment {
2554                         ($htlc: expr, $offered: expr) => {
2555                                 HTLCOutputInCommitment {
2556                                         offered: $offered,
2557                                         amount_msat: $htlc.amount_msat,
2558                                         cltv_expiry: $htlc.cltv_expiry,
2559                                         payment_hash: $htlc.payment_hash,
2560                                         transaction_output_index: None
2561                                 }
2562                         }
2563                 }
2564
2565                 macro_rules! add_htlc_output {
2566                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
2567                                 if $outbound == local { // "offered HTLC output"
2568                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
2569                                         let htlc_tx_fee = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2570                                                 0
2571                                         } else {
2572                                                 feerate_per_kw as u64 * htlc_timeout_tx_weight(self.get_channel_type()) / 1000
2573                                         };
2574                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
2575                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2576                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
2577                                         } else {
2578                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2579                                                 included_dust_htlcs.push((htlc_in_tx, $source));
2580                                         }
2581                                 } else {
2582                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
2583                                         let htlc_tx_fee = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2584                                                 0
2585                                         } else {
2586                                                 feerate_per_kw as u64 * htlc_success_tx_weight(self.get_channel_type()) / 1000
2587                                         };
2588                                         if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + htlc_tx_fee {
2589                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2590                                                 included_non_dust_htlcs.push((htlc_in_tx, $source));
2591                                         } else {
2592                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, &$htlc.payment_hash, $htlc.amount_msat);
2593                                                 included_dust_htlcs.push((htlc_in_tx, $source));
2594                                         }
2595                                 }
2596                         }
2597                 }
2598
2599                 let mut inbound_htlc_preimages: Vec<PaymentPreimage> = Vec::new();
2600
2601                 for ref htlc in self.pending_inbound_htlcs.iter() {
2602                         let (include, state_name) = match htlc.state {
2603                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
2604                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
2605                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
2606                                 InboundHTLCState::Committed => (true, "Committed"),
2607                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
2608                         };
2609
2610                         if include {
2611                                 add_htlc_output!(htlc, false, None, state_name);
2612                                 remote_htlc_total_msat += htlc.amount_msat;
2613                         } else {
2614                                 log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, &htlc.payment_hash, htlc.amount_msat, state_name);
2615                                 match &htlc.state {
2616                                         &InboundHTLCState::LocalRemoved(ref reason) => {
2617                                                 if generated_by_local {
2618                                                         if let &InboundHTLCRemovalReason::Fulfill(preimage) = reason {
2619                                                                 inbound_htlc_preimages.push(preimage);
2620                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
2621                                                         }
2622                                                 }
2623                                         },
2624                                         _ => {},
2625                                 }
2626                         }
2627                 }
2628
2629
2630                 let mut outbound_htlc_preimages: Vec<PaymentPreimage> = Vec::new();
2631
2632                 for ref htlc in self.pending_outbound_htlcs.iter() {
2633                         let (include, state_name) = match htlc.state {
2634                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
2635                                 OutboundHTLCState::Committed => (true, "Committed"),
2636                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
2637                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
2638                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
2639                         };
2640
2641                         let preimage_opt = match htlc.state {
2642                                 OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(p)) => p,
2643                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(p)) => p,
2644                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(p)) => p,
2645                                 _ => None,
2646                         };
2647
2648                         if let Some(preimage) = preimage_opt {
2649                                 outbound_htlc_preimages.push(preimage);
2650                         }
2651
2652                         if include {
2653                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
2654                                 local_htlc_total_msat += htlc.amount_msat;
2655                         } else {
2656                                 log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, &htlc.payment_hash, htlc.amount_msat, state_name);
2657                                 match htlc.state {
2658                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_))|OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) => {
2659                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
2660                                         },
2661                                         OutboundHTLCState::RemoteRemoved(OutboundHTLCOutcome::Success(_)) => {
2662                                                 if !generated_by_local {
2663                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
2664                                                 }
2665                                         },
2666                                         _ => {},
2667                                 }
2668                         }
2669                 }
2670
2671                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
2672                 assert!(value_to_self_msat >= 0);
2673                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
2674                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
2675                 // "violate" their reserve value by couting those against it. Thus, we have to convert
2676                 // everything to i64 before subtracting as otherwise we can overflow.
2677                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
2678                 assert!(value_to_remote_msat >= 0);
2679
2680                 #[cfg(debug_assertions)]
2681                 {
2682                         // Make sure that the to_self/to_remote is always either past the appropriate
2683                         // channel_reserve *or* it is making progress towards it.
2684                         let mut broadcaster_max_commitment_tx_output = if generated_by_local {
2685                                 self.holder_max_commitment_tx_output.lock().unwrap()
2686                         } else {
2687                                 self.counterparty_max_commitment_tx_output.lock().unwrap()
2688                         };
2689                         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);
2690                         broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
2691                         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);
2692                         broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
2693                 }
2694
2695                 let total_fee_sat = commit_tx_fee_sat(feerate_per_kw, included_non_dust_htlcs.len(), &self.channel_transaction_parameters.channel_type_features);
2696                 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;
2697                 let (value_to_self, value_to_remote) = if self.is_outbound() {
2698                         (value_to_self_msat / 1000 - anchors_val - total_fee_sat as i64, value_to_remote_msat / 1000)
2699                 } else {
2700                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - anchors_val - total_fee_sat as i64)
2701                 };
2702
2703                 let mut value_to_a = if local { value_to_self } else { value_to_remote };
2704                 let mut value_to_b = if local { value_to_remote } else { value_to_self };
2705                 let (funding_pubkey_a, funding_pubkey_b) = if local {
2706                         (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
2707                 } else {
2708                         (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
2709                 };
2710
2711                 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
2712                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
2713                 } else {
2714                         value_to_a = 0;
2715                 }
2716
2717                 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
2718                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
2719                 } else {
2720                         value_to_b = 0;
2721                 }
2722
2723                 let num_nondust_htlcs = included_non_dust_htlcs.len();
2724
2725                 let channel_parameters =
2726                         if local { self.channel_transaction_parameters.as_holder_broadcastable() }
2727                         else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
2728                 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
2729                                                                              value_to_a as u64,
2730                                                                              value_to_b as u64,
2731                                                                              funding_pubkey_a,
2732                                                                              funding_pubkey_b,
2733                                                                              keys.clone(),
2734                                                                              feerate_per_kw,
2735                                                                              &mut included_non_dust_htlcs,
2736                                                                              &channel_parameters
2737                 );
2738                 let mut htlcs_included = included_non_dust_htlcs;
2739                 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
2740                 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
2741                 htlcs_included.append(&mut included_dust_htlcs);
2742
2743                 CommitmentStats {
2744                         tx,
2745                         feerate_per_kw,
2746                         total_fee_sat,
2747                         num_nondust_htlcs,
2748                         htlcs_included,
2749                         local_balance_msat: value_to_self_msat as u64,
2750                         remote_balance_msat: value_to_remote_msat as u64,
2751                         inbound_htlc_preimages,
2752                         outbound_htlc_preimages,
2753                 }
2754         }
2755
2756         #[inline]
2757         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
2758         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
2759         /// our counterparty!)
2760         /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
2761         /// TODO Some magic rust shit to compile-time check this?
2762         fn build_holder_transaction_keys(&self, commitment_number: u64) -> TxCreationKeys {
2763                 let per_commitment_point = self.holder_signer.as_ref().get_per_commitment_point(commitment_number, &self.secp_ctx);
2764                 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
2765                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
2766                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
2767
2768                 TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint)
2769         }
2770
2771         #[inline]
2772         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
2773         /// will sign and send to our counterparty.
2774         /// If an Err is returned, it is a ChannelError::Close (for get_funding_created)
2775         fn build_remote_transaction_keys(&self) -> TxCreationKeys {
2776                 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
2777                 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
2778                 let counterparty_pubkeys = self.get_counterparty_pubkeys();
2779
2780                 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)
2781         }
2782
2783         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
2784         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
2785         /// Panics if called before accept_channel/InboundV1Channel::new
2786         pub fn get_funding_redeemscript(&self) -> ScriptBuf {
2787                 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
2788         }
2789
2790         fn counterparty_funding_pubkey(&self) -> &PublicKey {
2791                 &self.get_counterparty_pubkeys().funding_pubkey
2792         }
2793
2794         pub fn get_feerate_sat_per_1000_weight(&self) -> u32 {
2795                 self.feerate_per_kw
2796         }
2797
2798         pub fn get_dust_buffer_feerate(&self, outbound_feerate_update: Option<u32>) -> u32 {
2799                 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
2800                 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
2801                 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
2802                 // more dust balance if the feerate increases when we have several HTLCs pending
2803                 // which are near the dust limit.
2804                 let mut feerate_per_kw = self.feerate_per_kw;
2805                 // If there's a pending update fee, use it to ensure we aren't under-estimating
2806                 // potential feerate updates coming soon.
2807                 if let Some((feerate, _)) = self.pending_update_fee {
2808                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
2809                 }
2810                 if let Some(feerate) = outbound_feerate_update {
2811                         feerate_per_kw = cmp::max(feerate_per_kw, feerate);
2812                 }
2813                 let feerate_plus_quarter = feerate_per_kw.checked_mul(1250).map(|v| v / 1000);
2814                 cmp::max(feerate_per_kw + 2530, feerate_plus_quarter.unwrap_or(u32::max_value()))
2815         }
2816
2817         /// Get forwarding information for the counterparty.
2818         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
2819                 self.counterparty_forwarding_info.clone()
2820         }
2821
2822         /// Returns a HTLCStats about pending htlcs
2823         fn get_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>, dust_exposure_limiting_feerate: u32) -> HTLCStats {
2824                 let context = self;
2825                 let uses_0_htlc_fee_anchors = self.get_channel_type().supports_anchors_zero_fee_htlc_tx();
2826
2827                 let dust_buffer_feerate = context.get_dust_buffer_feerate(outbound_feerate_update);
2828                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if uses_0_htlc_fee_anchors {
2829                         (0, 0)
2830                 } else {
2831                         (dust_buffer_feerate as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000,
2832                                 dust_buffer_feerate as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000)
2833                 };
2834
2835                 let mut on_holder_tx_dust_exposure_msat = 0;
2836                 let mut on_counterparty_tx_dust_exposure_msat = 0;
2837
2838                 let mut on_counterparty_tx_offered_nondust_htlcs = 0;
2839                 let mut on_counterparty_tx_accepted_nondust_htlcs = 0;
2840
2841                 let mut pending_inbound_htlcs_value_msat = 0;
2842
2843                 {
2844                         let counterparty_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.counterparty_dust_limit_satoshis;
2845                         let holder_dust_limit_success_sat = htlc_success_dust_limit + context.holder_dust_limit_satoshis;
2846                         for ref htlc in context.pending_inbound_htlcs.iter() {
2847                                 pending_inbound_htlcs_value_msat += htlc.amount_msat;
2848                                 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
2849                                         on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2850                                 } else {
2851                                         on_counterparty_tx_offered_nondust_htlcs += 1;
2852                                 }
2853                                 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
2854                                         on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2855                                 }
2856                         }
2857                 }
2858
2859                 let mut pending_outbound_htlcs_value_msat = 0;
2860                 let mut outbound_holding_cell_msat = 0;
2861                 let mut on_holder_tx_outbound_holding_cell_htlcs_count = 0;
2862                 let mut pending_outbound_htlcs = self.pending_outbound_htlcs.len();
2863                 {
2864                         let counterparty_dust_limit_success_sat = htlc_success_dust_limit + context.counterparty_dust_limit_satoshis;
2865                         let holder_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.holder_dust_limit_satoshis;
2866                         for ref htlc in context.pending_outbound_htlcs.iter() {
2867                                 pending_outbound_htlcs_value_msat += htlc.amount_msat;
2868                                 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
2869                                         on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2870                                 } else {
2871                                         on_counterparty_tx_accepted_nondust_htlcs += 1;
2872                                 }
2873                                 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
2874                                         on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2875                                 }
2876                         }
2877
2878                         for update in context.holding_cell_htlc_updates.iter() {
2879                                 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
2880                                         pending_outbound_htlcs += 1;
2881                                         pending_outbound_htlcs_value_msat += amount_msat;
2882                                         outbound_holding_cell_msat += amount_msat;
2883                                         if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
2884                                                 on_counterparty_tx_dust_exposure_msat += amount_msat;
2885                                         } else {
2886                                                 on_counterparty_tx_accepted_nondust_htlcs += 1;
2887                                         }
2888                                         if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
2889                                                 on_holder_tx_dust_exposure_msat += amount_msat;
2890                                         } else {
2891                                                 on_holder_tx_outbound_holding_cell_htlcs_count += 1;
2892                                         }
2893                                 }
2894                         }
2895                 }
2896
2897                 // Include any mining "excess" fees in the dust calculation
2898                 let excess_feerate_opt = outbound_feerate_update
2899                         .or(self.pending_update_fee.map(|(fee, _)| fee))
2900                         .unwrap_or(self.feerate_per_kw)
2901                         .checked_sub(dust_exposure_limiting_feerate);
2902                 if let Some(excess_feerate) = excess_feerate_opt {
2903                         let on_counterparty_tx_nondust_htlcs =
2904                                 on_counterparty_tx_accepted_nondust_htlcs + on_counterparty_tx_offered_nondust_htlcs;
2905                         on_counterparty_tx_dust_exposure_msat +=
2906                                 commit_tx_fee_msat(excess_feerate, on_counterparty_tx_nondust_htlcs, &self.channel_type);
2907                         if !self.channel_type.supports_anchors_zero_fee_htlc_tx() {
2908                                 on_counterparty_tx_dust_exposure_msat +=
2909                                         on_counterparty_tx_accepted_nondust_htlcs as u64 * htlc_success_tx_weight(&self.channel_type)
2910                                         * excess_feerate as u64 / 1000;
2911                                 on_counterparty_tx_dust_exposure_msat +=
2912                                         on_counterparty_tx_offered_nondust_htlcs as u64 * htlc_timeout_tx_weight(&self.channel_type)
2913                                         * excess_feerate as u64 / 1000;
2914                         }
2915                 }
2916
2917                 HTLCStats {
2918                         pending_inbound_htlcs: self.pending_inbound_htlcs.len(),
2919                         pending_outbound_htlcs,
2920                         pending_inbound_htlcs_value_msat,
2921                         pending_outbound_htlcs_value_msat,
2922                         on_counterparty_tx_dust_exposure_msat,
2923                         on_holder_tx_dust_exposure_msat,
2924                         outbound_holding_cell_msat,
2925                         on_holder_tx_outbound_holding_cell_htlcs_count,
2926                 }
2927         }
2928
2929         /// Returns information on all pending inbound HTLCs.
2930         pub fn get_pending_inbound_htlc_details(&self) -> Vec<InboundHTLCDetails> {
2931                 let mut holding_cell_states = new_hash_map();
2932                 for holding_cell_update in self.holding_cell_htlc_updates.iter() {
2933                         match holding_cell_update {
2934                                 HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
2935                                         holding_cell_states.insert(
2936                                                 htlc_id,
2937                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFulfill,
2938                                         );
2939                                 },
2940                                 HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
2941                                         holding_cell_states.insert(
2942                                                 htlc_id,
2943                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail,
2944                                         );
2945                                 },
2946                                 HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } => {
2947                                         holding_cell_states.insert(
2948                                                 htlc_id,
2949                                                 InboundHTLCStateDetails::AwaitingRemoteRevokeToRemoveFail,
2950                                         );
2951                                 },
2952                                 // Outbound HTLC.
2953                                 HTLCUpdateAwaitingACK::AddHTLC { .. } => {},
2954                         }
2955                 }
2956                 let mut inbound_details = Vec::new();
2957                 let htlc_success_dust_limit = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2958                         0
2959                 } else {
2960                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
2961                         dust_buffer_feerate * htlc_success_tx_weight(self.get_channel_type()) / 1000
2962                 };
2963                 let holder_dust_limit_success_sat = htlc_success_dust_limit + self.holder_dust_limit_satoshis;
2964                 for htlc in self.pending_inbound_htlcs.iter() {
2965                         if let Some(state_details) = (&htlc.state).into() {
2966                                 inbound_details.push(InboundHTLCDetails{
2967                                         htlc_id: htlc.htlc_id,
2968                                         amount_msat: htlc.amount_msat,
2969                                         cltv_expiry: htlc.cltv_expiry,
2970                                         payment_hash: htlc.payment_hash,
2971                                         state: Some(holding_cell_states.remove(&htlc.htlc_id).unwrap_or(state_details)),
2972                                         is_dust: htlc.amount_msat / 1000 < holder_dust_limit_success_sat,
2973                                 });
2974                         }
2975                 }
2976                 inbound_details
2977         }
2978
2979         /// Returns information on all pending outbound HTLCs.
2980         pub fn get_pending_outbound_htlc_details(&self) -> Vec<OutboundHTLCDetails> {
2981                 let mut outbound_details = Vec::new();
2982                 let htlc_timeout_dust_limit = if self.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
2983                         0
2984                 } else {
2985                         let dust_buffer_feerate = self.get_dust_buffer_feerate(None) as u64;
2986                         dust_buffer_feerate * htlc_success_tx_weight(self.get_channel_type()) / 1000
2987                 };
2988                 let holder_dust_limit_timeout_sat = htlc_timeout_dust_limit + self.holder_dust_limit_satoshis;
2989                 for htlc in self.pending_outbound_htlcs.iter() {
2990                         outbound_details.push(OutboundHTLCDetails{
2991                                 htlc_id: Some(htlc.htlc_id),
2992                                 amount_msat: htlc.amount_msat,
2993                                 cltv_expiry: htlc.cltv_expiry,
2994                                 payment_hash: htlc.payment_hash,
2995                                 skimmed_fee_msat: htlc.skimmed_fee_msat,
2996                                 state: Some((&htlc.state).into()),
2997                                 is_dust: htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat,
2998                         });
2999                 }
3000                 for holding_cell_update in self.holding_cell_htlc_updates.iter() {
3001                         if let HTLCUpdateAwaitingACK::AddHTLC {
3002                                 amount_msat,
3003                                 cltv_expiry,
3004                                 payment_hash,
3005                                 skimmed_fee_msat,
3006                                 ..
3007                         } = *holding_cell_update {
3008                                 outbound_details.push(OutboundHTLCDetails{
3009                                         htlc_id: None,
3010                                         amount_msat: amount_msat,
3011                                         cltv_expiry: cltv_expiry,
3012                                         payment_hash: payment_hash,
3013                                         skimmed_fee_msat: skimmed_fee_msat,
3014                                         state: Some(OutboundHTLCStateDetails::AwaitingRemoteRevokeToAdd),
3015                                         is_dust: amount_msat / 1000 < holder_dust_limit_timeout_sat,
3016                                 });
3017                         }
3018                 }
3019                 outbound_details
3020         }
3021
3022         /// Get the available balances, see [`AvailableBalances`]'s fields for more info.
3023         /// Doesn't bother handling the
3024         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
3025         /// corner case properly.
3026         pub fn get_available_balances<F: Deref>(&self, fee_estimator: &LowerBoundedFeeEstimator<F>)
3027         -> AvailableBalances
3028         where F::Target: FeeEstimator
3029         {
3030                 let context = &self;
3031                 // Note that we have to handle overflow due to the case mentioned in the docs in general
3032                 // here.
3033
3034                 let dust_exposure_limiting_feerate = self.get_dust_exposure_limiting_feerate(&fee_estimator);
3035                 let htlc_stats = context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
3036
3037                 let mut balance_msat = context.value_to_self_msat;
3038                 for ref htlc in context.pending_inbound_htlcs.iter() {
3039                         if let InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(_)) = htlc.state {
3040                                 balance_msat += htlc.amount_msat;
3041                         }
3042                 }
3043                 balance_msat -= htlc_stats.pending_outbound_htlcs_value_msat;
3044
3045                 let outbound_capacity_msat = context.value_to_self_msat
3046                                 .saturating_sub(htlc_stats.pending_outbound_htlcs_value_msat)
3047                                 .saturating_sub(
3048                                         context.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) * 1000);
3049
3050                 let mut available_capacity_msat = outbound_capacity_msat;
3051
3052                 let anchor_outputs_value_msat = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3053                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
3054                 } else {
3055                         0
3056                 };
3057                 if context.is_outbound() {
3058                         // We should mind channel commit tx fee when computing how much of the available capacity
3059                         // can be used in the next htlc. Mirrors the logic in send_htlc.
3060                         //
3061                         // The fee depends on whether the amount we will be sending is above dust or not,
3062                         // and the answer will in turn change the amount itself â€” making it a circular
3063                         // dependency.
3064                         // This complicates the computation around dust-values, up to the one-htlc-value.
3065                         let mut real_dust_limit_timeout_sat = context.holder_dust_limit_satoshis;
3066                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3067                                 real_dust_limit_timeout_sat += context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000;
3068                         }
3069
3070                         let htlc_above_dust = HTLCCandidate::new(real_dust_limit_timeout_sat * 1000, HTLCInitiator::LocalOffered);
3071                         let mut max_reserved_commit_tx_fee_msat = context.next_local_commit_tx_fee_msat(htlc_above_dust, Some(()));
3072                         let htlc_dust = HTLCCandidate::new(real_dust_limit_timeout_sat * 1000 - 1, HTLCInitiator::LocalOffered);
3073                         let mut min_reserved_commit_tx_fee_msat = context.next_local_commit_tx_fee_msat(htlc_dust, Some(()));
3074                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3075                                 max_reserved_commit_tx_fee_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
3076                                 min_reserved_commit_tx_fee_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
3077                         }
3078
3079                         // We will first subtract the fee as if we were above-dust. Then, if the resulting
3080                         // value ends up being below dust, we have this fee available again. In that case,
3081                         // match the value to right-below-dust.
3082                         let mut capacity_minus_commitment_fee_msat: i64 = available_capacity_msat as i64 -
3083                                 max_reserved_commit_tx_fee_msat as i64 - anchor_outputs_value_msat as i64;
3084                         if capacity_minus_commitment_fee_msat < (real_dust_limit_timeout_sat as i64) * 1000 {
3085                                 let one_htlc_difference_msat = max_reserved_commit_tx_fee_msat - min_reserved_commit_tx_fee_msat;
3086                                 debug_assert!(one_htlc_difference_msat != 0);
3087                                 capacity_minus_commitment_fee_msat += one_htlc_difference_msat as i64;
3088                                 capacity_minus_commitment_fee_msat = cmp::min(real_dust_limit_timeout_sat as i64 * 1000 - 1, capacity_minus_commitment_fee_msat);
3089                                 available_capacity_msat = cmp::max(0, cmp::min(capacity_minus_commitment_fee_msat, available_capacity_msat as i64)) as u64;
3090                         } else {
3091                                 available_capacity_msat = capacity_minus_commitment_fee_msat as u64;
3092                         }
3093                 } else {
3094                         // If the channel is inbound (i.e. counterparty pays the fee), we need to make sure
3095                         // sending a new HTLC won't reduce their balance below our reserve threshold.
3096                         let mut real_dust_limit_success_sat = context.counterparty_dust_limit_satoshis;
3097                         if !context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3098                                 real_dust_limit_success_sat += context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000;
3099                         }
3100
3101                         let htlc_above_dust = HTLCCandidate::new(real_dust_limit_success_sat * 1000, HTLCInitiator::LocalOffered);
3102                         let max_reserved_commit_tx_fee_msat = context.next_remote_commit_tx_fee_msat(htlc_above_dust, None);
3103
3104                         let holder_selected_chan_reserve_msat = context.holder_selected_channel_reserve_satoshis * 1000;
3105                         let remote_balance_msat = (context.channel_value_satoshis * 1000 - context.value_to_self_msat)
3106                                 .saturating_sub(htlc_stats.pending_inbound_htlcs_value_msat);
3107
3108                         if remote_balance_msat < max_reserved_commit_tx_fee_msat + holder_selected_chan_reserve_msat + anchor_outputs_value_msat {
3109                                 // If another HTLC's fee would reduce the remote's balance below the reserve limit
3110                                 // we've selected for them, we can only send dust HTLCs.
3111                                 available_capacity_msat = cmp::min(available_capacity_msat, real_dust_limit_success_sat * 1000 - 1);
3112                         }
3113                 }
3114
3115                 let mut next_outbound_htlc_minimum_msat = context.counterparty_htlc_minimum_msat;
3116
3117                 // If we get close to our maximum dust exposure, we end up in a situation where we can send
3118                 // between zero and the remaining dust exposure limit remaining OR above the dust limit.
3119                 // Because we cannot express this as a simple min/max, we prefer to tell the user they can
3120                 // send above the dust limit (as the router can always overpay to meet the dust limit).
3121                 let mut remaining_msat_below_dust_exposure_limit = None;
3122                 let mut dust_exposure_dust_limit_msat = 0;
3123                 let max_dust_htlc_exposure_msat = context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
3124
3125                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3126                         (context.counterparty_dust_limit_satoshis, context.holder_dust_limit_satoshis)
3127                 } else {
3128                         let dust_buffer_feerate = context.get_dust_buffer_feerate(None) as u64;
3129                         (context.counterparty_dust_limit_satoshis + dust_buffer_feerate * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3130                          context.holder_dust_limit_satoshis       + dust_buffer_feerate * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3131                 };
3132
3133                 let excess_feerate_opt = self.feerate_per_kw.checked_sub(dust_exposure_limiting_feerate);
3134                 if let Some(excess_feerate) = excess_feerate_opt {
3135                         let htlc_dust_exposure_msat =
3136                                 per_outbound_htlc_counterparty_commit_tx_fee_msat(excess_feerate, &context.channel_type);
3137                         let nondust_htlc_counterparty_tx_dust_exposure =
3138                                 htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_dust_exposure_msat);
3139                         if nondust_htlc_counterparty_tx_dust_exposure > max_dust_htlc_exposure_msat {
3140                                 // If adding an extra HTLC would put us over the dust limit in total fees, we cannot
3141                                 // send any non-dust HTLCs.
3142                                 available_capacity_msat = cmp::min(available_capacity_msat, htlc_success_dust_limit * 1000);
3143                         }
3144                 }
3145
3146                 if htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_success_dust_limit * 1000) > max_dust_htlc_exposure_msat.saturating_add(1) {
3147                         // Note that we don't use the `counterparty_tx_dust_exposure` (with
3148                         // `htlc_dust_exposure_msat`) here as it only applies to non-dust HTLCs.
3149                         remaining_msat_below_dust_exposure_limit =
3150                                 Some(max_dust_htlc_exposure_msat.saturating_sub(htlc_stats.on_counterparty_tx_dust_exposure_msat));
3151                         dust_exposure_dust_limit_msat = cmp::max(dust_exposure_dust_limit_msat, htlc_success_dust_limit * 1000);
3152                 }
3153
3154                 if htlc_stats.on_holder_tx_dust_exposure_msat as i64 + htlc_timeout_dust_limit as i64 * 1000 - 1 > max_dust_htlc_exposure_msat.try_into().unwrap_or(i64::max_value()) {
3155                         remaining_msat_below_dust_exposure_limit = Some(cmp::min(
3156                                 remaining_msat_below_dust_exposure_limit.unwrap_or(u64::max_value()),
3157                                 max_dust_htlc_exposure_msat.saturating_sub(htlc_stats.on_holder_tx_dust_exposure_msat)));
3158                         dust_exposure_dust_limit_msat = cmp::max(dust_exposure_dust_limit_msat, htlc_timeout_dust_limit * 1000);
3159                 }
3160
3161                 if let Some(remaining_limit_msat) = remaining_msat_below_dust_exposure_limit {
3162                         if available_capacity_msat < dust_exposure_dust_limit_msat {
3163                                 available_capacity_msat = cmp::min(available_capacity_msat, remaining_limit_msat);
3164                         } else {
3165                                 next_outbound_htlc_minimum_msat = cmp::max(next_outbound_htlc_minimum_msat, dust_exposure_dust_limit_msat);
3166                         }
3167                 }
3168
3169                 available_capacity_msat = cmp::min(available_capacity_msat,
3170                         context.counterparty_max_htlc_value_in_flight_msat - htlc_stats.pending_outbound_htlcs_value_msat);
3171
3172                 if htlc_stats.pending_outbound_htlcs + 1 > context.counterparty_max_accepted_htlcs as usize {
3173                         available_capacity_msat = 0;
3174                 }
3175
3176                 AvailableBalances {
3177                         inbound_capacity_msat: cmp::max(context.channel_value_satoshis as i64 * 1000
3178                                         - context.value_to_self_msat as i64
3179                                         - htlc_stats.pending_inbound_htlcs_value_msat as i64
3180                                         - context.holder_selected_channel_reserve_satoshis as i64 * 1000,
3181                                 0) as u64,
3182                         outbound_capacity_msat,
3183                         next_outbound_htlc_limit_msat: available_capacity_msat,
3184                         next_outbound_htlc_minimum_msat,
3185                         balance_msat,
3186                 }
3187         }
3188
3189         pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
3190                 let context = &self;
3191                 (context.holder_selected_channel_reserve_satoshis, context.counterparty_selected_channel_reserve_satoshis)
3192         }
3193
3194         /// Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
3195         /// number of pending HTLCs that are on track to be in our next commitment tx.
3196         ///
3197         /// Optionally includes the `HTLCCandidate` given by `htlc` and an additional non-dust HTLC if
3198         /// `fee_spike_buffer_htlc` is `Some`.
3199         ///
3200         /// The first extra HTLC is useful for determining whether we can accept a further HTLC, the
3201         /// second allows for creating a buffer to ensure a further HTLC can always be accepted/added.
3202         ///
3203         /// Dust HTLCs are excluded.
3204         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
3205                 let context = &self;
3206                 assert!(context.is_outbound());
3207
3208                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3209                         (0, 0)
3210                 } else {
3211                         (context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3212                                 context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3213                 };
3214                 let real_dust_limit_success_sat = htlc_success_dust_limit + context.holder_dust_limit_satoshis;
3215                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.holder_dust_limit_satoshis;
3216
3217                 let mut addl_htlcs = 0;
3218                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
3219                 match htlc.origin {
3220                         HTLCInitiator::LocalOffered => {
3221                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
3222                                         addl_htlcs += 1;
3223                                 }
3224                         },
3225                         HTLCInitiator::RemoteOffered => {
3226                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
3227                                         addl_htlcs += 1;
3228                                 }
3229                         }
3230                 }
3231
3232                 let mut included_htlcs = 0;
3233                 for ref htlc in context.pending_inbound_htlcs.iter() {
3234                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
3235                                 continue
3236                         }
3237                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
3238                         // transaction including this HTLC if it times out before they RAA.
3239                         included_htlcs += 1;
3240                 }
3241
3242                 for ref htlc in context.pending_outbound_htlcs.iter() {
3243                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
3244                                 continue
3245                         }
3246                         match htlc.state {
3247                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
3248                                 OutboundHTLCState::Committed => included_htlcs += 1,
3249                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
3250                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
3251                                 // transaction won't be generated until they send us their next RAA, which will mean
3252                                 // dropping any HTLCs in this state.
3253                                 _ => {},
3254                         }
3255                 }
3256
3257                 for htlc in context.holding_cell_htlc_updates.iter() {
3258                         match htlc {
3259                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
3260                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
3261                                                 continue
3262                                         }
3263                                         included_htlcs += 1
3264                                 },
3265                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
3266                                          // ack we're guaranteed to never include them in commitment txs anymore.
3267                         }
3268                 }
3269
3270                 let num_htlcs = included_htlcs + addl_htlcs;
3271                 let res = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs, &context.channel_type);
3272                 #[cfg(any(test, fuzzing))]
3273                 {
3274                         let mut fee = res;
3275                         if fee_spike_buffer_htlc.is_some() {
3276                                 fee = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs - 1, &context.channel_type);
3277                         }
3278                         let total_pending_htlcs = context.pending_inbound_htlcs.len() + context.pending_outbound_htlcs.len()
3279                                 + context.holding_cell_htlc_updates.len();
3280                         let commitment_tx_info = CommitmentTxInfoCached {
3281                                 fee,
3282                                 total_pending_htlcs,
3283                                 next_holder_htlc_id: match htlc.origin {
3284                                         HTLCInitiator::LocalOffered => context.next_holder_htlc_id + 1,
3285                                         HTLCInitiator::RemoteOffered => context.next_holder_htlc_id,
3286                                 },
3287                                 next_counterparty_htlc_id: match htlc.origin {
3288                                         HTLCInitiator::LocalOffered => context.next_counterparty_htlc_id,
3289                                         HTLCInitiator::RemoteOffered => context.next_counterparty_htlc_id + 1,
3290                                 },
3291                                 feerate: context.feerate_per_kw,
3292                         };
3293                         *context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
3294                 }
3295                 res
3296         }
3297
3298         /// Get the commitment tx fee for the remote's next commitment transaction based on the number of
3299         /// pending HTLCs that are on track to be in their next commitment tx
3300         ///
3301         /// Optionally includes the `HTLCCandidate` given by `htlc` and an additional non-dust HTLC if
3302         /// `fee_spike_buffer_htlc` is `Some`.
3303         ///
3304         /// The first extra HTLC is useful for determining whether we can accept a further HTLC, the
3305         /// second allows for creating a buffer to ensure a further HTLC can always be accepted/added.
3306         ///
3307         /// Dust HTLCs are excluded.
3308         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
3309                 let context = &self;
3310                 assert!(!context.is_outbound());
3311
3312                 let (htlc_success_dust_limit, htlc_timeout_dust_limit) = if context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
3313                         (0, 0)
3314                 } else {
3315                         (context.feerate_per_kw as u64 * htlc_success_tx_weight(context.get_channel_type()) / 1000,
3316                                 context.feerate_per_kw as u64 * htlc_timeout_tx_weight(context.get_channel_type()) / 1000)
3317                 };
3318                 let real_dust_limit_success_sat = htlc_success_dust_limit + context.counterparty_dust_limit_satoshis;
3319                 let real_dust_limit_timeout_sat = htlc_timeout_dust_limit + context.counterparty_dust_limit_satoshis;
3320
3321                 let mut addl_htlcs = 0;
3322                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
3323                 match htlc.origin {
3324                         HTLCInitiator::LocalOffered => {
3325                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
3326                                         addl_htlcs += 1;
3327                                 }
3328                         },
3329                         HTLCInitiator::RemoteOffered => {
3330                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
3331                                         addl_htlcs += 1;
3332                                 }
3333                         }
3334                 }
3335
3336                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
3337                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
3338                 // committed outbound HTLCs, see below.
3339                 let mut included_htlcs = 0;
3340                 for ref htlc in context.pending_inbound_htlcs.iter() {
3341                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
3342                                 continue
3343                         }
3344                         included_htlcs += 1;
3345                 }
3346
3347                 for ref htlc in context.pending_outbound_htlcs.iter() {
3348                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
3349                                 continue
3350                         }
3351                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
3352                         // i.e. if they've responded to us with an RAA after announcement.
3353                         match htlc.state {
3354                                 OutboundHTLCState::Committed => included_htlcs += 1,
3355                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
3356                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
3357                                 _ => {},
3358                         }
3359                 }
3360
3361                 let num_htlcs = included_htlcs + addl_htlcs;
3362                 let res = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs, &context.channel_type);
3363                 #[cfg(any(test, fuzzing))]
3364                 {
3365                         let mut fee = res;
3366                         if fee_spike_buffer_htlc.is_some() {
3367                                 fee = commit_tx_fee_msat(context.feerate_per_kw, num_htlcs - 1, &context.channel_type);
3368                         }
3369                         let total_pending_htlcs = context.pending_inbound_htlcs.len() + context.pending_outbound_htlcs.len();
3370                         let commitment_tx_info = CommitmentTxInfoCached {
3371                                 fee,
3372                                 total_pending_htlcs,
3373                                 next_holder_htlc_id: match htlc.origin {
3374                                         HTLCInitiator::LocalOffered => context.next_holder_htlc_id + 1,
3375                                         HTLCInitiator::RemoteOffered => context.next_holder_htlc_id,
3376                                 },
3377                                 next_counterparty_htlc_id: match htlc.origin {
3378                                         HTLCInitiator::LocalOffered => context.next_counterparty_htlc_id,
3379                                         HTLCInitiator::RemoteOffered => context.next_counterparty_htlc_id + 1,
3380                                 },
3381                                 feerate: context.feerate_per_kw,
3382                         };
3383                         *context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
3384                 }
3385                 res
3386         }
3387
3388         fn if_unbroadcasted_funding<F, O>(&self, f: F) -> Option<O> where F: Fn() -> Option<O> {
3389                 match self.channel_state {
3390                         ChannelState::FundingNegotiated => f(),
3391                         ChannelState::AwaitingChannelReady(flags) =>
3392                                 if flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH) ||
3393                                         flags.is_set(FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS.into())
3394                                 {
3395                                         f()
3396                                 } else {
3397                                         None
3398                                 },
3399                         _ => None,
3400                 }
3401         }
3402
3403         /// Returns the transaction if there is a pending funding transaction that is yet to be
3404         /// broadcast.
3405         pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
3406                 self.if_unbroadcasted_funding(|| self.funding_transaction.clone())
3407         }
3408
3409         /// Returns the transaction ID if there is a pending funding transaction that is yet to be
3410         /// broadcast.
3411         pub fn unbroadcasted_funding_txid(&self) -> Option<Txid> {
3412                 self.if_unbroadcasted_funding(||
3413                         self.channel_transaction_parameters.funding_outpoint.map(|txo| txo.txid)
3414                 )
3415         }
3416
3417         /// Returns whether the channel is funded in a batch.
3418         pub fn is_batch_funding(&self) -> bool {
3419                 self.is_batch_funding.is_some()
3420         }
3421
3422         /// Returns the transaction ID if there is a pending batch funding transaction that is yet to be
3423         /// broadcast.
3424         pub fn unbroadcasted_batch_funding_txid(&self) -> Option<Txid> {
3425                 self.unbroadcasted_funding_txid().filter(|_| self.is_batch_funding())
3426         }
3427
3428         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3429         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3430         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3431         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3432         /// immediately (others we will have to allow to time out).
3433         pub fn force_shutdown(&mut self, should_broadcast: bool, closure_reason: ClosureReason) -> ShutdownResult {
3434                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
3435                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
3436                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
3437                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
3438                 assert!(!matches!(self.channel_state, ChannelState::ShutdownComplete));
3439
3440                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3441                 // return them to fail the payment.
3442                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3443                 let counterparty_node_id = self.get_counterparty_node_id();
3444                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3445                         match htlc_update {
3446                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3447                                         dropped_outbound_htlcs.push((source, payment_hash, counterparty_node_id, self.channel_id));
3448                                 },
3449                                 _ => {}
3450                         }
3451                 }
3452                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
3453                         // If we haven't yet exchanged funding signatures (ie channel_state < AwaitingChannelReady),
3454                         // returning a channel monitor update here would imply a channel monitor update before
3455                         // we even registered the channel monitor to begin with, which is invalid.
3456                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
3457                         // funding transaction, don't return a funding txo (which prevents providing the
3458                         // monitor update to the user, even if we return one).
3459                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
3460                         if !self.channel_state.is_pre_funded_state() {
3461                                 self.latest_monitor_update_id = CLOSED_CHANNEL_UPDATE_ID;
3462                                 Some((self.get_counterparty_node_id(), funding_txo, self.channel_id(), ChannelMonitorUpdate {
3463                                         update_id: self.latest_monitor_update_id,
3464                                         counterparty_node_id: Some(self.counterparty_node_id),
3465                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3466                                         channel_id: Some(self.channel_id()),
3467                                 }))
3468                         } else { None }
3469                 } else { None };
3470                 let unbroadcasted_batch_funding_txid = self.unbroadcasted_batch_funding_txid();
3471                 let unbroadcasted_funding_tx = self.unbroadcasted_funding();
3472
3473                 self.channel_state = ChannelState::ShutdownComplete;
3474                 self.update_time_counter += 1;
3475                 ShutdownResult {
3476                         closure_reason,
3477                         monitor_update,
3478                         dropped_outbound_htlcs,
3479                         unbroadcasted_batch_funding_txid,
3480                         channel_id: self.channel_id,
3481                         user_channel_id: self.user_id,
3482                         channel_capacity_satoshis: self.channel_value_satoshis,
3483                         counterparty_node_id: self.counterparty_node_id,
3484                         unbroadcasted_funding_tx,
3485                         channel_funding_txo: self.get_funding_txo(),
3486                 }
3487         }
3488
3489         /// Only allowed after [`Self::channel_transaction_parameters`] is set.
3490         fn get_funding_signed_msg<L: Deref>(&mut self, logger: &L) -> (CommitmentTransaction, Option<msgs::FundingSigned>) where L::Target: Logger {
3491                 let counterparty_keys = self.build_remote_transaction_keys();
3492                 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number + 1, &counterparty_keys, false, false, logger).tx;
3493
3494                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
3495                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
3496                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
3497                         &self.channel_id(), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
3498
3499                 match &self.holder_signer {
3500                         // TODO (arik): move match into calling method for Taproot
3501                         ChannelSignerType::Ecdsa(ecdsa) => {
3502                                 let funding_signed = ecdsa.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), Vec::new(), &self.secp_ctx)
3503                                         .map(|(signature, _)| msgs::FundingSigned {
3504                                                 channel_id: self.channel_id(),
3505                                                 signature,
3506                                                 #[cfg(taproot)]
3507                                                 partial_signature_with_nonce: None,
3508                                         })
3509                                         .ok();
3510
3511                                 if funding_signed.is_none() {
3512                                         #[cfg(not(async_signing))] {
3513                                                 panic!("Failed to get signature for funding_signed");
3514                                         }
3515                                         #[cfg(async_signing)] {
3516                                                 log_trace!(logger, "Counterparty commitment signature not available for funding_signed message; setting signer_pending_funding");
3517                                                 self.signer_pending_funding = true;
3518                                         }
3519                                 } else if self.signer_pending_funding {
3520                                         log_trace!(logger, "Counterparty commitment signature available for funding_signed message; clearing signer_pending_funding");
3521                                         self.signer_pending_funding = false;
3522                                 }
3523
3524                                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
3525                                 (counterparty_initial_commitment_tx, funding_signed)
3526                         },
3527                         // TODO (taproot|arik)
3528                         #[cfg(taproot)]
3529                         _ => todo!()
3530                 }
3531         }
3532
3533         /// If we receive an error message when attempting to open a channel, it may only be a rejection
3534         /// of the channel type we tried, not of our ability to open any channel at all. We can see if a
3535         /// downgrade of channel features would be possible so that we can still open the channel.
3536         pub(crate) fn maybe_downgrade_channel_features<F: Deref>(
3537                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>
3538         ) -> Result<(), ()>
3539         where
3540                 F::Target: FeeEstimator
3541         {
3542                 if !self.is_outbound() ||
3543                         !matches!(
3544                                 self.channel_state, ChannelState::NegotiatingFunding(flags)
3545                                 if flags == NegotiatingFundingFlags::OUR_INIT_SENT
3546                         )
3547                 {
3548                         return Err(());
3549                 }
3550                 if self.channel_type == ChannelTypeFeatures::only_static_remote_key() {
3551                         // We've exhausted our options
3552                         return Err(());
3553                 }
3554                 // We support opening a few different types of channels. Try removing our additional
3555                 // features one by one until we've either arrived at our default or the counterparty has
3556                 // accepted one.
3557                 //
3558                 // Due to the order below, we may not negotiate `option_anchors_zero_fee_htlc_tx` if the
3559                 // counterparty doesn't support `option_scid_privacy`. Since `get_initial_channel_type`
3560                 // checks whether the counterparty supports every feature, this would only happen if the
3561                 // counterparty is advertising the feature, but rejecting channels proposing the feature for
3562                 // whatever reason.
3563                 if self.channel_type.supports_anchors_zero_fee_htlc_tx() {
3564                         self.channel_type.clear_anchors_zero_fee_htlc_tx();
3565                         self.feerate_per_kw = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
3566                         assert!(!self.channel_transaction_parameters.channel_type_features.supports_anchors_nonzero_fee_htlc_tx());
3567                 } else if self.channel_type.supports_scid_privacy() {
3568                         self.channel_type.clear_scid_privacy();
3569                 } else {
3570                         self.channel_type = ChannelTypeFeatures::only_static_remote_key();
3571                 }
3572                 self.channel_transaction_parameters.channel_type_features = self.channel_type.clone();
3573                 Ok(())
3574         }
3575 }
3576
3577 // Internal utility functions for channels
3578
3579 /// Returns the value to use for `holder_max_htlc_value_in_flight_msat` as a percentage of the
3580 /// `channel_value_satoshis` in msat, set through
3581 /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]
3582 ///
3583 /// The effective percentage is lower bounded by 1% and upper bounded by 100%.
3584 ///
3585 /// [`ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel`]: crate::util::config::ChannelHandshakeConfig::max_inbound_htlc_value_in_flight_percent_of_channel
3586 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64, config: &ChannelHandshakeConfig) -> u64 {
3587         let configured_percent = if config.max_inbound_htlc_value_in_flight_percent_of_channel < 1 {
3588                 1
3589         } else if config.max_inbound_htlc_value_in_flight_percent_of_channel > 100 {
3590                 100
3591         } else {
3592                 config.max_inbound_htlc_value_in_flight_percent_of_channel as u64
3593         };
3594         channel_value_satoshis * 10 * configured_percent
3595 }
3596
3597 /// Returns a minimum channel reserve value the remote needs to maintain,
3598 /// required by us according to the configured or default
3599 /// [`ChannelHandshakeConfig::their_channel_reserve_proportional_millionths`]
3600 ///
3601 /// Guaranteed to return a value no larger than channel_value_satoshis
3602 ///
3603 /// This is used both for outbound and inbound channels and has lower bound
3604 /// of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`.
3605 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64, config: &UserConfig) -> u64 {
3606         let calculated_reserve = channel_value_satoshis.saturating_mul(config.channel_handshake_config.their_channel_reserve_proportional_millionths as u64) / 1_000_000;
3607         cmp::min(channel_value_satoshis, cmp::max(calculated_reserve, MIN_THEIR_CHAN_RESERVE_SATOSHIS))
3608 }
3609
3610 /// This is for legacy reasons, present for forward-compatibility.
3611 /// LDK versions older than 0.0.104 don't know how read/handle values other than default
3612 /// from storage. Hence, we use this function to not persist default values of
3613 /// `holder_selected_channel_reserve_satoshis` for channels into storage.
3614 pub(crate) fn get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
3615         let (q, _) = channel_value_satoshis.overflowing_div(100);
3616         cmp::min(channel_value_satoshis, cmp::max(q, 1000))
3617 }
3618
3619 /// Returns a minimum channel reserve value each party needs to maintain, fixed in the spec to a
3620 /// default of 1% of the total channel value.
3621 ///
3622 /// Guaranteed to return a value no larger than channel_value_satoshis
3623 ///
3624 /// This is used both for outbound and inbound channels and has lower bound
3625 /// of `dust_limit_satoshis`.
3626 #[cfg(any(dual_funding, splicing))]
3627 fn get_v2_channel_reserve_satoshis(channel_value_satoshis: u64, dust_limit_satoshis: u64) -> u64 {
3628         // Fixed at 1% of channel value by spec.
3629         let (q, _) = channel_value_satoshis.overflowing_div(100);
3630         cmp::min(channel_value_satoshis, cmp::max(q, dust_limit_satoshis))
3631 }
3632
3633 // Get the fee cost in SATS of a commitment tx with a given number of HTLC outputs.
3634 // Note that num_htlcs should not include dust HTLCs.
3635 #[inline]
3636 fn commit_tx_fee_sat(feerate_per_kw: u32, num_htlcs: usize, channel_type_features: &ChannelTypeFeatures) -> u64 {
3637         feerate_per_kw as u64 * (commitment_tx_base_weight(channel_type_features) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
3638 }
3639
3640 // Get the fee cost in MSATS of a commitment tx with a given number of HTLC outputs.
3641 // Note that num_htlcs should not include dust HTLCs.
3642 pub(crate) fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, channel_type_features: &ChannelTypeFeatures) -> u64 {
3643         // Note that we need to divide before multiplying to round properly,
3644         // since the lowest denomination of bitcoin on-chain is the satoshi.
3645         (commitment_tx_base_weight(channel_type_features) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate_per_kw as u64 / 1000 * 1000
3646 }
3647
3648 pub(crate) fn per_outbound_htlc_counterparty_commit_tx_fee_msat(feerate_per_kw: u32, channel_type_features: &ChannelTypeFeatures) -> u64 {
3649         // Note that we need to divide before multiplying to round properly,
3650         // since the lowest denomination of bitcoin on-chain is the satoshi.
3651         let commitment_tx_fee = COMMITMENT_TX_WEIGHT_PER_HTLC * feerate_per_kw as u64 / 1000 * 1000;
3652         if channel_type_features.supports_anchors_zero_fee_htlc_tx() {
3653                 commitment_tx_fee + htlc_success_tx_weight(channel_type_features) * feerate_per_kw as u64 / 1000
3654         } else {
3655                 commitment_tx_fee
3656         }
3657 }
3658
3659 /// Context for dual-funded channels.
3660 #[cfg(any(dual_funding, splicing))]
3661 pub(super) struct DualFundingChannelContext {
3662         /// The amount in satoshis we will be contributing to the channel.
3663         pub our_funding_satoshis: u64,
3664         /// The amount in satoshis our counterparty will be contributing to the channel.
3665         pub their_funding_satoshis: u64,
3666         /// The funding transaction locktime suggested by the initiator. If set by us, it is always set
3667         /// to the current block height to align incentives against fee-sniping.
3668         pub funding_tx_locktime: u32,
3669         /// The feerate set by the initiator to be used for the funding transaction.
3670         pub funding_feerate_sat_per_1000_weight: u32,
3671 }
3672
3673 // Holder designates channel data owned for the benefit of the user client.
3674 // Counterparty designates channel data owned by the another channel participant entity.
3675 pub(super) struct Channel<SP: Deref> where SP::Target: SignerProvider {
3676         pub context: ChannelContext<SP>,
3677         #[cfg(any(dual_funding, splicing))]
3678         pub dual_funding_channel_context: Option<DualFundingChannelContext>,
3679 }
3680
3681 #[cfg(any(test, fuzzing))]
3682 struct CommitmentTxInfoCached {
3683         fee: u64,
3684         total_pending_htlcs: usize,
3685         next_holder_htlc_id: u64,
3686         next_counterparty_htlc_id: u64,
3687         feerate: u32,
3688 }
3689
3690 /// Contents of a wire message that fails an HTLC backwards. Useful for [`Channel::fail_htlc`] to
3691 /// fail with either [`msgs::UpdateFailMalformedHTLC`] or [`msgs::UpdateFailHTLC`] as needed.
3692 trait FailHTLCContents {
3693         type Message: FailHTLCMessageName;
3694         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message;
3695         fn to_inbound_htlc_state(self) -> InboundHTLCState;
3696         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK;
3697 }
3698 impl FailHTLCContents for msgs::OnionErrorPacket {
3699         type Message = msgs::UpdateFailHTLC;
3700         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
3701                 msgs::UpdateFailHTLC { htlc_id, channel_id, reason: self }
3702         }
3703         fn to_inbound_htlc_state(self) -> InboundHTLCState {
3704                 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(self))
3705         }
3706         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK {
3707                 HTLCUpdateAwaitingACK::FailHTLC { htlc_id, err_packet: self }
3708         }
3709 }
3710 impl FailHTLCContents for ([u8; 32], u16) {
3711         type Message = msgs::UpdateFailMalformedHTLC;
3712         fn to_message(self, htlc_id: u64, channel_id: ChannelId) -> Self::Message {
3713                 msgs::UpdateFailMalformedHTLC {
3714                         htlc_id,
3715                         channel_id,
3716                         sha256_of_onion: self.0,
3717                         failure_code: self.1
3718                 }
3719         }
3720         fn to_inbound_htlc_state(self) -> InboundHTLCState {
3721                 InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed(self))
3722         }
3723         fn to_htlc_update_awaiting_ack(self, htlc_id: u64) -> HTLCUpdateAwaitingACK {
3724                 HTLCUpdateAwaitingACK::FailMalformedHTLC {
3725                         htlc_id,
3726                         sha256_of_onion: self.0,
3727                         failure_code: self.1
3728                 }
3729         }
3730 }
3731
3732 trait FailHTLCMessageName {
3733         fn name() -> &'static str;
3734 }
3735 impl FailHTLCMessageName for msgs::UpdateFailHTLC {
3736         fn name() -> &'static str {
3737                 "update_fail_htlc"
3738         }
3739 }
3740 impl FailHTLCMessageName for msgs::UpdateFailMalformedHTLC {
3741         fn name() -> &'static str {
3742                 "update_fail_malformed_htlc"
3743         }
3744 }
3745
3746 impl<SP: Deref> Channel<SP> where
3747         SP::Target: SignerProvider,
3748         <SP::Target as SignerProvider>::EcdsaSigner: EcdsaChannelSigner
3749 {
3750         fn check_remote_fee<F: Deref, L: Deref>(
3751                 channel_type: &ChannelTypeFeatures, fee_estimator: &LowerBoundedFeeEstimator<F>,
3752                 feerate_per_kw: u32, cur_feerate_per_kw: Option<u32>, logger: &L
3753         ) -> Result<(), ChannelError> where F::Target: FeeEstimator, L::Target: Logger,
3754         {
3755                 let lower_limit_conf_target = if channel_type.supports_anchors_zero_fee_htlc_tx() {
3756                         ConfirmationTarget::MinAllowedAnchorChannelRemoteFee
3757                 } else {
3758                         ConfirmationTarget::MinAllowedNonAnchorChannelRemoteFee
3759                 };
3760                 let lower_limit = fee_estimator.bounded_sat_per_1000_weight(lower_limit_conf_target);
3761                 if feerate_per_kw < lower_limit {
3762                         if let Some(cur_feerate) = cur_feerate_per_kw {
3763                                 if feerate_per_kw > cur_feerate {
3764                                         log_warn!(logger,
3765                                                 "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.",
3766                                                 cur_feerate, feerate_per_kw);
3767                                         return Ok(());
3768                                 }
3769                         }
3770                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
3771                 }
3772                 Ok(())
3773         }
3774
3775         #[inline]
3776         fn get_closing_scriptpubkey(&self) -> ScriptBuf {
3777                 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
3778                 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
3779                 // outside of those situations will fail.
3780                 self.context.shutdown_scriptpubkey.clone().unwrap().into_inner()
3781         }
3782
3783         #[inline]
3784         fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
3785                 let mut ret =
3786                 (4 +                                                   // version
3787                  1 +                                                   // input count
3788                  36 +                                                  // prevout
3789                  1 +                                                   // script length (0)
3790                  4 +                                                   // sequence
3791                  1 +                                                   // output count
3792                  4                                                     // lock time
3793                  )*4 +                                                 // * 4 for non-witness parts
3794                 2 +                                                    // witness marker and flag
3795                 1 +                                                    // witness element count
3796                 4 +                                                    // 4 element lengths (2 sigs, multisig dummy, and witness script)
3797                 self.context.get_funding_redeemscript().len() as u64 + // funding witness script
3798                 2*(1 + 71);                                            // two signatures + sighash type flags
3799                 if let Some(spk) = a_scriptpubkey {
3800                         ret += ((8+1) +                                    // output values and script length
3801                                 spk.len() as u64) * 4;                         // scriptpubkey and witness multiplier
3802                 }
3803                 if let Some(spk) = b_scriptpubkey {
3804                         ret += ((8+1) +                                    // output values and script length
3805                                 spk.len() as u64) * 4;                         // scriptpubkey and witness multiplier
3806                 }
3807                 ret
3808         }
3809
3810         #[inline]
3811         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
3812                 assert!(self.context.pending_inbound_htlcs.is_empty());
3813                 assert!(self.context.pending_outbound_htlcs.is_empty());
3814                 assert!(self.context.pending_update_fee.is_none());
3815
3816                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
3817                 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 };
3818                 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 };
3819
3820                 if value_to_holder < 0 {
3821                         assert!(self.context.is_outbound());
3822                         total_fee_satoshis += (-value_to_holder) as u64;
3823                 } else if value_to_counterparty < 0 {
3824                         assert!(!self.context.is_outbound());
3825                         total_fee_satoshis += (-value_to_counterparty) as u64;
3826                 }
3827
3828                 if skip_remote_output || value_to_counterparty as u64 <= self.context.holder_dust_limit_satoshis {
3829                         value_to_counterparty = 0;
3830                 }
3831
3832                 if value_to_holder as u64 <= self.context.holder_dust_limit_satoshis {
3833                         value_to_holder = 0;
3834                 }
3835
3836                 assert!(self.context.shutdown_scriptpubkey.is_some());
3837                 let holder_shutdown_script = self.get_closing_scriptpubkey();
3838                 let counterparty_shutdown_script = self.context.counterparty_shutdown_scriptpubkey.clone().unwrap();
3839                 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
3840
3841                 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
3842                 (closing_transaction, total_fee_satoshis)
3843         }
3844
3845         fn funding_outpoint(&self) -> OutPoint {
3846                 self.context.channel_transaction_parameters.funding_outpoint.unwrap()
3847         }
3848
3849         /// Claims an HTLC while we're disconnected from a peer, dropping the [`ChannelMonitorUpdate`]
3850         /// entirely.
3851         ///
3852         /// The [`ChannelMonitor`] for this channel MUST be updated out-of-band with the preimage
3853         /// provided (i.e. without calling [`crate::chain::Watch::update_channel`]).
3854         ///
3855         /// The HTLC claim will end up in the holding cell (because the caller must ensure the peer is
3856         /// disconnected).
3857         pub fn claim_htlc_while_disconnected_dropping_mon_update<L: Deref>
3858                 (&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L)
3859         where L::Target: Logger {
3860                 // Assert that we'll add the HTLC claim to the holding cell in `get_update_fulfill_htlc`
3861                 // (see equivalent if condition there).
3862                 assert!(!self.context.channel_state.can_generate_new_commitment());
3863                 let mon_update_id = self.context.latest_monitor_update_id; // Forget the ChannelMonitor update
3864                 let fulfill_resp = self.get_update_fulfill_htlc(htlc_id_arg, payment_preimage_arg, logger);
3865                 self.context.latest_monitor_update_id = mon_update_id;
3866                 if let UpdateFulfillFetch::NewClaim { msg, .. } = fulfill_resp {
3867                         assert!(msg.is_none()); // The HTLC must have ended up in the holding cell.
3868                 }
3869         }
3870
3871         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
3872                 // Either ChannelReady got set (which means it won't be unset) or there is no way any
3873                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
3874                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
3875                 // either.
3876                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
3877                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
3878                 }
3879
3880                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
3881                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
3882                 // these, but for now we just have to treat them as normal.
3883
3884                 let mut pending_idx = core::usize::MAX;
3885                 let mut htlc_value_msat = 0;
3886                 for (idx, htlc) in self.context.pending_inbound_htlcs.iter().enumerate() {
3887                         if htlc.htlc_id == htlc_id_arg {
3888                                 debug_assert_eq!(htlc.payment_hash, PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).to_byte_array()));
3889                                 log_debug!(logger, "Claiming inbound HTLC id {} with payment hash {} with preimage {}",
3890                                         htlc.htlc_id, htlc.payment_hash, payment_preimage_arg);
3891                                 match htlc.state {
3892                                         InboundHTLCState::Committed => {},
3893                                         InboundHTLCState::LocalRemoved(ref reason) => {
3894                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
3895                                                 } else {
3896                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", &htlc.payment_hash, &self.context.channel_id());
3897                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
3898                                                 }
3899                                                 return UpdateFulfillFetch::DuplicateClaim {};
3900                                         },
3901                                         _ => {
3902                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
3903                                                 // Don't return in release mode here so that we can update channel_monitor
3904                                         }
3905                                 }
3906                                 pending_idx = idx;
3907                                 htlc_value_msat = htlc.amount_msat;
3908                                 break;
3909                         }
3910                 }
3911                 if pending_idx == core::usize::MAX {
3912                         #[cfg(any(test, fuzzing))]
3913                         // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
3914                         // this is simply a duplicate claim, not previously failed and we lost funds.
3915                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
3916                         return UpdateFulfillFetch::DuplicateClaim {};
3917                 }
3918
3919                 // Now update local state:
3920                 //
3921                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
3922                 // can claim it even if the channel hits the chain before we see their next commitment.
3923                 self.context.latest_monitor_update_id += 1;
3924                 let monitor_update = ChannelMonitorUpdate {
3925                         update_id: self.context.latest_monitor_update_id,
3926                         counterparty_node_id: Some(self.context.counterparty_node_id),
3927                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3928                                 payment_preimage: payment_preimage_arg.clone(),
3929                         }],
3930                         channel_id: Some(self.context.channel_id()),
3931                 };
3932
3933                 if !self.context.channel_state.can_generate_new_commitment() {
3934                         // Note that this condition is the same as the assertion in
3935                         // `claim_htlc_while_disconnected_dropping_mon_update` and must match exactly -
3936                         // `claim_htlc_while_disconnected_dropping_mon_update` would not work correctly if we
3937                         // do not not get into this branch.
3938                         for pending_update in self.context.holding_cell_htlc_updates.iter() {
3939                                 match pending_update {
3940                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
3941                                                 if htlc_id_arg == htlc_id {
3942                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
3943                                                         self.context.latest_monitor_update_id -= 1;
3944                                                         #[cfg(any(test, fuzzing))]
3945                                                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
3946                                                         return UpdateFulfillFetch::DuplicateClaim {};
3947                                                 }
3948                                         },
3949                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } |
3950                                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } =>
3951                                         {
3952                                                 if htlc_id_arg == htlc_id {
3953                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", &self.context.channel_id());
3954                                                         // TODO: We may actually be able to switch to a fulfill here, though its
3955                                                         // rare enough it may not be worth the complexity burden.
3956                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
3957                                                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3958                                                 }
3959                                         },
3960                                         _ => {}
3961                                 }
3962                         }
3963                         log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", &self.context.channel_id(), self.context.channel_state.to_u32());
3964                         self.context.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
3965                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
3966                         });
3967                         #[cfg(any(test, fuzzing))]
3968                         self.context.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
3969                         return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3970                 }
3971                 #[cfg(any(test, fuzzing))]
3972                 self.context.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
3973
3974                 {
3975                         let htlc = &mut self.context.pending_inbound_htlcs[pending_idx];
3976                         if let InboundHTLCState::Committed = htlc.state {
3977                         } else {
3978                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
3979                                 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
3980                         }
3981                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", &htlc.payment_hash, &self.context.channel_id);
3982                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
3983                 }
3984
3985                 UpdateFulfillFetch::NewClaim {
3986                         monitor_update,
3987                         htlc_value_msat,
3988                         msg: Some(msgs::UpdateFulfillHTLC {
3989                                 channel_id: self.context.channel_id(),
3990                                 htlc_id: htlc_id_arg,
3991                                 payment_preimage: payment_preimage_arg,
3992                         }),
3993                 }
3994         }
3995
3996         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 {
3997                 let release_cs_monitor = self.context.blocked_monitor_updates.is_empty();
3998                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
3999                         UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg } => {
4000                                 // Even if we aren't supposed to let new monitor updates with commitment state
4001                                 // updates run, we still need to push the preimage ChannelMonitorUpdateStep no
4002                                 // matter what. Sadly, to push a new monitor update which flies before others
4003                                 // already queued, we have to insert it into the pending queue and update the
4004                                 // update_ids of all the following monitors.
4005                                 if release_cs_monitor && msg.is_some() {
4006                                         let mut additional_update = self.build_commitment_no_status_check(logger);
4007                                         // build_commitment_no_status_check may bump latest_monitor_id but we want them
4008                                         // to be strictly increasing by one, so decrement it here.
4009                                         self.context.latest_monitor_update_id = monitor_update.update_id;
4010                                         monitor_update.updates.append(&mut additional_update.updates);
4011                                 } else {
4012                                         let new_mon_id = self.context.blocked_monitor_updates.get(0)
4013                                                 .map(|upd| upd.update.update_id).unwrap_or(monitor_update.update_id);
4014                                         monitor_update.update_id = new_mon_id;
4015                                         for held_update in self.context.blocked_monitor_updates.iter_mut() {
4016                                                 held_update.update.update_id += 1;
4017                                         }
4018                                         if msg.is_some() {
4019                                                 debug_assert!(false, "If there is a pending blocked monitor we should have MonitorUpdateInProgress set");
4020                                                 let update = self.build_commitment_no_status_check(logger);
4021                                                 self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
4022                                                         update,
4023                                                 });
4024                                         }
4025                                 }
4026
4027                                 self.monitor_updating_paused(false, msg.is_some(), false, Vec::new(), Vec::new(), Vec::new());
4028                                 UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, }
4029                         },
4030                         UpdateFulfillFetch::DuplicateClaim {} => UpdateFulfillCommitFetch::DuplicateClaim {},
4031                 }
4032         }
4033
4034         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
4035         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
4036         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
4037         /// before we fail backwards.
4038         ///
4039         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
4040         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
4041         /// [`ChannelError::Ignore`].
4042         pub fn queue_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L)
4043         -> Result<(), ChannelError> where L::Target: Logger {
4044                 self.fail_htlc(htlc_id_arg, err_packet, true, logger)
4045                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
4046         }
4047
4048         /// Used for failing back with [`msgs::UpdateFailMalformedHTLC`]. For now, this is used when we
4049         /// want to fail blinded HTLCs where we are not the intro node.
4050         ///
4051         /// See [`Self::queue_fail_htlc`] for more info.
4052         pub fn queue_fail_malformed_htlc<L: Deref>(
4053                 &mut self, htlc_id_arg: u64, failure_code: u16, sha256_of_onion: [u8; 32], logger: &L
4054         ) -> Result<(), ChannelError> where L::Target: Logger {
4055                 self.fail_htlc(htlc_id_arg, (sha256_of_onion, failure_code), true, logger)
4056                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
4057         }
4058
4059         /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
4060         /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
4061         /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
4062         /// before we fail backwards.
4063         ///
4064         /// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
4065         /// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
4066         /// [`ChannelError::Ignore`].
4067         fn fail_htlc<L: Deref, E: FailHTLCContents + Clone>(
4068                 &mut self, htlc_id_arg: u64, err_contents: E, mut force_holding_cell: bool,
4069                 logger: &L
4070         ) -> Result<Option<E::Message>, ChannelError> where L::Target: Logger {
4071                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4072                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
4073                 }
4074
4075                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
4076                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
4077                 // these, but for now we just have to treat them as normal.
4078
4079                 let mut pending_idx = core::usize::MAX;
4080                 for (idx, htlc) in self.context.pending_inbound_htlcs.iter().enumerate() {
4081                         if htlc.htlc_id == htlc_id_arg {
4082                                 match htlc.state {
4083                                         InboundHTLCState::Committed => {},
4084                                         InboundHTLCState::LocalRemoved(ref reason) => {
4085                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
4086                                                 } else {
4087                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
4088                                                 }
4089                                                 return Ok(None);
4090                                         },
4091                                         _ => {
4092                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
4093                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
4094                                         }
4095                                 }
4096                                 pending_idx = idx;
4097                         }
4098                 }
4099                 if pending_idx == core::usize::MAX {
4100                         #[cfg(any(test, fuzzing))]
4101                         // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
4102                         // is simply a duplicate fail, not previously failed and we failed-back too early.
4103                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
4104                         return Ok(None);
4105                 }
4106
4107                 if !self.context.channel_state.can_generate_new_commitment() {
4108                         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!");
4109                         force_holding_cell = true;
4110                 }
4111
4112                 // Now update local state:
4113                 if force_holding_cell {
4114                         for pending_update in self.context.holding_cell_htlc_updates.iter() {
4115                                 match pending_update {
4116                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
4117                                                 if htlc_id_arg == htlc_id {
4118                                                         #[cfg(any(test, fuzzing))]
4119                                                         debug_assert!(self.context.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
4120                                                         return Ok(None);
4121                                                 }
4122                                         },
4123                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } |
4124                                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, .. } =>
4125                                         {
4126                                                 if htlc_id_arg == htlc_id {
4127                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
4128                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
4129                                                 }
4130                                         },
4131                                         _ => {}
4132                                 }
4133                         }
4134                         log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, &self.context.channel_id());
4135                         self.context.holding_cell_htlc_updates.push(err_contents.to_htlc_update_awaiting_ack(htlc_id_arg));
4136                         return Ok(None);
4137                 }
4138
4139                 log_trace!(logger, "Failing HTLC ID {} back with {} message in channel {}.", htlc_id_arg,
4140                         E::Message::name(), &self.context.channel_id());
4141                 {
4142                         let htlc = &mut self.context.pending_inbound_htlcs[pending_idx];
4143                         htlc.state = err_contents.clone().to_inbound_htlc_state();
4144                 }
4145
4146                 Ok(Some(err_contents.to_message(htlc_id_arg, self.context.channel_id())))
4147         }
4148
4149         // Message handlers:
4150         /// Updates the state of the channel to indicate that all channels in the batch have received
4151         /// funding_signed and persisted their monitors.
4152         /// The funding transaction is consequently allowed to be broadcast, and the channel can be
4153         /// treated as a non-batch channel going forward.
4154         pub fn set_batch_ready(&mut self) {
4155                 self.context.is_batch_funding = None;
4156                 self.context.channel_state.clear_waiting_for_batch();
4157         }
4158
4159         /// Unsets the existing funding information.
4160         ///
4161         /// This must only be used if the channel has not yet completed funding and has not been used.
4162         ///
4163         /// Further, the channel must be immediately shut down after this with a call to
4164         /// [`ChannelContext::force_shutdown`].
4165         pub fn unset_funding_info(&mut self, temporary_channel_id: ChannelId) {
4166                 debug_assert!(matches!(
4167                         self.context.channel_state, ChannelState::AwaitingChannelReady(_)
4168                 ));
4169                 self.context.channel_transaction_parameters.funding_outpoint = None;
4170                 self.context.channel_id = temporary_channel_id;
4171         }
4172
4173         /// Handles a channel_ready message from our peer. If we've already sent our channel_ready
4174         /// and the channel is now usable (and public), this may generate an announcement_signatures to
4175         /// reply with.
4176         pub fn channel_ready<NS: Deref, L: Deref>(
4177                 &mut self, msg: &msgs::ChannelReady, node_signer: &NS, chain_hash: ChainHash,
4178                 user_config: &UserConfig, best_block: &BestBlock, logger: &L
4179         ) -> Result<Option<msgs::AnnouncementSignatures>, ChannelError>
4180         where
4181                 NS::Target: NodeSigner,
4182                 L::Target: Logger
4183         {
4184                 if self.context.channel_state.is_peer_disconnected() {
4185                         self.context.workaround_lnd_bug_4006 = Some(msg.clone());
4186                         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()));
4187                 }
4188
4189                 if let Some(scid_alias) = msg.short_channel_id_alias {
4190                         if Some(scid_alias) != self.context.short_channel_id {
4191                                 // The scid alias provided can be used to route payments *from* our counterparty,
4192                                 // i.e. can be used for inbound payments and provided in invoices, but is not used
4193                                 // when routing outbound payments.
4194                                 self.context.latest_inbound_scid_alias = Some(scid_alias);
4195                         }
4196                 }
4197
4198                 // Our channel_ready shouldn't have been sent if we are waiting for other channels in the
4199                 // batch, but we can receive channel_ready messages.
4200                 let mut check_reconnection = false;
4201                 match &self.context.channel_state {
4202                         ChannelState::AwaitingChannelReady(flags) => {
4203                                 let flags = flags.clone().clear(FundedStateFlags::ALL.into());
4204                                 debug_assert!(!flags.is_set(AwaitingChannelReadyFlags::OUR_CHANNEL_READY) || !flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
4205                                 if flags.clone().clear(AwaitingChannelReadyFlags::WAITING_FOR_BATCH) == AwaitingChannelReadyFlags::THEIR_CHANNEL_READY {
4206                                         // If we reconnected before sending our `channel_ready` they may still resend theirs.
4207                                         check_reconnection = true;
4208                                 } else if flags.clone().clear(AwaitingChannelReadyFlags::WAITING_FOR_BATCH).is_empty() {
4209                                         self.context.channel_state.set_their_channel_ready();
4210                                 } else if flags == AwaitingChannelReadyFlags::OUR_CHANNEL_READY {
4211                                         self.context.channel_state = ChannelState::ChannelReady(self.context.channel_state.with_funded_state_flags_mask().into());
4212                                         self.context.update_time_counter += 1;
4213                                 } else {
4214                                         // We're in `WAITING_FOR_BATCH`, so we should wait until we're ready.
4215                                         debug_assert!(flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
4216                                 }
4217                         }
4218                         // If we reconnected before sending our `channel_ready` they may still resend theirs.
4219                         ChannelState::ChannelReady(_) => check_reconnection = true,
4220                         _ => return Err(ChannelError::Close("Peer sent a channel_ready at a strange time".to_owned())),
4221                 }
4222                 if check_reconnection {
4223                         // They probably disconnected/reconnected and re-sent the channel_ready, which is
4224                         // required, or they're sending a fresh SCID alias.
4225                         let expected_point =
4226                                 if self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
4227                                         // If they haven't ever sent an updated point, the point they send should match
4228                                         // the current one.
4229                                         self.context.counterparty_cur_commitment_point
4230                                 } else if self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 2 {
4231                                         // If we've advanced the commitment number once, the second commitment point is
4232                                         // at `counterparty_prev_commitment_point`, which is not yet revoked.
4233                                         debug_assert!(self.context.counterparty_prev_commitment_point.is_some());
4234                                         self.context.counterparty_prev_commitment_point
4235                                 } else {
4236                                         // If they have sent updated points, channel_ready is always supposed to match
4237                                         // their "first" point, which we re-derive here.
4238                                         Some(PublicKey::from_secret_key(&self.context.secp_ctx, &SecretKey::from_slice(
4239                                                         &self.context.commitment_secrets.get_secret(INITIAL_COMMITMENT_NUMBER - 1).expect("We should have all prev secrets available")
4240                                                 ).expect("We already advanced, so previous secret keys should have been validated already")))
4241                                 };
4242                         if expected_point != Some(msg.next_per_commitment_point) {
4243                                 return Err(ChannelError::Close("Peer sent a reconnect channel_ready with a different point".to_owned()));
4244                         }
4245                         return Ok(None);
4246                 }
4247
4248                 self.context.counterparty_prev_commitment_point = self.context.counterparty_cur_commitment_point;
4249                 self.context.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
4250
4251                 log_info!(logger, "Received channel_ready from peer for channel {}", &self.context.channel_id());
4252
4253                 Ok(self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block.height, logger))
4254         }
4255
4256         pub fn update_add_htlc<F: Deref>(
4257                 &mut self, msg: &msgs::UpdateAddHTLC, pending_forward_status: PendingHTLCStatus,
4258                 fee_estimator: &LowerBoundedFeeEstimator<F>,
4259         ) -> Result<(), ChannelError> where F::Target: FeeEstimator {
4260                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4261                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
4262                 }
4263                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
4264                 if self.context.channel_state.is_remote_shutdown_sent() {
4265                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
4266                 }
4267                 if self.context.channel_state.is_peer_disconnected() {
4268                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
4269                 }
4270                 if msg.amount_msat > self.context.channel_value_satoshis * 1000 {
4271                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
4272                 }
4273                 if msg.amount_msat == 0 {
4274                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
4275                 }
4276                 if msg.amount_msat < self.context.holder_htlc_minimum_msat {
4277                         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)));
4278                 }
4279
4280                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
4281                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
4282                 if htlc_stats.pending_inbound_htlcs + 1 > self.context.holder_max_accepted_htlcs as usize {
4283                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", self.context.holder_max_accepted_htlcs)));
4284                 }
4285                 if htlc_stats.pending_inbound_htlcs_value_msat + msg.amount_msat > self.context.holder_max_htlc_value_in_flight_msat {
4286                         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)));
4287                 }
4288
4289                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
4290                 // the reserve_satoshis we told them to always have as direct payment so that they lose
4291                 // something if we punish them for broadcasting an old state).
4292                 // Note that we don't really care about having a small/no to_remote output in our local
4293                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
4294                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
4295                 // present in the next commitment transaction we send them (at least for fulfilled ones,
4296                 // failed ones won't modify value_to_self).
4297                 // Note that we will send HTLCs which another instance of rust-lightning would think
4298                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
4299                 // Channel state once they will not be present in the next received commitment
4300                 // transaction).
4301                 let mut removed_outbound_total_msat = 0;
4302                 for ref htlc in self.context.pending_outbound_htlcs.iter() {
4303                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
4304                                 removed_outbound_total_msat += htlc.amount_msat;
4305                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
4306                                 removed_outbound_total_msat += htlc.amount_msat;
4307                         }
4308                 }
4309
4310                 let pending_value_to_self_msat =
4311                         self.context.value_to_self_msat + htlc_stats.pending_inbound_htlcs_value_msat - removed_outbound_total_msat;
4312                 let pending_remote_value_msat =
4313                         self.context.channel_value_satoshis * 1000 - pending_value_to_self_msat;
4314                 if pending_remote_value_msat < msg.amount_msat {
4315                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
4316                 }
4317
4318                 // Check that the remote can afford to pay for this HTLC on-chain at the current
4319                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
4320                 {
4321                         let remote_commit_tx_fee_msat = if self.context.is_outbound() { 0 } else {
4322                                 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
4323                                 self.context.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
4324                         };
4325                         let anchor_outputs_value_msat = if !self.context.is_outbound() && self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4326                                 ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
4327                         } else {
4328                                 0
4329                         };
4330                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(anchor_outputs_value_msat) < remote_commit_tx_fee_msat {
4331                                 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
4332                         };
4333                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(remote_commit_tx_fee_msat).saturating_sub(anchor_outputs_value_msat) < self.context.holder_selected_channel_reserve_satoshis * 1000 {
4334                                 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
4335                         }
4336                 }
4337
4338                 let anchor_outputs_value_msat = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
4339                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
4340                 } else {
4341                         0
4342                 };
4343                 if self.context.is_outbound() {
4344                         // Check that they won't violate our local required channel reserve by adding this HTLC.
4345                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
4346                         let local_commit_tx_fee_msat = self.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
4347                         if self.context.value_to_self_msat < self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat + anchor_outputs_value_msat {
4348                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
4349                         }
4350                 }
4351                 if self.context.next_counterparty_htlc_id != msg.htlc_id {
4352                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.context.next_counterparty_htlc_id)));
4353                 }
4354                 if msg.cltv_expiry >= 500000000 {
4355                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
4356                 }
4357
4358                 if self.context.channel_state.is_local_shutdown_sent() {
4359                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
4360                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
4361                         }
4362                 }
4363
4364                 // Now update local state:
4365                 self.context.next_counterparty_htlc_id += 1;
4366                 self.context.pending_inbound_htlcs.push(InboundHTLCOutput {
4367                         htlc_id: msg.htlc_id,
4368                         amount_msat: msg.amount_msat,
4369                         payment_hash: msg.payment_hash,
4370                         cltv_expiry: msg.cltv_expiry,
4371                         state: InboundHTLCState::RemoteAnnounced(InboundHTLCResolution::Resolved {
4372                                 pending_htlc_status: pending_forward_status
4373                         }),
4374                 });
4375                 Ok(())
4376         }
4377
4378         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
4379         #[inline]
4380         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentPreimage>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
4381                 assert!(!(check_preimage.is_some() && fail_reason.is_some()), "cannot fail while we have a preimage");
4382                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
4383                         if htlc.htlc_id == htlc_id {
4384                                 let outcome = match check_preimage {
4385                                         None => fail_reason.into(),
4386                                         Some(payment_preimage) => {
4387                                                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
4388                                                 if payment_hash != htlc.payment_hash {
4389                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
4390                                                 }
4391                                                 OutboundHTLCOutcome::Success(Some(payment_preimage))
4392                                         }
4393                                 };
4394                                 match htlc.state {
4395                                         OutboundHTLCState::LocalAnnounced(_) =>
4396                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
4397                                         OutboundHTLCState::Committed => {
4398                                                 htlc.state = OutboundHTLCState::RemoteRemoved(outcome);
4399                                         },
4400                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
4401                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
4402                                 }
4403                                 return Ok(htlc);
4404                         }
4405                 }
4406                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
4407         }
4408
4409         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64, Option<u64>), ChannelError> {
4410                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4411                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
4412                 }
4413                 if self.context.channel_state.is_peer_disconnected() {
4414                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
4415                 }
4416
4417                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(msg.payment_preimage), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat, htlc.skimmed_fee_msat))
4418         }
4419
4420         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
4421                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4422                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
4423                 }
4424                 if self.context.channel_state.is_peer_disconnected() {
4425                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
4426                 }
4427
4428                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
4429                 Ok(())
4430         }
4431
4432         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
4433                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4434                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
4435                 }
4436                 if self.context.channel_state.is_peer_disconnected() {
4437                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
4438                 }
4439
4440                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
4441                 Ok(())
4442         }
4443
4444         pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<Option<ChannelMonitorUpdate>, ChannelError>
4445                 where L::Target: Logger
4446         {
4447                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4448                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned()));
4449                 }
4450                 if self.context.channel_state.is_peer_disconnected() {
4451                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned()));
4452                 }
4453                 if self.context.channel_state.is_both_sides_shutdown() && self.context.last_sent_closing_fee.is_some() {
4454                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned()));
4455                 }
4456
4457                 let funding_script = self.context.get_funding_redeemscript();
4458
4459                 let keys = self.context.build_holder_transaction_keys(self.context.holder_commitment_point.transaction_number());
4460
4461                 let commitment_stats = self.context.build_commitment_transaction(self.context.holder_commitment_point.transaction_number(), &keys, true, false, logger);
4462                 let commitment_txid = {
4463                         let trusted_tx = commitment_stats.tx.trust();
4464                         let bitcoin_tx = trusted_tx.built_transaction();
4465                         let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
4466
4467                         log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
4468                                 log_bytes!(msg.signature.serialize_compact()[..]),
4469                                 log_bytes!(self.context.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
4470                                 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), &self.context.channel_id());
4471                         if let Err(_) = self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.counterparty_funding_pubkey()) {
4472                                 return Err(ChannelError::Close("Invalid commitment tx signature from peer".to_owned()));
4473                         }
4474                         bitcoin_tx.txid
4475                 };
4476                 let mut htlcs_cloned: Vec<_> = commitment_stats.htlcs_included.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
4477
4478                 // If our counterparty updated the channel fee in this commitment transaction, check that
4479                 // they can actually afford the new fee now.
4480                 let update_fee = if let Some((_, update_state)) = self.context.pending_update_fee {
4481                         update_state == FeeUpdateState::RemoteAnnounced
4482                 } else { false };
4483                 if update_fee {
4484                         debug_assert!(!self.context.is_outbound());
4485                         let counterparty_reserve_we_require_msat = self.context.holder_selected_channel_reserve_satoshis * 1000;
4486                         if commitment_stats.remote_balance_msat < commitment_stats.total_fee_sat * 1000 + counterparty_reserve_we_require_msat {
4487                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned()));
4488                         }
4489                 }
4490                 #[cfg(any(test, fuzzing))]
4491                 {
4492                         if self.context.is_outbound() {
4493                                 let projected_commit_tx_info = self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
4494                                 *self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
4495                                 if let Some(info) = projected_commit_tx_info {
4496                                         let total_pending_htlcs = self.context.pending_inbound_htlcs.len() + self.context.pending_outbound_htlcs.len()
4497                                                 + self.context.holding_cell_htlc_updates.len();
4498                                         if info.total_pending_htlcs == total_pending_htlcs
4499                                                 && info.next_holder_htlc_id == self.context.next_holder_htlc_id
4500                                                 && info.next_counterparty_htlc_id == self.context.next_counterparty_htlc_id
4501                                                 && info.feerate == self.context.feerate_per_kw {
4502                                                         assert_eq!(commitment_stats.total_fee_sat, info.fee / 1000);
4503                                                 }
4504                                 }
4505                         }
4506                 }
4507
4508                 if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
4509                         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)));
4510                 }
4511
4512                 // Up to LDK 0.0.115, HTLC information was required to be duplicated in the
4513                 // `htlcs_and_sigs` vec and in the `holder_commitment_tx` itself, both of which were passed
4514                 // in the `ChannelMonitorUpdate`. In 0.0.115, support for having a separate set of
4515                 // outbound-non-dust-HTLCSources in the `ChannelMonitorUpdate` was added, however for
4516                 // backwards compatibility, we never use it in production. To provide test coverage, here,
4517                 // we randomly decide (in test/fuzzing builds) to use the new vec sometimes.
4518                 #[allow(unused_assignments, unused_mut)]
4519                 let mut separate_nondust_htlc_sources = false;
4520                 #[cfg(all(feature = "std", any(test, fuzzing)))] {
4521                         use core::hash::{BuildHasher, Hasher};
4522                         // Get a random value using the only std API to do so - the DefaultHasher
4523                         let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
4524                         separate_nondust_htlc_sources = rand_val % 2 == 0;
4525                 }
4526
4527                 let mut nondust_htlc_sources = Vec::with_capacity(htlcs_cloned.len());
4528                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
4529                 for (idx, (htlc, mut source_opt)) in htlcs_cloned.drain(..).enumerate() {
4530                         if let Some(_) = htlc.transaction_output_index {
4531                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_stats.feerate_per_kw,
4532                                         self.context.get_counterparty_selected_contest_delay().unwrap(), &htlc, &self.context.channel_type,
4533                                         &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
4534
4535                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &self.context.channel_type, &keys);
4536                                 let htlc_sighashtype = if self.context.channel_type.supports_anchors_zero_fee_htlc_tx() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
4537                                 let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
4538                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
4539                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.to_public_key().serialize()),
4540                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), &self.context.channel_id());
4541                                 if let Err(_) = self.context.secp_ctx.verify_ecdsa(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key.to_public_key()) {
4542                                         return Err(ChannelError::Close("Invalid HTLC tx signature from peer".to_owned()));
4543                                 }
4544                                 if !separate_nondust_htlc_sources {
4545                                         htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source_opt.take()));
4546                                 }
4547                         } else {
4548                                 htlcs_and_sigs.push((htlc, None, source_opt.take()));
4549                         }
4550                         if separate_nondust_htlc_sources {
4551                                 if let Some(source) = source_opt.take() {
4552                                         nondust_htlc_sources.push(source);
4553                                 }
4554                         }
4555                         debug_assert!(source_opt.is_none(), "HTLCSource should have been put somewhere");
4556                 }
4557
4558                 let holder_commitment_tx = HolderCommitmentTransaction::new(
4559                         commitment_stats.tx,
4560                         msg.signature,
4561                         msg.htlc_signatures.clone(),
4562                         &self.context.get_holder_pubkeys().funding_pubkey,
4563                         self.context.counterparty_funding_pubkey()
4564                 );
4565
4566                 self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, commitment_stats.outbound_htlc_preimages)
4567                         .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
4568
4569                 // Update state now that we've passed all the can-fail calls...
4570                 let mut need_commitment = false;
4571                 if let &mut Some((_, ref mut update_state)) = &mut self.context.pending_update_fee {
4572                         if *update_state == FeeUpdateState::RemoteAnnounced {
4573                                 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
4574                                 need_commitment = true;
4575                         }
4576                 }
4577
4578                 for htlc in self.context.pending_inbound_htlcs.iter_mut() {
4579                         let htlc_resolution = if let &InboundHTLCState::RemoteAnnounced(ref resolution) = &htlc.state {
4580                                 Some(resolution.clone())
4581                         } else { None };
4582                         if let Some(htlc_resolution) = htlc_resolution {
4583                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
4584                                         &htlc.payment_hash, &self.context.channel_id);
4585                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(htlc_resolution);
4586                                 need_commitment = true;
4587                         }
4588                 }
4589                 let mut claimed_htlcs = Vec::new();
4590                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
4591                         if let &mut OutboundHTLCState::RemoteRemoved(ref mut outcome) = &mut htlc.state {
4592                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
4593                                         &htlc.payment_hash, &self.context.channel_id);
4594                                 // Grab the preimage, if it exists, instead of cloning
4595                                 let mut reason = OutboundHTLCOutcome::Success(None);
4596                                 mem::swap(outcome, &mut reason);
4597                                 if let OutboundHTLCOutcome::Success(Some(preimage)) = reason {
4598                                         // If a user (a) receives an HTLC claim using LDK 0.0.104 or before, then (b)
4599                                         // upgrades to LDK 0.0.114 or later before the HTLC is fully resolved, we could
4600                                         // have a `Success(None)` reason. In this case we could forget some HTLC
4601                                         // claims, but such an upgrade is unlikely and including claimed HTLCs here
4602                                         // fixes a bug which the user was exposed to on 0.0.104 when they started the
4603                                         // claim anyway.
4604                                         claimed_htlcs.push((SentHTLCId::from_source(&htlc.source), preimage));
4605                                 }
4606                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(reason);
4607                                 need_commitment = true;
4608                         }
4609                 }
4610
4611                 self.context.latest_monitor_update_id += 1;
4612                 let mut monitor_update = ChannelMonitorUpdate {
4613                         update_id: self.context.latest_monitor_update_id,
4614                         counterparty_node_id: Some(self.context.counterparty_node_id),
4615                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
4616                                 commitment_tx: holder_commitment_tx,
4617                                 htlc_outputs: htlcs_and_sigs,
4618                                 claimed_htlcs,
4619                                 nondust_htlc_sources,
4620                         }],
4621                         channel_id: Some(self.context.channel_id()),
4622                 };
4623
4624                 self.context.holder_commitment_point.advance(&self.context.holder_signer, &self.context.secp_ctx, logger);
4625                 self.context.expecting_peer_commitment_signed = false;
4626                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
4627                 // build_commitment_no_status_check() next which will reset this to RAAFirst.
4628                 self.context.resend_order = RAACommitmentOrder::CommitmentFirst;
4629
4630                 if self.context.channel_state.is_monitor_update_in_progress() {
4631                         // In case we initially failed monitor updating without requiring a response, we need
4632                         // to make sure the RAA gets sent first.
4633                         self.context.monitor_pending_revoke_and_ack = true;
4634                         if need_commitment && !self.context.channel_state.is_awaiting_remote_revoke() {
4635                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
4636                                 // the corresponding HTLC status updates so that
4637                                 // get_last_commitment_update_for_send includes the right HTLCs.
4638                                 self.context.monitor_pending_commitment_signed = true;
4639                                 let mut additional_update = self.build_commitment_no_status_check(logger);
4640                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
4641                                 // strictly increasing by one, so decrement it here.
4642                                 self.context.latest_monitor_update_id = monitor_update.update_id;
4643                                 monitor_update.updates.append(&mut additional_update.updates);
4644                         }
4645                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
4646                                 &self.context.channel_id);
4647                         return Ok(self.push_ret_blockable_mon_update(monitor_update));
4648                 }
4649
4650                 let need_commitment_signed = if need_commitment && !self.context.channel_state.is_awaiting_remote_revoke() {
4651                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
4652                         // we'll send one right away when we get the revoke_and_ack when we
4653                         // free_holding_cell_htlcs().
4654                         let mut additional_update = self.build_commitment_no_status_check(logger);
4655                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
4656                         // strictly increasing by one, so decrement it here.
4657                         self.context.latest_monitor_update_id = monitor_update.update_id;
4658                         monitor_update.updates.append(&mut additional_update.updates);
4659                         true
4660                 } else { false };
4661
4662                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
4663                         &self.context.channel_id(), if need_commitment_signed { " our own commitment_signed and" } else { "" });
4664                 self.monitor_updating_paused(true, need_commitment_signed, false, Vec::new(), Vec::new(), Vec::new());
4665                 return Ok(self.push_ret_blockable_mon_update(monitor_update));
4666         }
4667
4668         /// Public version of the below, checking relevant preconditions first.
4669         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
4670         /// returns `(None, Vec::new())`.
4671         pub fn maybe_free_holding_cell_htlcs<F: Deref, L: Deref>(
4672                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
4673         ) -> (Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>)
4674         where F::Target: FeeEstimator, L::Target: Logger
4675         {
4676                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) && self.context.channel_state.can_generate_new_commitment() {
4677                         self.free_holding_cell_htlcs(fee_estimator, logger)
4678                 } else { (None, Vec::new()) }
4679         }
4680
4681         /// Frees any pending commitment updates in the holding cell, generating the relevant messages
4682         /// for our counterparty.
4683         fn free_holding_cell_htlcs<F: Deref, L: Deref>(
4684                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
4685         ) -> (Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>)
4686         where F::Target: FeeEstimator, L::Target: Logger
4687         {
4688                 assert!(!self.context.channel_state.is_monitor_update_in_progress());
4689                 if self.context.holding_cell_htlc_updates.len() != 0 || self.context.holding_cell_update_fee.is_some() {
4690                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.context.holding_cell_htlc_updates.len(),
4691                                 if self.context.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, &self.context.channel_id());
4692
4693                         let mut monitor_update = ChannelMonitorUpdate {
4694                                 update_id: self.context.latest_monitor_update_id + 1, // We don't increment this yet!
4695                                 counterparty_node_id: Some(self.context.counterparty_node_id),
4696                                 updates: Vec::new(),
4697                                 channel_id: Some(self.context.channel_id()),
4698                         };
4699
4700                         let mut htlc_updates = Vec::new();
4701                         mem::swap(&mut htlc_updates, &mut self.context.holding_cell_htlc_updates);
4702                         let mut update_add_count = 0;
4703                         let mut update_fulfill_count = 0;
4704                         let mut update_fail_count = 0;
4705                         let mut htlcs_to_fail = Vec::new();
4706                         for htlc_update in htlc_updates.drain(..) {
4707                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
4708                                 // fee races with adding too many outputs which push our total payments just over
4709                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
4710                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
4711                                 // to rebalance channels.
4712                                 let fail_htlc_res = match &htlc_update {
4713                                         &HTLCUpdateAwaitingACK::AddHTLC {
4714                                                 amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
4715                                                 skimmed_fee_msat, blinding_point, ..
4716                                         } => {
4717                                                 match self.send_htlc(
4718                                                         amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone(),
4719                                                         false, skimmed_fee_msat, blinding_point, fee_estimator, logger
4720                                                 ) {
4721                                                         Ok(_) => update_add_count += 1,
4722                                                         Err(e) => {
4723                                                                 match e {
4724                                                                         ChannelError::Ignore(ref msg) => {
4725                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}", &payment_hash, msg, &self.context.channel_id());
4726                                                                                 // If we fail to send here, then this HTLC should
4727                                                                                 // be failed backwards. Failing to send here
4728                                                                                 // indicates that this HTLC may keep being put back
4729                                                                                 // into the holding cell without ever being
4730                                                                                 // successfully forwarded/failed/fulfilled, causing
4731                                                                                 // our counterparty to eventually close on us.
4732                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
4733                                                                         },
4734                                                                         _ => {
4735                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
4736                                                                         },
4737                                                                 }
4738                                                         }
4739                                                 }
4740                                                 None
4741                                         },
4742                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
4743                                                 // If an HTLC claim was previously added to the holding cell (via
4744                                                 // `get_update_fulfill_htlc`, then generating the claim message itself must
4745                                                 // not fail - any in between attempts to claim the HTLC will have resulted
4746                                                 // in it hitting the holding cell again and we cannot change the state of a
4747                                                 // holding cell HTLC from fulfill to anything else.
4748                                                 let mut additional_monitor_update =
4749                                                         if let UpdateFulfillFetch::NewClaim { monitor_update, .. } =
4750                                                                 self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger)
4751                                                         { monitor_update } else { unreachable!() };
4752                                                 update_fulfill_count += 1;
4753                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
4754                                                 None
4755                                         },
4756                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
4757                                                 Some(self.fail_htlc(htlc_id, err_packet.clone(), false, logger)
4758                                                  .map(|fail_msg_opt| fail_msg_opt.map(|_| ())))
4759                                         },
4760                                         &HTLCUpdateAwaitingACK::FailMalformedHTLC { htlc_id, failure_code, sha256_of_onion } => {
4761                                                 Some(self.fail_htlc(htlc_id, (sha256_of_onion, failure_code), false, logger)
4762                                                  .map(|fail_msg_opt| fail_msg_opt.map(|_| ())))
4763                                         }
4764                                 };
4765                                 if let Some(res) = fail_htlc_res {
4766                                         match res {
4767                                                 Ok(fail_msg_opt) => {
4768                                                         // If an HTLC failure was previously added to the holding cell (via
4769                                                         // `queue_fail_{malformed_}htlc`) then generating the fail message itself must
4770                                                         // not fail - we should never end up in a state where we double-fail
4771                                                         // an HTLC or fail-then-claim an HTLC as it indicates we didn't wait
4772                                                         // for a full revocation before failing.
4773                                                         debug_assert!(fail_msg_opt.is_some());
4774                                                         update_fail_count += 1;
4775                                                 },
4776                                                 Err(ChannelError::Ignore(_)) => {},
4777                                                 Err(_) => {
4778                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
4779                                                 },
4780                                         }
4781                                 }
4782                         }
4783                         if update_add_count == 0 && update_fulfill_count == 0 && update_fail_count == 0 && self.context.holding_cell_update_fee.is_none() {
4784                                 return (None, htlcs_to_fail);
4785                         }
4786                         let update_fee = if let Some(feerate) = self.context.holding_cell_update_fee.take() {
4787                                 self.send_update_fee(feerate, false, fee_estimator, logger)
4788                         } else {
4789                                 None
4790                         };
4791
4792                         let mut additional_update = self.build_commitment_no_status_check(logger);
4793                         // build_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
4794                         // but we want them to be strictly increasing by one, so reset it here.
4795                         self.context.latest_monitor_update_id = monitor_update.update_id;
4796                         monitor_update.updates.append(&mut additional_update.updates);
4797
4798                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
4799                                 &self.context.channel_id(), if update_fee.is_some() { "a fee update, " } else { "" },
4800                                 update_add_count, update_fulfill_count, update_fail_count);
4801
4802                         self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
4803                         (self.push_ret_blockable_mon_update(monitor_update), htlcs_to_fail)
4804                 } else {
4805                         (None, Vec::new())
4806                 }
4807         }
4808
4809         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
4810         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
4811         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
4812         /// generating an appropriate error *after* the channel state has been updated based on the
4813         /// revoke_and_ack message.
4814         pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK,
4815                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L, hold_mon_update: bool,
4816         ) -> Result<(Vec<(HTLCSource, PaymentHash)>, Option<ChannelMonitorUpdate>), ChannelError>
4817         where F::Target: FeeEstimator, L::Target: Logger,
4818         {
4819                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) {
4820                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
4821                 }
4822                 if self.context.channel_state.is_peer_disconnected() {
4823                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
4824                 }
4825                 if self.context.channel_state.is_both_sides_shutdown() && self.context.last_sent_closing_fee.is_some() {
4826                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
4827                 }
4828
4829                 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
4830
4831                 if let Some(counterparty_prev_commitment_point) = self.context.counterparty_prev_commitment_point {
4832                         if PublicKey::from_secret_key(&self.context.secp_ctx, &secret) != counterparty_prev_commitment_point {
4833                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
4834                         }
4835                 }
4836
4837                 if !self.context.channel_state.is_awaiting_remote_revoke() {
4838                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
4839                         // haven't given them a new commitment transaction to broadcast). We should probably
4840                         // take advantage of this by updating our channel monitor, sending them an error, and
4841                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
4842                         // lot of work, and there's some chance this is all a misunderstanding anyway.
4843                         // We have to do *something*, though, since our signer may get mad at us for otherwise
4844                         // jumping a remote commitment number, so best to just force-close and move on.
4845                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
4846                 }
4847
4848                 #[cfg(any(test, fuzzing))]
4849                 {
4850                         *self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4851                         *self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
4852                 }
4853
4854                 match &self.context.holder_signer {
4855                         ChannelSignerType::Ecdsa(ecdsa) => {
4856                                 ecdsa.validate_counterparty_revocation(
4857                                         self.context.cur_counterparty_commitment_transaction_number + 1,
4858                                         &secret
4859                                 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
4860                         },
4861                         // TODO (taproot|arik)
4862                         #[cfg(taproot)]
4863                         _ => todo!()
4864                 };
4865
4866                 self.context.commitment_secrets.provide_secret(self.context.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
4867                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
4868                 self.context.latest_monitor_update_id += 1;
4869                 let mut monitor_update = ChannelMonitorUpdate {
4870                         update_id: self.context.latest_monitor_update_id,
4871                         counterparty_node_id: Some(self.context.counterparty_node_id),
4872                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
4873                                 idx: self.context.cur_counterparty_commitment_transaction_number + 1,
4874                                 secret: msg.per_commitment_secret,
4875                         }],
4876                         channel_id: Some(self.context.channel_id()),
4877                 };
4878
4879                 // Update state now that we've passed all the can-fail calls...
4880                 // (note that we may still fail to generate the new commitment_signed message, but that's
4881                 // OK, we step the channel here and *then* if the new generation fails we can fail the
4882                 // channel based on that, but stepping stuff here should be safe either way.
4883                 self.context.channel_state.clear_awaiting_remote_revoke();
4884                 self.context.sent_message_awaiting_response = None;
4885                 self.context.counterparty_prev_commitment_point = self.context.counterparty_cur_commitment_point;
4886                 self.context.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
4887                 self.context.cur_counterparty_commitment_transaction_number -= 1;
4888
4889                 if self.context.announcement_sigs_state == AnnouncementSigsState::Committed {
4890                         self.context.announcement_sigs_state = AnnouncementSigsState::PeerReceived;
4891                 }
4892
4893                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", &self.context.channel_id());
4894                 let mut to_forward_infos = Vec::new();
4895                 let mut pending_update_adds = Vec::new();
4896                 let mut revoked_htlcs = Vec::new();
4897                 let mut finalized_claimed_htlcs = Vec::new();
4898                 let mut update_fail_htlcs = Vec::new();
4899                 let mut update_fail_malformed_htlcs = Vec::new();
4900                 let mut require_commitment = false;
4901                 let mut value_to_self_msat_diff: i64 = 0;
4902
4903                 {
4904                         // Take references explicitly so that we can hold multiple references to self.context.
4905                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.context.pending_inbound_htlcs;
4906                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.context.pending_outbound_htlcs;
4907                         let expecting_peer_commitment_signed = &mut self.context.expecting_peer_commitment_signed;
4908
4909                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
4910                         pending_inbound_htlcs.retain(|htlc| {
4911                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
4912                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", &htlc.payment_hash);
4913                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
4914                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
4915                                         }
4916                                         *expecting_peer_commitment_signed = true;
4917                                         false
4918                                 } else { true }
4919                         });
4920                         pending_outbound_htlcs.retain(|htlc| {
4921                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) = &htlc.state {
4922                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", &htlc.payment_hash);
4923                                         if let OutboundHTLCOutcome::Failure(reason) = outcome.clone() { // We really want take() here, but, again, non-mut ref :(
4924                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
4925                                         } else {
4926                                                 finalized_claimed_htlcs.push(htlc.source.clone());
4927                                                 // They fulfilled, so we sent them money
4928                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
4929                                         }
4930                                         false
4931                                 } else { true }
4932                         });
4933                         for htlc in pending_inbound_htlcs.iter_mut() {
4934                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
4935                                         true
4936                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
4937                                         true
4938                                 } else { false };
4939                                 if swap {
4940                                         let mut state = InboundHTLCState::Committed;
4941                                         mem::swap(&mut state, &mut htlc.state);
4942
4943                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(resolution) = state {
4944                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", &htlc.payment_hash);
4945                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution);
4946                                                 require_commitment = true;
4947                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution) = state {
4948                                                 match resolution {
4949                                                         InboundHTLCResolution::Resolved { pending_htlc_status } =>
4950                                                                 match pending_htlc_status {
4951                                                                         PendingHTLCStatus::Fail(fail_msg) => {
4952                                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", &htlc.payment_hash);
4953                                                                                 require_commitment = true;
4954                                                                                 match fail_msg {
4955                                                                                         HTLCFailureMsg::Relay(msg) => {
4956                                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
4957                                                                                                 update_fail_htlcs.push(msg)
4958                                                                                         },
4959                                                                                         HTLCFailureMsg::Malformed(msg) => {
4960                                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
4961                                                                                                 update_fail_malformed_htlcs.push(msg)
4962                                                                                         },
4963                                                                                 }
4964                                                                         },
4965                                                                         PendingHTLCStatus::Forward(forward_info) => {
4966                                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed, attempting to forward", &htlc.payment_hash);
4967                                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
4968                                                                                 htlc.state = InboundHTLCState::Committed;
4969                                                                         }
4970                                                                 }
4971                                                         InboundHTLCResolution::Pending { update_add_htlc } => {
4972                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", &htlc.payment_hash);
4973                                                                 pending_update_adds.push(update_add_htlc);
4974                                                                 htlc.state = InboundHTLCState::Committed;
4975                                                         }
4976                                                 }
4977                                         }
4978                                 }
4979                         }
4980                         for htlc in pending_outbound_htlcs.iter_mut() {
4981                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4982                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", &htlc.payment_hash);
4983                                         htlc.state = OutboundHTLCState::Committed;
4984                                         *expecting_peer_commitment_signed = true;
4985                                 }
4986                                 if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
4987                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", &htlc.payment_hash);
4988                                         // Grab the preimage, if it exists, instead of cloning
4989                                         let mut reason = OutboundHTLCOutcome::Success(None);
4990                                         mem::swap(outcome, &mut reason);
4991                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
4992                                         require_commitment = true;
4993                                 }
4994                         }
4995                 }
4996                 self.context.value_to_self_msat = (self.context.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
4997
4998                 if let Some((feerate, update_state)) = self.context.pending_update_fee {
4999                         match update_state {
5000                                 FeeUpdateState::Outbound => {
5001                                         debug_assert!(self.context.is_outbound());
5002                                         log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
5003                                         self.context.feerate_per_kw = feerate;
5004                                         self.context.pending_update_fee = None;
5005                                         self.context.expecting_peer_commitment_signed = true;
5006                                 },
5007                                 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.context.is_outbound()); },
5008                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
5009                                         debug_assert!(!self.context.is_outbound());
5010                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
5011                                         require_commitment = true;
5012                                         self.context.feerate_per_kw = feerate;
5013                                         self.context.pending_update_fee = None;
5014                                 },
5015                         }
5016                 }
5017
5018                 let release_monitor = self.context.blocked_monitor_updates.is_empty() && !hold_mon_update;
5019                 let release_state_str =
5020                         if hold_mon_update { "Holding" } else if release_monitor { "Releasing" } else { "Blocked" };
5021                 macro_rules! return_with_htlcs_to_fail {
5022                         ($htlcs_to_fail: expr) => {
5023                                 if !release_monitor {
5024                                         self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
5025                                                 update: monitor_update,
5026                                         });
5027                                         return Ok(($htlcs_to_fail, None));
5028                                 } else {
5029                                         return Ok(($htlcs_to_fail, Some(monitor_update)));
5030                                 }
5031                         }
5032                 }
5033
5034                 self.context.monitor_pending_update_adds.append(&mut pending_update_adds);
5035
5036                 if self.context.channel_state.is_monitor_update_in_progress() {
5037                         // We can't actually generate a new commitment transaction (incl by freeing holding
5038                         // cells) while we can't update the monitor, so we just return what we have.
5039                         if require_commitment {
5040                                 self.context.monitor_pending_commitment_signed = true;
5041                                 // When the monitor updating is restored we'll call
5042                                 // get_last_commitment_update_for_send(), which does not update state, but we're
5043                                 // definitely now awaiting a remote revoke before we can step forward any more, so
5044                                 // set it here.
5045                                 let mut additional_update = self.build_commitment_no_status_check(logger);
5046                                 // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
5047                                 // strictly increasing by one, so decrement it here.
5048                                 self.context.latest_monitor_update_id = monitor_update.update_id;
5049                                 monitor_update.updates.append(&mut additional_update.updates);
5050                         }
5051                         self.context.monitor_pending_forwards.append(&mut to_forward_infos);
5052                         self.context.monitor_pending_failures.append(&mut revoked_htlcs);
5053                         self.context.monitor_pending_finalized_fulfills.append(&mut finalized_claimed_htlcs);
5054                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", &self.context.channel_id());
5055                         return_with_htlcs_to_fail!(Vec::new());
5056                 }
5057
5058                 match self.free_holding_cell_htlcs(fee_estimator, logger) {
5059                         (Some(mut additional_update), htlcs_to_fail) => {
5060                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
5061                                 // strictly increasing by one, so decrement it here.
5062                                 self.context.latest_monitor_update_id = monitor_update.update_id;
5063                                 monitor_update.updates.append(&mut additional_update.updates);
5064
5065                                 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with holding cell HTLCs freed. {} monitor update.",
5066                                         &self.context.channel_id(), release_state_str);
5067
5068                                 self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
5069                                 return_with_htlcs_to_fail!(htlcs_to_fail);
5070                         },
5071                         (None, htlcs_to_fail) => {
5072                                 if require_commitment {
5073                                         let mut additional_update = self.build_commitment_no_status_check(logger);
5074
5075                                         // build_commitment_no_status_check may bump latest_monitor_id but we want them to be
5076                                         // strictly increasing by one, so decrement it here.
5077                                         self.context.latest_monitor_update_id = monitor_update.update_id;
5078                                         monitor_update.updates.append(&mut additional_update.updates);
5079
5080                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed. {} monitor update.",
5081                                                 &self.context.channel_id(),
5082                                                 update_fail_htlcs.len() + update_fail_malformed_htlcs.len(),
5083                                                 release_state_str);
5084
5085                                         self.monitor_updating_paused(false, true, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
5086                                         return_with_htlcs_to_fail!(htlcs_to_fail);
5087                                 } else {
5088                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary. {} monitor update.",
5089                                                 &self.context.channel_id(), release_state_str);
5090
5091                                         self.monitor_updating_paused(false, false, false, to_forward_infos, revoked_htlcs, finalized_claimed_htlcs);
5092                                         return_with_htlcs_to_fail!(htlcs_to_fail);
5093                                 }
5094                         }
5095                 }
5096         }
5097
5098         /// Queues up an outbound update fee by placing it in the holding cell. You should call
5099         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
5100         /// commitment update.
5101         pub fn queue_update_fee<F: Deref, L: Deref>(&mut self, feerate_per_kw: u32,
5102                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
5103         where F::Target: FeeEstimator, L::Target: Logger
5104         {
5105                 let msg_opt = self.send_update_fee(feerate_per_kw, true, fee_estimator, logger);
5106                 assert!(msg_opt.is_none(), "We forced holding cell?");
5107         }
5108
5109         /// Adds a pending update to this channel. See the doc for send_htlc for
5110         /// further details on the optionness of the return value.
5111         /// If our balance is too low to cover the cost of the next commitment transaction at the
5112         /// new feerate, the update is cancelled.
5113         ///
5114         /// You MUST call [`Self::send_commitment_no_state_update`] prior to any other calls on this
5115         /// [`Channel`] if `force_holding_cell` is false.
5116         fn send_update_fee<F: Deref, L: Deref>(
5117                 &mut self, feerate_per_kw: u32, mut force_holding_cell: bool,
5118                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
5119         ) -> Option<msgs::UpdateFee>
5120         where F::Target: FeeEstimator, L::Target: Logger
5121         {
5122                 if !self.context.is_outbound() {
5123                         panic!("Cannot send fee from inbound channel");
5124                 }
5125                 if !self.context.is_usable() {
5126                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
5127                 }
5128                 if !self.context.is_live() {
5129                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
5130                 }
5131
5132                 // Before proposing a feerate update, check that we can actually afford the new fee.
5133                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
5134                 let htlc_stats = self.context.get_pending_htlc_stats(Some(feerate_per_kw), dust_exposure_limiting_feerate);
5135                 let keys = self.context.build_holder_transaction_keys(self.context.holder_commitment_point.transaction_number());
5136                 let commitment_stats = self.context.build_commitment_transaction(self.context.holder_commitment_point.transaction_number(), &keys, true, true, logger);
5137                 let buffer_fee_msat = commit_tx_fee_sat(feerate_per_kw, commitment_stats.num_nondust_htlcs + htlc_stats.on_holder_tx_outbound_holding_cell_htlcs_count as usize + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as usize, self.context.get_channel_type()) * 1000;
5138                 let holder_balance_msat = commitment_stats.local_balance_msat - htlc_stats.outbound_holding_cell_msat;
5139                 if holder_balance_msat < buffer_fee_msat  + self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 {
5140                         //TODO: auto-close after a number of failures?
5141                         log_debug!(logger, "Cannot afford to send new feerate at {}", feerate_per_kw);
5142                         return None;
5143                 }
5144
5145                 // Note, we evaluate pending htlc "preemptive" trimmed-to-dust threshold at the proposed `feerate_per_kw`.
5146                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
5147                 if htlc_stats.on_holder_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5148                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
5149                         return None;
5150                 }
5151                 if htlc_stats.on_counterparty_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5152                         log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
5153                         return None;
5154                 }
5155
5156                 if self.context.channel_state.is_awaiting_remote_revoke() || self.context.channel_state.is_monitor_update_in_progress() {
5157                         force_holding_cell = true;
5158                 }
5159
5160                 if force_holding_cell {
5161                         self.context.holding_cell_update_fee = Some(feerate_per_kw);
5162                         return None;
5163                 }
5164
5165                 debug_assert!(self.context.pending_update_fee.is_none());
5166                 self.context.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
5167
5168                 Some(msgs::UpdateFee {
5169                         channel_id: self.context.channel_id,
5170                         feerate_per_kw,
5171                 })
5172         }
5173
5174         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
5175         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
5176         /// resent.
5177         /// No further message handling calls may be made until a channel_reestablish dance has
5178         /// completed.
5179         /// May return `Err(())`, which implies [`ChannelContext::force_shutdown`] should be called immediately.
5180         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Result<(), ()> where L::Target: Logger {
5181                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
5182                 if self.context.channel_state.is_pre_funded_state() {
5183                         return Err(())
5184                 }
5185
5186                 if self.context.channel_state.is_peer_disconnected() {
5187                         // While the below code should be idempotent, it's simpler to just return early, as
5188                         // redundant disconnect events can fire, though they should be rare.
5189                         return Ok(());
5190                 }
5191
5192                 if self.context.announcement_sigs_state == AnnouncementSigsState::MessageSent || self.context.announcement_sigs_state == AnnouncementSigsState::Committed {
5193                         self.context.announcement_sigs_state = AnnouncementSigsState::NotSent;
5194                 }
5195
5196                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
5197                 // will be retransmitted.
5198                 self.context.last_sent_closing_fee = None;
5199                 self.context.pending_counterparty_closing_signed = None;
5200                 self.context.closing_fee_limits = None;
5201
5202                 let mut inbound_drop_count = 0;
5203                 self.context.pending_inbound_htlcs.retain(|htlc| {
5204                         match htlc.state {
5205                                 InboundHTLCState::RemoteAnnounced(_) => {
5206                                         // They sent us an update_add_htlc but we never got the commitment_signed.
5207                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
5208                                         // this HTLC accordingly
5209                                         inbound_drop_count += 1;
5210                                         false
5211                                 },
5212                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
5213                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
5214                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
5215                                         // in response to it yet, so don't touch it.
5216                                         true
5217                                 },
5218                                 InboundHTLCState::Committed => true,
5219                                 InboundHTLCState::LocalRemoved(_) => {
5220                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
5221                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
5222                                         // (that we missed). Keep this around for now and if they tell us they missed
5223                                         // the commitment_signed we can re-transmit the update then.
5224                                         true
5225                                 },
5226                         }
5227                 });
5228                 self.context.next_counterparty_htlc_id -= inbound_drop_count;
5229
5230                 if let Some((_, update_state)) = self.context.pending_update_fee {
5231                         if update_state == FeeUpdateState::RemoteAnnounced {
5232                                 debug_assert!(!self.context.is_outbound());
5233                                 self.context.pending_update_fee = None;
5234                         }
5235                 }
5236
5237                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
5238                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
5239                                 // They sent us an update to remove this but haven't yet sent the corresponding
5240                                 // commitment_signed, we need to move it back to Committed and they can re-send
5241                                 // the update upon reconnection.
5242                                 htlc.state = OutboundHTLCState::Committed;
5243                         }
5244                 }
5245
5246                 self.context.sent_message_awaiting_response = None;
5247
5248                 self.context.channel_state.set_peer_disconnected();
5249                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, &self.context.channel_id());
5250                 Ok(())
5251         }
5252
5253         /// Indicates that a ChannelMonitor update is in progress and has not yet been fully persisted.
5254         /// This must be called before we return the [`ChannelMonitorUpdate`] back to the
5255         /// [`ChannelManager`], which will call [`Self::monitor_updating_restored`] once the monitor
5256         /// update completes (potentially immediately).
5257         /// The messages which were generated with the monitor update must *not* have been sent to the
5258         /// remote end, and must instead have been dropped. They will be regenerated when
5259         /// [`Self::monitor_updating_restored`] is called.
5260         ///
5261         /// [`ChannelManager`]: super::channelmanager::ChannelManager
5262         /// [`chain::Watch`]: crate::chain::Watch
5263         /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
5264         fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
5265                 resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
5266                 mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
5267                 mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
5268         ) {
5269                 self.context.monitor_pending_revoke_and_ack |= resend_raa;
5270                 self.context.monitor_pending_commitment_signed |= resend_commitment;
5271                 self.context.monitor_pending_channel_ready |= resend_channel_ready;
5272                 self.context.monitor_pending_forwards.append(&mut pending_forwards);
5273                 self.context.monitor_pending_failures.append(&mut pending_fails);
5274                 self.context.monitor_pending_finalized_fulfills.append(&mut pending_finalized_claimed_htlcs);
5275                 self.context.channel_state.set_monitor_update_in_progress();
5276         }
5277
5278         /// Indicates that the latest ChannelMonitor update has been committed by the client
5279         /// successfully and we should restore normal operation. Returns messages which should be sent
5280         /// to the remote side.
5281         pub fn monitor_updating_restored<L: Deref, NS: Deref>(
5282                 &mut self, logger: &L, node_signer: &NS, chain_hash: ChainHash,
5283                 user_config: &UserConfig, best_block_height: u32
5284         ) -> MonitorRestoreUpdates
5285         where
5286                 L::Target: Logger,
5287                 NS::Target: NodeSigner
5288         {
5289                 assert!(self.context.channel_state.is_monitor_update_in_progress());
5290                 self.context.channel_state.clear_monitor_update_in_progress();
5291
5292                 // If we're past (or at) the AwaitingChannelReady stage on an outbound channel, try to
5293                 // (re-)broadcast the funding transaction as we may have declined to broadcast it when we
5294                 // first received the funding_signed.
5295                 let mut funding_broadcastable =
5296                         if self.context.is_outbound() &&
5297                                 (matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(flags) if !flags.is_set(AwaitingChannelReadyFlags::WAITING_FOR_BATCH)) ||
5298                                 matches!(self.context.channel_state, ChannelState::ChannelReady(_)))
5299                         {
5300                                 self.context.funding_transaction.take()
5301                         } else { None };
5302                 // That said, if the funding transaction is already confirmed (ie we're active with a
5303                 // minimum_depth over 0) don't bother re-broadcasting the confirmed funding tx.
5304                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) && self.context.minimum_depth != Some(0) {
5305                         funding_broadcastable = None;
5306                 }
5307
5308                 // We will never broadcast the funding transaction when we're in MonitorUpdateInProgress
5309                 // (and we assume the user never directly broadcasts the funding transaction and waits for
5310                 // us to do it). Thus, we can only ever hit monitor_pending_channel_ready when we're
5311                 // * an inbound channel that failed to persist the monitor on funding_created and we got
5312                 //   the funding transaction confirmed before the monitor was persisted, or
5313                 // * a 0-conf channel and intended to send the channel_ready before any broadcast at all.
5314                 let channel_ready = if self.context.monitor_pending_channel_ready {
5315                         assert!(!self.context.is_outbound() || self.context.minimum_depth == Some(0),
5316                                 "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
5317                         self.context.monitor_pending_channel_ready = false;
5318                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
5319                         Some(msgs::ChannelReady {
5320                                 channel_id: self.context.channel_id(),
5321                                 next_per_commitment_point,
5322                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
5323                         })
5324                 } else { None };
5325
5326                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block_height, logger);
5327
5328                 let mut accepted_htlcs = Vec::new();
5329                 mem::swap(&mut accepted_htlcs, &mut self.context.monitor_pending_forwards);
5330                 let mut failed_htlcs = Vec::new();
5331                 mem::swap(&mut failed_htlcs, &mut self.context.monitor_pending_failures);
5332                 let mut finalized_claimed_htlcs = Vec::new();
5333                 mem::swap(&mut finalized_claimed_htlcs, &mut self.context.monitor_pending_finalized_fulfills);
5334                 let mut pending_update_adds = Vec::new();
5335                 mem::swap(&mut pending_update_adds, &mut self.context.monitor_pending_update_adds);
5336
5337                 if self.context.channel_state.is_peer_disconnected() {
5338                         self.context.monitor_pending_revoke_and_ack = false;
5339                         self.context.monitor_pending_commitment_signed = false;
5340                         return MonitorRestoreUpdates {
5341                                 raa: None, commitment_update: None, order: RAACommitmentOrder::RevokeAndACKFirst,
5342                                 accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, pending_update_adds,
5343                                 funding_broadcastable, channel_ready, announcement_sigs
5344                         };
5345                 }
5346
5347                 let raa = if self.context.monitor_pending_revoke_and_ack {
5348                         Some(self.get_last_revoke_and_ack())
5349                 } else { None };
5350                 let commitment_update = if self.context.monitor_pending_commitment_signed {
5351                         self.get_last_commitment_update_for_send(logger).ok()
5352                 } else { None };
5353                 if commitment_update.is_some() {
5354                         self.mark_awaiting_response();
5355                 }
5356
5357                 self.context.monitor_pending_revoke_and_ack = false;
5358                 self.context.monitor_pending_commitment_signed = false;
5359                 let order = self.context.resend_order.clone();
5360                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
5361                         &self.context.channel_id(), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
5362                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
5363                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
5364                 MonitorRestoreUpdates {
5365                         raa, commitment_update, order, accepted_htlcs, failed_htlcs, finalized_claimed_htlcs,
5366                         pending_update_adds, funding_broadcastable, channel_ready, announcement_sigs
5367                 }
5368         }
5369
5370         pub fn update_fee<F: Deref, L: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::UpdateFee, logger: &L) -> Result<(), ChannelError>
5371                 where F::Target: FeeEstimator, L::Target: Logger
5372         {
5373                 if self.context.is_outbound() {
5374                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
5375                 }
5376                 if self.context.channel_state.is_peer_disconnected() {
5377                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
5378                 }
5379                 Channel::<SP>::check_remote_fee(&self.context.channel_type, fee_estimator, msg.feerate_per_kw, Some(self.context.feerate_per_kw), logger)?;
5380
5381                 self.context.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
5382                 self.context.update_time_counter += 1;
5383                 // Check that we won't be pushed over our dust exposure limit by the feerate increase.
5384                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
5385                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
5386                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
5387                 if htlc_stats.on_holder_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5388                         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)",
5389                                 msg.feerate_per_kw, htlc_stats.on_holder_tx_dust_exposure_msat)));
5390                 }
5391                 if htlc_stats.on_counterparty_tx_dust_exposure_msat > max_dust_htlc_exposure_msat {
5392                         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)",
5393                                 msg.feerate_per_kw, htlc_stats.on_counterparty_tx_dust_exposure_msat)));
5394                 }
5395                 Ok(())
5396         }
5397
5398         /// Indicates that the signer may have some signatures for us, so we should retry if we're
5399         /// blocked.
5400         #[cfg(async_signing)]
5401         pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> SignerResumeUpdates where L::Target: Logger {
5402                 let commitment_update = if self.context.signer_pending_commitment_update {
5403                         self.get_last_commitment_update_for_send(logger).ok()
5404                 } else { None };
5405                 let funding_signed = if self.context.signer_pending_funding && !self.context.is_outbound() {
5406                         self.context.get_funding_signed_msg(logger).1
5407                 } else { None };
5408                 let channel_ready = if funding_signed.is_some() {
5409                         self.check_get_channel_ready(0)
5410                 } else { None };
5411
5412                 log_trace!(logger, "Signer unblocked with {} commitment_update, {} funding_signed and {} channel_ready",
5413                         if commitment_update.is_some() { "a" } else { "no" },
5414                         if funding_signed.is_some() { "a" } else { "no" },
5415                         if channel_ready.is_some() { "a" } else { "no" });
5416
5417                 SignerResumeUpdates {
5418                         commitment_update,
5419                         funding_signed,
5420                         channel_ready,
5421                 }
5422         }
5423
5424         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
5425                 let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
5426                 let per_commitment_secret = self.context.holder_signer.as_ref().release_commitment_secret(self.context.holder_commitment_point.transaction_number() + 2);
5427                 msgs::RevokeAndACK {
5428                         channel_id: self.context.channel_id,
5429                         per_commitment_secret,
5430                         next_per_commitment_point,
5431                         #[cfg(taproot)]
5432                         next_local_nonce: None,
5433                 }
5434         }
5435
5436         /// Gets the last commitment update for immediate sending to our peer.
5437         fn get_last_commitment_update_for_send<L: Deref>(&mut self, logger: &L) -> Result<msgs::CommitmentUpdate, ()> where L::Target: Logger {
5438                 let mut update_add_htlcs = Vec::new();
5439                 let mut update_fulfill_htlcs = Vec::new();
5440                 let mut update_fail_htlcs = Vec::new();
5441                 let mut update_fail_malformed_htlcs = Vec::new();
5442
5443                 for htlc in self.context.pending_outbound_htlcs.iter() {
5444                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
5445                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
5446                                         channel_id: self.context.channel_id(),
5447                                         htlc_id: htlc.htlc_id,
5448                                         amount_msat: htlc.amount_msat,
5449                                         payment_hash: htlc.payment_hash,
5450                                         cltv_expiry: htlc.cltv_expiry,
5451                                         onion_routing_packet: (**onion_packet).clone(),
5452                                         skimmed_fee_msat: htlc.skimmed_fee_msat,
5453                                         blinding_point: htlc.blinding_point,
5454                                 });
5455                         }
5456                 }
5457
5458                 for htlc in self.context.pending_inbound_htlcs.iter() {
5459                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
5460                                 match reason {
5461                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
5462                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
5463                                                         channel_id: self.context.channel_id(),
5464                                                         htlc_id: htlc.htlc_id,
5465                                                         reason: err_packet.clone()
5466                                                 });
5467                                         },
5468                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
5469                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
5470                                                         channel_id: self.context.channel_id(),
5471                                                         htlc_id: htlc.htlc_id,
5472                                                         sha256_of_onion: sha256_of_onion.clone(),
5473                                                         failure_code: failure_code.clone(),
5474                                                 });
5475                                         },
5476                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
5477                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
5478                                                         channel_id: self.context.channel_id(),
5479                                                         htlc_id: htlc.htlc_id,
5480                                                         payment_preimage: payment_preimage.clone(),
5481                                                 });
5482                                         },
5483                                 }
5484                         }
5485                 }
5486
5487                 let update_fee = if self.context.is_outbound() && self.context.pending_update_fee.is_some() {
5488                         Some(msgs::UpdateFee {
5489                                 channel_id: self.context.channel_id(),
5490                                 feerate_per_kw: self.context.pending_update_fee.unwrap().0,
5491                         })
5492                 } else { None };
5493
5494                 log_trace!(logger, "Regenerating latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
5495                                 &self.context.channel_id(), if update_fee.is_some() { " update_fee," } else { "" },
5496                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
5497                 let commitment_signed = if let Ok(update) = self.send_commitment_no_state_update(logger).map(|(cu, _)| cu) {
5498                         if self.context.signer_pending_commitment_update {
5499                                 log_trace!(logger, "Commitment update generated: clearing signer_pending_commitment_update");
5500                                 self.context.signer_pending_commitment_update = false;
5501                         }
5502                         update
5503                 } else {
5504                         #[cfg(not(async_signing))] {
5505                                 panic!("Failed to get signature for new commitment state");
5506                         }
5507                         #[cfg(async_signing)] {
5508                                 if !self.context.signer_pending_commitment_update {
5509                                         log_trace!(logger, "Commitment update awaiting signer: setting signer_pending_commitment_update");
5510                                         self.context.signer_pending_commitment_update = true;
5511                                 }
5512                                 return Err(());
5513                         }
5514                 };
5515                 Ok(msgs::CommitmentUpdate {
5516                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
5517                         commitment_signed,
5518                 })
5519         }
5520
5521         /// Gets the `Shutdown` message we should send our peer on reconnect, if any.
5522         pub fn get_outbound_shutdown(&self) -> Option<msgs::Shutdown> {
5523                 if self.context.channel_state.is_local_shutdown_sent() {
5524                         assert!(self.context.shutdown_scriptpubkey.is_some());
5525                         Some(msgs::Shutdown {
5526                                 channel_id: self.context.channel_id,
5527                                 scriptpubkey: self.get_closing_scriptpubkey(),
5528                         })
5529                 } else { None }
5530         }
5531
5532         /// May panic if some calls other than message-handling calls (which will all Err immediately)
5533         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
5534         ///
5535         /// Some links printed in log lines are included here to check them during build (when run with
5536         /// `cargo doc --document-private-items`):
5537         /// [`super::channelmanager::ChannelManager::force_close_without_broadcasting_txn`] and
5538         /// [`super::channelmanager::ChannelManager::force_close_all_channels_without_broadcasting_txn`].
5539         pub fn channel_reestablish<L: Deref, NS: Deref>(
5540                 &mut self, msg: &msgs::ChannelReestablish, logger: &L, node_signer: &NS,
5541                 chain_hash: ChainHash, user_config: &UserConfig, best_block: &BestBlock
5542         ) -> Result<ReestablishResponses, ChannelError>
5543         where
5544                 L::Target: Logger,
5545                 NS::Target: NodeSigner
5546         {
5547                 if !self.context.channel_state.is_peer_disconnected() {
5548                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
5549                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
5550                         // just close here instead of trying to recover.
5551                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
5552                 }
5553
5554                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
5555                         msg.next_local_commitment_number == 0 {
5556                         return Err(ChannelError::Close("Peer sent an invalid channel_reestablish to force close in a non-standard way".to_owned()));
5557                 }
5558
5559                 let our_commitment_transaction = INITIAL_COMMITMENT_NUMBER - self.context.holder_commitment_point.transaction_number() - 1;
5560                 if msg.next_remote_commitment_number > 0 {
5561                         let expected_point = self.context.holder_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.context.secp_ctx);
5562                         let given_secret = SecretKey::from_slice(&msg.your_last_per_commitment_secret)
5563                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
5564                         if expected_point != PublicKey::from_secret_key(&self.context.secp_ctx, &given_secret) {
5565                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
5566                         }
5567                         if msg.next_remote_commitment_number > our_commitment_transaction {
5568                                 macro_rules! log_and_panic {
5569                                         ($err_msg: expr) => {
5570                                                 log_error!(logger, $err_msg, &self.context.channel_id, log_pubkey!(self.context.counterparty_node_id));
5571                                                 panic!($err_msg, &self.context.channel_id, log_pubkey!(self.context.counterparty_node_id));
5572                                         }
5573                                 }
5574                                 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\
5575                                         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\
5576                                         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\
5577                                         If you have restored from an old backup and wish to force-close channels and return to operation, you should start up, call\n\
5578                                         ChannelManager::force_close_without_broadcasting_txn on channel {} with counterparty {} or\n\
5579                                         ChannelManager::force_close_all_channels_without_broadcasting_txn, then reconnect to peer(s).\n\
5580                                         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\
5581                                         See https://github.com/lightningdevkit/rust-lightning/issues/1565 for more info.");
5582                         }
5583                 }
5584
5585                 // Before we change the state of the channel, we check if the peer is sending a very old
5586                 // commitment transaction number, if yes we send a warning message.
5587                 if msg.next_remote_commitment_number + 1 < our_commitment_transaction {
5588                         return Err(ChannelError::Warn(format!(
5589                                 "Peer attempted to reestablish channel with a very old local commitment transaction: {} (received) vs {} (expected)",
5590                                 msg.next_remote_commitment_number,
5591                                 our_commitment_transaction
5592                         )));
5593                 }
5594
5595                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
5596                 // remaining cases either succeed or ErrorMessage-fail).
5597                 self.context.channel_state.clear_peer_disconnected();
5598                 self.context.sent_message_awaiting_response = None;
5599
5600                 let shutdown_msg = self.get_outbound_shutdown();
5601
5602                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, best_block.height, logger);
5603
5604                 if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(_)) {
5605                         // If we're waiting on a monitor update, we shouldn't re-send any channel_ready's.
5606                         if !self.context.channel_state.is_our_channel_ready() ||
5607                                         self.context.channel_state.is_monitor_update_in_progress() {
5608                                 if msg.next_remote_commitment_number != 0 {
5609                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent channel_ready yet".to_owned()));
5610                                 }
5611                                 // Short circuit the whole handler as there is nothing we can resend them
5612                                 return Ok(ReestablishResponses {
5613                                         channel_ready: None,
5614                                         raa: None, commitment_update: None,
5615                                         order: RAACommitmentOrder::CommitmentFirst,
5616                                         shutdown_msg, announcement_sigs,
5617                                 });
5618                         }
5619
5620                         // We have OurChannelReady set!
5621                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
5622                         return Ok(ReestablishResponses {
5623                                 channel_ready: Some(msgs::ChannelReady {
5624                                         channel_id: self.context.channel_id(),
5625                                         next_per_commitment_point,
5626                                         short_channel_id_alias: Some(self.context.outbound_scid_alias),
5627                                 }),
5628                                 raa: None, commitment_update: None,
5629                                 order: RAACommitmentOrder::CommitmentFirst,
5630                                 shutdown_msg, announcement_sigs,
5631                         });
5632                 }
5633
5634                 let required_revoke = if msg.next_remote_commitment_number == our_commitment_transaction {
5635                         // Remote isn't waiting on any RevokeAndACK from us!
5636                         // Note that if we need to repeat our ChannelReady we'll do that in the next if block.
5637                         None
5638                 } else if msg.next_remote_commitment_number + 1 == our_commitment_transaction {
5639                         if self.context.channel_state.is_monitor_update_in_progress() {
5640                                 self.context.monitor_pending_revoke_and_ack = true;
5641                                 None
5642                         } else {
5643                                 Some(self.get_last_revoke_and_ack())
5644                         }
5645                 } else {
5646                         debug_assert!(false, "All values should have been handled in the four cases above");
5647                         return Err(ChannelError::Close(format!(
5648                                 "Peer attempted to reestablish channel expecting a future local commitment transaction: {} (received) vs {} (expected)",
5649                                 msg.next_remote_commitment_number,
5650                                 our_commitment_transaction
5651                         )));
5652                 };
5653
5654                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
5655                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
5656                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
5657                 // the corresponding revoke_and_ack back yet.
5658                 let is_awaiting_remote_revoke = self.context.channel_state.is_awaiting_remote_revoke();
5659                 if is_awaiting_remote_revoke && !self.is_awaiting_monitor_update() {
5660                         self.mark_awaiting_response();
5661                 }
5662                 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.context.cur_counterparty_commitment_transaction_number + if is_awaiting_remote_revoke { 1 } else { 0 };
5663
5664                 let channel_ready = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.context.holder_commitment_point.transaction_number() == 1 {
5665                         // We should never have to worry about MonitorUpdateInProgress resending ChannelReady
5666                         let next_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
5667                         Some(msgs::ChannelReady {
5668                                 channel_id: self.context.channel_id(),
5669                                 next_per_commitment_point,
5670                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
5671                         })
5672                 } else { None };
5673
5674                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
5675                         if required_revoke.is_some() {
5676                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", &self.context.channel_id());
5677                         } else {
5678                                 log_debug!(logger, "Reconnected channel {} with no loss", &self.context.channel_id());
5679                         }
5680
5681                         Ok(ReestablishResponses {
5682                                 channel_ready, shutdown_msg, announcement_sigs,
5683                                 raa: required_revoke,
5684                                 commitment_update: None,
5685                                 order: self.context.resend_order.clone(),
5686                         })
5687                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
5688                         if required_revoke.is_some() {
5689                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", &self.context.channel_id());
5690                         } else {
5691                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", &self.context.channel_id());
5692                         }
5693
5694                         if self.context.channel_state.is_monitor_update_in_progress() {
5695                                 self.context.monitor_pending_commitment_signed = true;
5696                                 Ok(ReestablishResponses {
5697                                         channel_ready, shutdown_msg, announcement_sigs,
5698                                         commitment_update: None, raa: None,
5699                                         order: self.context.resend_order.clone(),
5700                                 })
5701                         } else {
5702                                 Ok(ReestablishResponses {
5703                                         channel_ready, shutdown_msg, announcement_sigs,
5704                                         raa: required_revoke,
5705                                         commitment_update: self.get_last_commitment_update_for_send(logger).ok(),
5706                                         order: self.context.resend_order.clone(),
5707                                 })
5708                         }
5709                 } else if msg.next_local_commitment_number < next_counterparty_commitment_number {
5710                         Err(ChannelError::Close(format!(
5711                                 "Peer attempted to reestablish channel with a very old remote commitment transaction: {} (received) vs {} (expected)",
5712                                 msg.next_local_commitment_number,
5713                                 next_counterparty_commitment_number,
5714                         )))
5715                 } else {
5716                         Err(ChannelError::Close(format!(
5717                                 "Peer attempted to reestablish channel with a future remote commitment transaction: {} (received) vs {} (expected)",
5718                                 msg.next_local_commitment_number,
5719                                 next_counterparty_commitment_number,
5720                         )))
5721                 }
5722         }
5723
5724         /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
5725         /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
5726         /// at which point they will be recalculated.
5727         fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &LowerBoundedFeeEstimator<F>)
5728                 -> (u64, u64)
5729                 where F::Target: FeeEstimator
5730         {
5731                 if let Some((min, max)) = self.context.closing_fee_limits { return (min, max); }
5732
5733                 // Propose a range from our current Background feerate to our Normal feerate plus our
5734                 // force_close_avoidance_max_fee_satoshis.
5735                 // If we fail to come to consensus, we'll have to force-close.
5736                 let mut proposed_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::ChannelCloseMinimum);
5737                 // Use NonAnchorChannelFee because this should be an estimate for a channel close
5738                 // that we don't expect to need fee bumping
5739                 let normal_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::NonAnchorChannelFee);
5740                 let mut proposed_max_feerate = if self.context.is_outbound() { normal_feerate } else { u32::max_value() };
5741
5742                 // The spec requires that (when the channel does not have anchors) we only send absolute
5743                 // channel fees no greater than the absolute channel fee on the current commitment
5744                 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
5745                 // very good reason to apply such a limit in any case. We don't bother doing so, risking
5746                 // some force-closure by old nodes, but we wanted to close the channel anyway.
5747
5748                 if let Some(target_feerate) = self.context.target_closing_feerate_sats_per_kw {
5749                         let min_feerate = if self.context.is_outbound() { target_feerate } else { cmp::min(self.context.feerate_per_kw, target_feerate) };
5750                         proposed_feerate = cmp::max(proposed_feerate, min_feerate);
5751                         proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
5752                 }
5753
5754                 // Note that technically we could end up with a lower minimum fee if one sides' balance is
5755                 // below our dust limit, causing the output to disappear. We don't bother handling this
5756                 // case, however, as this should only happen if a channel is closed before any (material)
5757                 // payments have been made on it. This may cause slight fee overpayment and/or failure to
5758                 // come to consensus with our counterparty on appropriate fees, however it should be a
5759                 // relatively rare case. We can revisit this later, though note that in order to determine
5760                 // if the funders' output is dust we have to know the absolute fee we're going to use.
5761                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.context.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
5762                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
5763                 let proposed_max_total_fee_satoshis = if self.context.is_outbound() {
5764                                 // We always add force_close_avoidance_max_fee_satoshis to our normal
5765                                 // feerate-calculated fee, but allow the max to be overridden if we're using a
5766                                 // target feerate-calculated fee.
5767                                 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.context.config.options.force_close_avoidance_max_fee_satoshis,
5768                                         proposed_max_feerate as u64 * tx_weight / 1000)
5769                         } else {
5770                                 self.context.channel_value_satoshis - (self.context.value_to_self_msat + 999) / 1000
5771                         };
5772
5773                 self.context.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
5774                 self.context.closing_fee_limits.clone().unwrap()
5775         }
5776
5777         /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
5778         /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
5779         /// this point if we're the funder we should send the initial closing_signed, and in any case
5780         /// shutdown should complete within a reasonable timeframe.
5781         fn closing_negotiation_ready(&self) -> bool {
5782                 self.context.closing_negotiation_ready()
5783         }
5784
5785         /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
5786         /// an Err if no progress is being made and the channel should be force-closed instead.
5787         /// Should be called on a one-minute timer.
5788         pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
5789                 if self.closing_negotiation_ready() {
5790                         if self.context.closing_signed_in_flight {
5791                                 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
5792                         } else {
5793                                 self.context.closing_signed_in_flight = true;
5794                         }
5795                 }
5796                 Ok(())
5797         }
5798
5799         pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(
5800                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L)
5801                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>, Option<ShutdownResult>), ChannelError>
5802                 where F::Target: FeeEstimator, L::Target: Logger
5803         {
5804                 // If we're waiting on a monitor persistence, that implies we're also waiting to send some
5805                 // message to our counterparty (probably a `revoke_and_ack`). In such a case, we shouldn't
5806                 // initiate `closing_signed` negotiation until we're clear of all pending messages. Note
5807                 // that closing_negotiation_ready checks this case (as well as a few others).
5808                 if self.context.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
5809                         return Ok((None, None, None));
5810                 }
5811
5812                 if !self.context.is_outbound() {
5813                         if let Some(msg) = &self.context.pending_counterparty_closing_signed.take() {
5814                                 return self.closing_signed(fee_estimator, &msg);
5815                         }
5816                         return Ok((None, None, None));
5817                 }
5818
5819                 // If we're waiting on a counterparty `commitment_signed` to clear some updates from our
5820                 // local commitment transaction, we can't yet initiate `closing_signed` negotiation.
5821                 if self.context.expecting_peer_commitment_signed {
5822                         return Ok((None, None, None));
5823                 }
5824
5825                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
5826
5827                 assert!(self.context.shutdown_scriptpubkey.is_some());
5828                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
5829                 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
5830                         our_min_fee, our_max_fee, total_fee_satoshis);
5831
5832                 match &self.context.holder_signer {
5833                         ChannelSignerType::Ecdsa(ecdsa) => {
5834                                 let sig = ecdsa
5835                                         .sign_closing_transaction(&closing_tx, &self.context.secp_ctx)
5836                                         .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
5837
5838                                 self.context.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
5839                                 Ok((Some(msgs::ClosingSigned {
5840                                         channel_id: self.context.channel_id,
5841                                         fee_satoshis: total_fee_satoshis,
5842                                         signature: sig,
5843                                         fee_range: Some(msgs::ClosingSignedFeeRange {
5844                                                 min_fee_satoshis: our_min_fee,
5845                                                 max_fee_satoshis: our_max_fee,
5846                                         }),
5847                                 }), None, None))
5848                         },
5849                         // TODO (taproot|arik)
5850                         #[cfg(taproot)]
5851                         _ => todo!()
5852                 }
5853         }
5854
5855         // Marks a channel as waiting for a response from the counterparty. If it's not received
5856         // [`DISCONNECT_PEER_AWAITING_RESPONSE_TICKS`] after sending our own to them, then we'll attempt
5857         // a reconnection.
5858         fn mark_awaiting_response(&mut self) {
5859                 self.context.sent_message_awaiting_response = Some(0);
5860         }
5861
5862         /// Determines whether we should disconnect the counterparty due to not receiving a response
5863         /// within our expected timeframe.
5864         ///
5865         /// This should be called on every [`super::channelmanager::ChannelManager::timer_tick_occurred`].
5866         pub fn should_disconnect_peer_awaiting_response(&mut self) -> bool {
5867                 let ticks_elapsed = if let Some(ticks_elapsed) = self.context.sent_message_awaiting_response.as_mut() {
5868                         ticks_elapsed
5869                 } else {
5870                         // Don't disconnect when we're not waiting on a response.
5871                         return false;
5872                 };
5873                 *ticks_elapsed += 1;
5874                 *ticks_elapsed >= DISCONNECT_PEER_AWAITING_RESPONSE_TICKS
5875         }
5876
5877         pub fn shutdown(
5878                 &mut self, signer_provider: &SP, their_features: &InitFeatures, msg: &msgs::Shutdown
5879         ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
5880         {
5881                 if self.context.channel_state.is_peer_disconnected() {
5882                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
5883                 }
5884                 if self.context.channel_state.is_pre_funded_state() {
5885                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
5886                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
5887                         // can do that via error message without getting a connection fail anyway...
5888                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
5889                 }
5890                 for htlc in self.context.pending_inbound_htlcs.iter() {
5891                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
5892                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
5893                         }
5894                 }
5895                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
5896
5897                 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
5898                         return Err(ChannelError::Warn(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_hex_string())));
5899                 }
5900
5901                 if self.context.counterparty_shutdown_scriptpubkey.is_some() {
5902                         if Some(&msg.scriptpubkey) != self.context.counterparty_shutdown_scriptpubkey.as_ref() {
5903                                 return Err(ChannelError::Warn(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_hex_string())));
5904                         }
5905                 } else {
5906                         self.context.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
5907                 }
5908
5909                 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
5910                 // immediately after the commitment dance, but we can send a Shutdown because we won't send
5911                 // any further commitment updates after we set LocalShutdownSent.
5912                 let send_shutdown = !self.context.channel_state.is_local_shutdown_sent();
5913
5914                 let update_shutdown_script = match self.context.shutdown_scriptpubkey {
5915                         Some(_) => false,
5916                         None => {
5917                                 assert!(send_shutdown);
5918                                 let shutdown_scriptpubkey = match signer_provider.get_shutdown_scriptpubkey() {
5919                                         Ok(scriptpubkey) => scriptpubkey,
5920                                         Err(_) => return Err(ChannelError::Close("Failed to get shutdown scriptpubkey".to_owned())),
5921                                 };
5922                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
5923                                         return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
5924                                 }
5925                                 self.context.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
5926                                 true
5927                         },
5928                 };
5929
5930                 // From here on out, we may not fail!
5931
5932                 self.context.channel_state.set_remote_shutdown_sent();
5933                 self.context.update_time_counter += 1;
5934
5935                 let monitor_update = if update_shutdown_script {
5936                         self.context.latest_monitor_update_id += 1;
5937                         let monitor_update = ChannelMonitorUpdate {
5938                                 update_id: self.context.latest_monitor_update_id,
5939                                 counterparty_node_id: Some(self.context.counterparty_node_id),
5940                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
5941                                         scriptpubkey: self.get_closing_scriptpubkey(),
5942                                 }],
5943                                 channel_id: Some(self.context.channel_id()),
5944                         };
5945                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
5946                         self.push_ret_blockable_mon_update(monitor_update)
5947                 } else { None };
5948                 let shutdown = if send_shutdown {
5949                         Some(msgs::Shutdown {
5950                                 channel_id: self.context.channel_id,
5951                                 scriptpubkey: self.get_closing_scriptpubkey(),
5952                         })
5953                 } else { None };
5954
5955                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
5956                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
5957                 // cell HTLCs and return them to fail the payment.
5958                 self.context.holding_cell_update_fee = None;
5959                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.context.holding_cell_htlc_updates.len());
5960                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
5961                         match htlc_update {
5962                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
5963                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
5964                                         false
5965                                 },
5966                                 _ => true
5967                         }
5968                 });
5969
5970                 self.context.channel_state.set_local_shutdown_sent();
5971                 self.context.update_time_counter += 1;
5972
5973                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
5974         }
5975
5976         fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
5977                 let mut tx = closing_tx.trust().built_transaction().clone();
5978
5979                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
5980
5981                 let funding_key = self.context.get_holder_pubkeys().funding_pubkey.serialize();
5982                 let counterparty_funding_key = self.context.counterparty_funding_pubkey().serialize();
5983                 let mut holder_sig = sig.serialize_der().to_vec();
5984                 holder_sig.push(EcdsaSighashType::All as u8);
5985                 let mut cp_sig = counterparty_sig.serialize_der().to_vec();
5986                 cp_sig.push(EcdsaSighashType::All as u8);
5987                 if funding_key[..] < counterparty_funding_key[..] {
5988                         tx.input[0].witness.push(holder_sig);
5989                         tx.input[0].witness.push(cp_sig);
5990                 } else {
5991                         tx.input[0].witness.push(cp_sig);
5992                         tx.input[0].witness.push(holder_sig);
5993                 }
5994
5995                 tx.input[0].witness.push(self.context.get_funding_redeemscript().into_bytes());
5996                 tx
5997         }
5998
5999         pub fn closing_signed<F: Deref>(
6000                 &mut self, fee_estimator: &LowerBoundedFeeEstimator<F>, msg: &msgs::ClosingSigned)
6001                 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>, Option<ShutdownResult>), ChannelError>
6002                 where F::Target: FeeEstimator
6003         {
6004                 if !self.context.channel_state.is_both_sides_shutdown() {
6005                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
6006                 }
6007                 if self.context.channel_state.is_peer_disconnected() {
6008                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
6009                 }
6010                 if !self.context.pending_inbound_htlcs.is_empty() || !self.context.pending_outbound_htlcs.is_empty() {
6011                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
6012                 }
6013                 if msg.fee_satoshis > TOTAL_BITCOIN_SUPPLY_SATOSHIS { // this is required to stop potential overflow in build_closing_transaction
6014                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
6015                 }
6016
6017                 if self.context.is_outbound() && self.context.last_sent_closing_fee.is_none() {
6018                         return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
6019                 }
6020
6021                 if self.context.channel_state.is_monitor_update_in_progress() {
6022                         self.context.pending_counterparty_closing_signed = Some(msg.clone());
6023                         return Ok((None, None, None));
6024                 }
6025
6026                 let funding_redeemscript = self.context.get_funding_redeemscript();
6027                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
6028                 if used_total_fee != msg.fee_satoshis {
6029                         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)));
6030                 }
6031                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.context.channel_value_satoshis);
6032
6033                 match self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.get_counterparty_pubkeys().funding_pubkey) {
6034                         Ok(_) => {},
6035                         Err(_e) => {
6036                                 // The remote end may have decided to revoke their output due to inconsistent dust
6037                                 // limits, so check for that case by re-checking the signature here.
6038                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
6039                                 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.context.channel_value_satoshis);
6040                                 secp_check!(self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, self.context.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
6041                         },
6042                 };
6043
6044                 for outp in closing_tx.trust().built_transaction().output.iter() {
6045                         if !outp.script_pubkey.is_witness_program() && outp.value < MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS {
6046                                 return Err(ChannelError::Close("Remote sent us a closing_signed with a dust output. Always use segwit closing scripts!".to_owned()));
6047                         }
6048                 }
6049
6050                 let closure_reason = if self.initiated_shutdown() {
6051                         ClosureReason::LocallyInitiatedCooperativeClosure
6052                 } else {
6053                         ClosureReason::CounterpartyInitiatedCooperativeClosure
6054                 };
6055
6056                 assert!(self.context.shutdown_scriptpubkey.is_some());
6057                 if let Some((last_fee, sig)) = self.context.last_sent_closing_fee {
6058                         if last_fee == msg.fee_satoshis {
6059                                 let shutdown_result = ShutdownResult {
6060                                         closure_reason,
6061                                         monitor_update: None,
6062                                         dropped_outbound_htlcs: Vec::new(),
6063                                         unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
6064                                         channel_id: self.context.channel_id,
6065                                         user_channel_id: self.context.user_id,
6066                                         channel_capacity_satoshis: self.context.channel_value_satoshis,
6067                                         counterparty_node_id: self.context.counterparty_node_id,
6068                                         unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
6069                                         channel_funding_txo: self.context.get_funding_txo(),
6070                                 };
6071                                 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
6072                                 self.context.channel_state = ChannelState::ShutdownComplete;
6073                                 self.context.update_time_counter += 1;
6074                                 return Ok((None, Some(tx), Some(shutdown_result)));
6075                         }
6076                 }
6077
6078                 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
6079
6080                 macro_rules! propose_fee {
6081                         ($new_fee: expr) => {
6082                                 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
6083                                         (closing_tx, $new_fee)
6084                                 } else {
6085                                         self.build_closing_transaction($new_fee, false)
6086                                 };
6087
6088                                 return match &self.context.holder_signer {
6089                                         ChannelSignerType::Ecdsa(ecdsa) => {
6090                                                 let sig = ecdsa
6091                                                         .sign_closing_transaction(&closing_tx, &self.context.secp_ctx)
6092                                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
6093                                                 let (signed_tx, shutdown_result) = if $new_fee == msg.fee_satoshis {
6094                                                         let shutdown_result = ShutdownResult {
6095                                                                 closure_reason,
6096                                                                 monitor_update: None,
6097                                                                 dropped_outbound_htlcs: Vec::new(),
6098                                                                 unbroadcasted_batch_funding_txid: self.context.unbroadcasted_batch_funding_txid(),
6099                                                                 channel_id: self.context.channel_id,
6100                                                                 user_channel_id: self.context.user_id,
6101                                                                 channel_capacity_satoshis: self.context.channel_value_satoshis,
6102                                                                 counterparty_node_id: self.context.counterparty_node_id,
6103                                                                 unbroadcasted_funding_tx: self.context.unbroadcasted_funding(),
6104                                                                 channel_funding_txo: self.context.get_funding_txo(),
6105                                                         };
6106                                                         self.context.channel_state = ChannelState::ShutdownComplete;
6107                                                         self.context.update_time_counter += 1;
6108                                                         let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
6109                                                         (Some(tx), Some(shutdown_result))
6110                                                 } else {
6111                                                         (None, None)
6112                                                 };
6113
6114                                                 self.context.last_sent_closing_fee = Some((used_fee, sig.clone()));
6115                                                 Ok((Some(msgs::ClosingSigned {
6116                                                         channel_id: self.context.channel_id,
6117                                                         fee_satoshis: used_fee,
6118                                                         signature: sig,
6119                                                         fee_range: Some(msgs::ClosingSignedFeeRange {
6120                                                                 min_fee_satoshis: our_min_fee,
6121                                                                 max_fee_satoshis: our_max_fee,
6122                                                         }),
6123                                                 }), signed_tx, shutdown_result))
6124                                         },
6125                                         // TODO (taproot|arik)
6126                                         #[cfg(taproot)]
6127                                         _ => todo!()
6128                                 }
6129                         }
6130                 }
6131
6132                 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
6133                         if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
6134                                 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)));
6135                         }
6136                         if max_fee_satoshis < our_min_fee {
6137                                 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)));
6138                         }
6139                         if min_fee_satoshis > our_max_fee {
6140                                 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)));
6141                         }
6142
6143                         if !self.context.is_outbound() {
6144                                 // They have to pay, so pick the highest fee in the overlapping range.
6145                                 // We should never set an upper bound aside from their full balance
6146                                 debug_assert_eq!(our_max_fee, self.context.channel_value_satoshis - (self.context.value_to_self_msat + 999) / 1000);
6147                                 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
6148                         } else {
6149                                 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
6150                                         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.",
6151                                                 msg.fee_satoshis, our_min_fee, our_max_fee)));
6152                                 }
6153                                 // The proposed fee is in our acceptable range, accept it and broadcast!
6154                                 propose_fee!(msg.fee_satoshis);
6155                         }
6156                 } else {
6157                         // Old fee style negotiation. We don't bother to enforce whether they are complying
6158                         // with the "making progress" requirements, we just comply and hope for the best.
6159                         if let Some((last_fee, _)) = self.context.last_sent_closing_fee {
6160                                 if msg.fee_satoshis > last_fee {
6161                                         if msg.fee_satoshis < our_max_fee {
6162                                                 propose_fee!(msg.fee_satoshis);
6163                                         } else if last_fee < our_max_fee {
6164                                                 propose_fee!(our_max_fee);
6165                                         } else {
6166                                                 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)));
6167                                         }
6168                                 } else {
6169                                         if msg.fee_satoshis > our_min_fee {
6170                                                 propose_fee!(msg.fee_satoshis);
6171                                         } else if last_fee > our_min_fee {
6172                                                 propose_fee!(our_min_fee);
6173                                         } else {
6174                                                 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)));
6175                                         }
6176                                 }
6177                         } else {
6178                                 if msg.fee_satoshis < our_min_fee {
6179                                         propose_fee!(our_min_fee);
6180                                 } else if msg.fee_satoshis > our_max_fee {
6181                                         propose_fee!(our_max_fee);
6182                                 } else {
6183                                         propose_fee!(msg.fee_satoshis);
6184                                 }
6185                         }
6186                 }
6187         }
6188
6189         fn internal_htlc_satisfies_config(
6190                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32, config: &ChannelConfig,
6191         ) -> Result<(), (&'static str, u16)> {
6192                 let fee = amt_to_forward.checked_mul(config.forwarding_fee_proportional_millionths as u64)
6193                         .and_then(|prop_fee| (prop_fee / 1000000).checked_add(config.forwarding_fee_base_msat as u64));
6194                 if fee.is_none() || htlc.amount_msat < fee.unwrap() ||
6195                         (htlc.amount_msat - fee.unwrap()) < amt_to_forward {
6196                         return Err((
6197                                 "Prior hop has deviated from specified fees parameters or origin node has obsolete ones",
6198                                 0x1000 | 12, // fee_insufficient
6199                         ));
6200                 }
6201                 if (htlc.cltv_expiry as u64) < outgoing_cltv_value as u64 + config.cltv_expiry_delta as u64 {
6202                         return Err((
6203                                 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
6204                                 0x1000 | 13, // incorrect_cltv_expiry
6205                         ));
6206                 }
6207                 Ok(())
6208         }
6209
6210         /// Determines whether the parameters of an incoming HTLC to be forwarded satisfy the channel's
6211         /// [`ChannelConfig`]. This first looks at the channel's current [`ChannelConfig`], and if
6212         /// unsuccessful, falls back to the previous one if one exists.
6213         pub fn htlc_satisfies_config(
6214                 &self, htlc: &msgs::UpdateAddHTLC, amt_to_forward: u64, outgoing_cltv_value: u32,
6215         ) -> Result<(), (&'static str, u16)> {
6216                 self.internal_htlc_satisfies_config(&htlc, amt_to_forward, outgoing_cltv_value, &self.context.config())
6217                         .or_else(|err| {
6218                                 if let Some(prev_config) = self.context.prev_config() {
6219                                         self.internal_htlc_satisfies_config(htlc, amt_to_forward, outgoing_cltv_value, &prev_config)
6220                                 } else {
6221                                         Err(err)
6222                                 }
6223                         })
6224         }
6225
6226         pub fn can_accept_incoming_htlc<F: Deref, L: Deref>(
6227                 &self, msg: &msgs::UpdateAddHTLC, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: L
6228         ) -> Result<(), (&'static str, u16)>
6229         where
6230                 F::Target: FeeEstimator,
6231                 L::Target: Logger
6232         {
6233                 if self.context.channel_state.is_local_shutdown_sent() {
6234                         return Err(("Shutdown was already sent", 0x4000|8))
6235                 }
6236
6237                 let dust_exposure_limiting_feerate = self.context.get_dust_exposure_limiting_feerate(&fee_estimator);
6238                 let htlc_stats = self.context.get_pending_htlc_stats(None, dust_exposure_limiting_feerate);
6239                 let max_dust_htlc_exposure_msat = self.context.get_max_dust_htlc_exposure_msat(dust_exposure_limiting_feerate);
6240                 let (htlc_timeout_dust_limit, htlc_success_dust_limit) = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6241                         (0, 0)
6242                 } else {
6243                         let dust_buffer_feerate = self.context.get_dust_buffer_feerate(None) as u64;
6244                         (dust_buffer_feerate * htlc_timeout_tx_weight(self.context.get_channel_type()) / 1000,
6245                                 dust_buffer_feerate * htlc_success_tx_weight(self.context.get_channel_type()) / 1000)
6246                 };
6247                 let exposure_dust_limit_timeout_sats = htlc_timeout_dust_limit + self.context.counterparty_dust_limit_satoshis;
6248                 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
6249                         let on_counterparty_tx_dust_htlc_exposure_msat = htlc_stats.on_counterparty_tx_dust_exposure_msat + msg.amount_msat;
6250                         if on_counterparty_tx_dust_htlc_exposure_msat > max_dust_htlc_exposure_msat {
6251                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
6252                                         on_counterparty_tx_dust_htlc_exposure_msat, max_dust_htlc_exposure_msat);
6253                                 return Err(("Exceeded our dust exposure limit on counterparty commitment tx", 0x1000|7))
6254                         }
6255                 } else {
6256                         let htlc_dust_exposure_msat =
6257                                 per_outbound_htlc_counterparty_commit_tx_fee_msat(self.context.feerate_per_kw, &self.context.channel_type);
6258                         let counterparty_tx_dust_exposure =
6259                                 htlc_stats.on_counterparty_tx_dust_exposure_msat.saturating_add(htlc_dust_exposure_msat);
6260                         if counterparty_tx_dust_exposure > max_dust_htlc_exposure_msat {
6261                                 log_info!(logger, "Cannot accept value that would put our exposure to tx fee dust at {} over the limit {} on counterparty commitment tx",
6262                                         counterparty_tx_dust_exposure, max_dust_htlc_exposure_msat);
6263                                 return Err(("Exceeded our tx fee dust exposure limit on counterparty commitment tx", 0x1000|7))
6264                         }
6265                 }
6266
6267                 let exposure_dust_limit_success_sats = htlc_success_dust_limit + self.context.holder_dust_limit_satoshis;
6268                 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
6269                         let on_holder_tx_dust_htlc_exposure_msat = htlc_stats.on_holder_tx_dust_exposure_msat + msg.amount_msat;
6270                         if on_holder_tx_dust_htlc_exposure_msat > max_dust_htlc_exposure_msat {
6271                                 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
6272                                         on_holder_tx_dust_htlc_exposure_msat, max_dust_htlc_exposure_msat);
6273                                 return Err(("Exceeded our dust exposure limit on holder commitment tx", 0x1000|7))
6274                         }
6275                 }
6276
6277                 let anchor_outputs_value_msat = if self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6278                         ANCHOR_OUTPUT_VALUE_SATOSHI * 2 * 1000
6279                 } else {
6280                         0
6281                 };
6282
6283                 let mut removed_outbound_total_msat = 0;
6284                 for ref htlc in self.context.pending_outbound_htlcs.iter() {
6285                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(_)) = htlc.state {
6286                                 removed_outbound_total_msat += htlc.amount_msat;
6287                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(_)) = htlc.state {
6288                                 removed_outbound_total_msat += htlc.amount_msat;
6289                         }
6290                 }
6291
6292                 let pending_value_to_self_msat =
6293                         self.context.value_to_self_msat + htlc_stats.pending_inbound_htlcs_value_msat - removed_outbound_total_msat;
6294                 let pending_remote_value_msat =
6295                         self.context.channel_value_satoshis * 1000 - pending_value_to_self_msat;
6296
6297                 if !self.context.is_outbound() {
6298                         // `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
6299                         // the spec because the fee spike buffer requirement doesn't exist on the receiver's
6300                         // side, only on the sender's. Note that with anchor outputs we are no longer as
6301                         // sensitive to fee spikes, so we need to account for them.
6302                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
6303                         let mut remote_fee_cost_incl_stuck_buffer_msat = self.context.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
6304                         if !self.context.get_channel_type().supports_anchors_zero_fee_htlc_tx() {
6305                                 remote_fee_cost_incl_stuck_buffer_msat *= FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE;
6306                         }
6307                         if pending_remote_value_msat.saturating_sub(msg.amount_msat).saturating_sub(self.context.holder_selected_channel_reserve_satoshis * 1000).saturating_sub(anchor_outputs_value_msat) < remote_fee_cost_incl_stuck_buffer_msat {
6308                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", &self.context.channel_id());
6309                                 return Err(("Fee spike buffer violation", 0x1000|7));
6310                         }
6311                 }
6312
6313                 Ok(())
6314         }
6315
6316         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
6317                 self.context.holder_commitment_point.transaction_number() + 1
6318         }
6319
6320         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
6321                 self.context.cur_counterparty_commitment_transaction_number + 1 - if self.context.channel_state.is_awaiting_remote_revoke() { 1 } else { 0 }
6322         }
6323
6324         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
6325                 self.context.cur_counterparty_commitment_transaction_number + 2
6326         }
6327
6328         #[cfg(test)]
6329         pub fn get_signer(&self) -> &ChannelSignerType<SP> {
6330                 &self.context.holder_signer
6331         }
6332
6333         #[cfg(test)]
6334         pub fn get_value_stat(&self) -> ChannelValueStat {
6335                 ChannelValueStat {
6336                         value_to_self_msat: self.context.value_to_self_msat,
6337                         channel_value_msat: self.context.channel_value_satoshis * 1000,
6338                         channel_reserve_msat: self.context.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
6339                         pending_outbound_htlcs_amount_msat: self.context.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
6340                         pending_inbound_htlcs_amount_msat: self.context.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
6341                         holding_cell_outbound_amount_msat: {
6342                                 let mut res = 0;
6343                                 for h in self.context.holding_cell_htlc_updates.iter() {
6344                                         match h {
6345                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
6346                                                         res += amount_msat;
6347                                                 }
6348                                                 _ => {}
6349                                         }
6350                                 }
6351                                 res
6352                         },
6353                         counterparty_max_htlc_value_in_flight_msat: self.context.counterparty_max_htlc_value_in_flight_msat,
6354                         counterparty_dust_limit_msat: self.context.counterparty_dust_limit_satoshis * 1000,
6355                 }
6356         }
6357
6358         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
6359         /// Allowed in any state (including after shutdown)
6360         pub fn is_awaiting_monitor_update(&self) -> bool {
6361                 self.context.channel_state.is_monitor_update_in_progress()
6362         }
6363
6364         /// Gets the latest [`ChannelMonitorUpdate`] ID which has been released and is in-flight.
6365         pub fn get_latest_unblocked_monitor_update_id(&self) -> u64 {
6366                 if self.context.blocked_monitor_updates.is_empty() { return self.context.get_latest_monitor_update_id(); }
6367                 self.context.blocked_monitor_updates[0].update.update_id - 1
6368         }
6369
6370         /// Returns the next blocked monitor update, if one exists, and a bool which indicates a
6371         /// further blocked monitor update exists after the next.
6372         pub fn unblock_next_blocked_monitor_update(&mut self) -> Option<(ChannelMonitorUpdate, bool)> {
6373                 if self.context.blocked_monitor_updates.is_empty() { return None; }
6374                 Some((self.context.blocked_monitor_updates.remove(0).update,
6375                         !self.context.blocked_monitor_updates.is_empty()))
6376         }
6377
6378         /// Pushes a new monitor update into our monitor update queue, returning it if it should be
6379         /// immediately given to the user for persisting or `None` if it should be held as blocked.
6380         fn push_ret_blockable_mon_update(&mut self, update: ChannelMonitorUpdate)
6381         -> Option<ChannelMonitorUpdate> {
6382                 let release_monitor = self.context.blocked_monitor_updates.is_empty();
6383                 if !release_monitor {
6384                         self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
6385                                 update,
6386                         });
6387                         None
6388                 } else {
6389                         Some(update)
6390                 }
6391         }
6392
6393         /// On startup, its possible we detect some monitor updates have actually completed (and the
6394         /// ChannelManager was simply stale). In that case, we should simply drop them, which we do
6395         /// here after logging them.
6396         pub fn on_startup_drop_completed_blocked_mon_updates_through<L: Logger>(&mut self, logger: &L, loaded_mon_update_id: u64) {
6397                 let channel_id = self.context.channel_id();
6398                 self.context.blocked_monitor_updates.retain(|update| {
6399                         if update.update.update_id <= loaded_mon_update_id {
6400                                 log_info!(
6401                                         logger,
6402                                         "Dropping completed ChannelMonitorUpdate id {} on channel {} due to a stale ChannelManager",
6403                                         update.update.update_id,
6404                                         channel_id,
6405                                 );
6406                                 false
6407                         } else {
6408                                 true
6409                         }
6410                 });
6411         }
6412
6413         pub fn blocked_monitor_updates_pending(&self) -> usize {
6414                 self.context.blocked_monitor_updates.len()
6415         }
6416
6417         /// Returns true if the channel is awaiting the persistence of the initial ChannelMonitor.
6418         /// If the channel is outbound, this implies we have not yet broadcasted the funding
6419         /// transaction. If the channel is inbound, this implies simply that the channel has not
6420         /// advanced state.
6421         pub fn is_awaiting_initial_mon_persist(&self) -> bool {
6422                 if !self.is_awaiting_monitor_update() { return false; }
6423                 if matches!(
6424                         self.context.channel_state, ChannelState::AwaitingChannelReady(flags)
6425                         if flags.clone().clear(AwaitingChannelReadyFlags::THEIR_CHANNEL_READY | FundedStateFlags::PEER_DISCONNECTED | FundedStateFlags::MONITOR_UPDATE_IN_PROGRESS | AwaitingChannelReadyFlags::WAITING_FOR_BATCH).is_empty()
6426                 ) {
6427                         // If we're not a 0conf channel, we'll be waiting on a monitor update with only
6428                         // AwaitingChannelReady set, though our peer could have sent their channel_ready.
6429                         debug_assert!(self.context.minimum_depth.unwrap_or(1) > 0);
6430                         return true;
6431                 }
6432                 if self.context.holder_commitment_point.transaction_number() == INITIAL_COMMITMENT_NUMBER - 1 &&
6433                         self.context.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
6434                         // If we're a 0-conf channel, we'll move beyond AwaitingChannelReady immediately even while
6435                         // waiting for the initial monitor persistence. Thus, we check if our commitment
6436                         // transaction numbers have both been iterated only exactly once (for the
6437                         // funding_signed), and we're awaiting monitor update.
6438                         //
6439                         // If we got here, we shouldn't have yet broadcasted the funding transaction (as the
6440                         // only way to get an awaiting-monitor-update state during initial funding is if the
6441                         // initial monitor persistence is still pending).
6442                         //
6443                         // Because deciding we're awaiting initial broadcast spuriously could result in
6444                         // funds-loss (as we don't have a monitor, but have the funding transaction confirmed),
6445                         // we hard-assert here, even in production builds.
6446                         if self.context.is_outbound() { assert!(self.context.funding_transaction.is_some()); }
6447                         assert!(self.context.monitor_pending_channel_ready);
6448                         assert_eq!(self.context.latest_monitor_update_id, 0);
6449                         return true;
6450                 }
6451                 false
6452         }
6453
6454         /// Returns true if our channel_ready has been sent
6455         pub fn is_our_channel_ready(&self) -> bool {
6456                 matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(flags) if flags.is_set(AwaitingChannelReadyFlags::OUR_CHANNEL_READY)) ||
6457                         matches!(self.context.channel_state, ChannelState::ChannelReady(_))
6458         }
6459
6460         /// Returns true if our peer has either initiated or agreed to shut down the channel.
6461         pub fn received_shutdown(&self) -> bool {
6462                 self.context.channel_state.is_remote_shutdown_sent()
6463         }
6464
6465         /// Returns true if we either initiated or agreed to shut down the channel.
6466         pub fn sent_shutdown(&self) -> bool {
6467                 self.context.channel_state.is_local_shutdown_sent()
6468         }
6469
6470         /// Returns true if we initiated to shut down the channel.
6471         pub fn initiated_shutdown(&self) -> bool {
6472                 self.context.local_initiated_shutdown.is_some()
6473         }
6474
6475         /// Returns true if this channel is fully shut down. True here implies that no further actions
6476         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
6477         /// will be handled appropriately by the chain monitor.
6478         pub fn is_shutdown(&self) -> bool {
6479                 matches!(self.context.channel_state, ChannelState::ShutdownComplete)
6480         }
6481
6482         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
6483                 self.context.channel_update_status
6484         }
6485
6486         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
6487                 self.context.update_time_counter += 1;
6488                 self.context.channel_update_status = status;
6489         }
6490
6491         fn check_get_channel_ready(&mut self, height: u32) -> Option<msgs::ChannelReady> {
6492                 // Called:
6493                 //  * always when a new block/transactions are confirmed with the new height
6494                 //  * when funding is signed with a height of 0
6495                 if self.context.funding_tx_confirmation_height == 0 && self.context.minimum_depth != Some(0) {
6496                         return None;
6497                 }
6498
6499                 let funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
6500                 if funding_tx_confirmations <= 0 {
6501                         self.context.funding_tx_confirmation_height = 0;
6502                 }
6503
6504                 if funding_tx_confirmations < self.context.minimum_depth.unwrap_or(0) as i64 {
6505                         return None;
6506                 }
6507
6508                 // If we're still pending the signature on a funding transaction, then we're not ready to send a
6509                 // channel_ready yet.
6510                 if self.context.signer_pending_funding {
6511                         return None;
6512                 }
6513
6514                 // Note that we don't include ChannelState::WaitingForBatch as we don't want to send
6515                 // channel_ready until the entire batch is ready.
6516                 let need_commitment_update = if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()).is_empty()) {
6517                         self.context.channel_state.set_our_channel_ready();
6518                         true
6519                 } else if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()) == AwaitingChannelReadyFlags::THEIR_CHANNEL_READY) {
6520                         self.context.channel_state = ChannelState::ChannelReady(self.context.channel_state.with_funded_state_flags_mask().into());
6521                         self.context.update_time_counter += 1;
6522                         true
6523                 } else if matches!(self.context.channel_state, ChannelState::AwaitingChannelReady(f) if f.clone().clear(FundedStateFlags::ALL.into()) == AwaitingChannelReadyFlags::OUR_CHANNEL_READY) {
6524                         // We got a reorg but not enough to trigger a force close, just ignore.
6525                         false
6526                 } else {
6527                         if self.context.funding_tx_confirmation_height != 0 &&
6528                                 self.context.channel_state < ChannelState::ChannelReady(ChannelReadyFlags::new())
6529                         {
6530                                 // We should never see a funding transaction on-chain until we've received
6531                                 // funding_signed (if we're an outbound channel), or seen funding_generated (if we're
6532                                 // an inbound channel - before that we have no known funding TXID). The fuzzer,
6533                                 // however, may do this and we shouldn't treat it as a bug.
6534                                 #[cfg(not(fuzzing))]
6535                                 panic!("Started confirming a channel in a state pre-AwaitingChannelReady: {}.\n\
6536                                         Do NOT broadcast a funding transaction manually - let LDK do it for you!",
6537                                         self.context.channel_state.to_u32());
6538                         }
6539                         // We got a reorg but not enough to trigger a force close, just ignore.
6540                         false
6541                 };
6542
6543                 if need_commitment_update {
6544                         if !self.context.channel_state.is_monitor_update_in_progress() {
6545                                 if !self.context.channel_state.is_peer_disconnected() {
6546                                         let next_per_commitment_point =
6547                                                 self.context.holder_signer.as_ref().get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - 1, &self.context.secp_ctx);
6548                                         return Some(msgs::ChannelReady {
6549                                                 channel_id: self.context.channel_id,
6550                                                 next_per_commitment_point,
6551                                                 short_channel_id_alias: Some(self.context.outbound_scid_alias),
6552                                         });
6553                                 }
6554                         } else {
6555                                 self.context.monitor_pending_channel_ready = true;
6556                         }
6557                 }
6558                 None
6559         }
6560
6561         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
6562         /// In the first case, we store the confirmation height and calculating the short channel id.
6563         /// In the second, we simply return an Err indicating we need to be force-closed now.
6564         pub fn transactions_confirmed<NS: Deref, L: Deref>(
6565                 &mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData,
6566                 chain_hash: ChainHash, node_signer: &NS, user_config: &UserConfig, logger: &L
6567         ) -> Result<(Option<msgs::ChannelReady>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6568         where
6569                 NS::Target: NodeSigner,
6570                 L::Target: Logger
6571         {
6572                 let mut msgs = (None, None);
6573                 if let Some(funding_txo) = self.context.get_funding_txo() {
6574                         for &(index_in_block, tx) in txdata.iter() {
6575                                 // Check if the transaction is the expected funding transaction, and if it is,
6576                                 // check that it pays the right amount to the right script.
6577                                 if self.context.funding_tx_confirmation_height == 0 {
6578                                         if tx.txid() == funding_txo.txid {
6579                                                 let txo_idx = funding_txo.index as usize;
6580                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.context.get_funding_redeemscript().to_v0_p2wsh() ||
6581                                                                 tx.output[txo_idx].value != self.context.channel_value_satoshis {
6582                                                         if self.context.is_outbound() {
6583                                                                 // If we generated the funding transaction and it doesn't match what it
6584                                                                 // should, the client is really broken and we should just panic and
6585                                                                 // tell them off. That said, because hash collisions happen with high
6586                                                                 // probability in fuzzing mode, if we're fuzzing we just close the
6587                                                                 // channel and move on.
6588                                                                 #[cfg(not(fuzzing))]
6589                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
6590                                                         }
6591                                                         self.context.update_time_counter += 1;
6592                                                         let err_reason = "funding tx had wrong script/value or output index";
6593                                                         return Err(ClosureReason::ProcessingError { err: err_reason.to_owned() });
6594                                                 } else {
6595                                                         if self.context.is_outbound() {
6596                                                                 if !tx.is_coin_base() {
6597                                                                         for input in tx.input.iter() {
6598                                                                                 if input.witness.is_empty() {
6599                                                                                         // We generated a malleable funding transaction, implying we've
6600                                                                                         // just exposed ourselves to funds loss to our counterparty.
6601                                                                                         #[cfg(not(fuzzing))]
6602                                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
6603                                                                                 }
6604                                                                         }
6605                                                                 }
6606                                                         }
6607                                                         self.context.funding_tx_confirmation_height = height;
6608                                                         self.context.funding_tx_confirmed_in = Some(*block_hash);
6609                                                         self.context.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
6610                                                                 Ok(scid) => Some(scid),
6611                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
6612                                                         }
6613                                                 }
6614                                                 // If this is a coinbase transaction and not a 0-conf channel
6615                                                 // we should update our min_depth to 100 to handle coinbase maturity
6616                                                 if tx.is_coin_base() &&
6617                                                         self.context.minimum_depth.unwrap_or(0) > 0 &&
6618                                                         self.context.minimum_depth.unwrap_or(0) < COINBASE_MATURITY {
6619                                                         self.context.minimum_depth = Some(COINBASE_MATURITY);
6620                                                 }
6621                                         }
6622                                         // If we allow 1-conf funding, we may need to check for channel_ready here and
6623                                         // send it immediately instead of waiting for a best_block_updated call (which
6624                                         // may have already happened for this block).
6625                                         if let Some(channel_ready) = self.check_get_channel_ready(height) {
6626                                                 log_info!(logger, "Sending a channel_ready to our peer for channel {}", &self.context.channel_id);
6627                                                 let announcement_sigs = self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger);
6628                                                 msgs = (Some(channel_ready), announcement_sigs);
6629                                         }
6630                                 }
6631                                 for inp in tx.input.iter() {
6632                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
6633                                                 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, &self.context.channel_id());
6634                                                 return Err(ClosureReason::CommitmentTxConfirmed);
6635                                         }
6636                                 }
6637                         }
6638                 }
6639                 Ok(msgs)
6640         }
6641
6642         /// When a new block is connected, we check the height of the block against outbound holding
6643         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
6644         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
6645         /// handled by the ChannelMonitor.
6646         ///
6647         /// If we return Err, the channel may have been closed, at which point the standard
6648         /// requirements apply - no calls may be made except those explicitly stated to be allowed
6649         /// post-shutdown.
6650         ///
6651         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
6652         /// back.
6653         pub fn best_block_updated<NS: Deref, L: Deref>(
6654                 &mut self, height: u32, highest_header_time: u32, chain_hash: ChainHash,
6655                 node_signer: &NS, user_config: &UserConfig, logger: &L
6656         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6657         where
6658                 NS::Target: NodeSigner,
6659                 L::Target: Logger
6660         {
6661                 self.do_best_block_updated(height, highest_header_time, Some((chain_hash, node_signer, user_config)), logger)
6662         }
6663
6664         fn do_best_block_updated<NS: Deref, L: Deref>(
6665                 &mut self, height: u32, highest_header_time: u32,
6666                 chain_node_signer: Option<(ChainHash, &NS, &UserConfig)>, logger: &L
6667         ) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>
6668         where
6669                 NS::Target: NodeSigner,
6670                 L::Target: Logger
6671         {
6672                 let mut timed_out_htlcs = Vec::new();
6673                 // This mirrors the check in ChannelManager::decode_update_add_htlc_onion, refusing to
6674                 // forward an HTLC when our counterparty should almost certainly just fail it for expiring
6675                 // ~now.
6676                 let unforwarded_htlc_cltv_limit = height + LATENCY_GRACE_PERIOD_BLOCKS;
6677                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
6678                         match htlc_update {
6679                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
6680                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
6681                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
6682                                                 false
6683                                         } else { true }
6684                                 },
6685                                 _ => true
6686                         }
6687                 });
6688
6689                 self.context.update_time_counter = cmp::max(self.context.update_time_counter, highest_header_time);
6690
6691                 if let Some(channel_ready) = self.check_get_channel_ready(height) {
6692                         let announcement_sigs = if let Some((chain_hash, node_signer, user_config)) = chain_node_signer {
6693                                 self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger)
6694                         } else { None };
6695                         log_info!(logger, "Sending a channel_ready to our peer for channel {}", &self.context.channel_id);
6696                         return Ok((Some(channel_ready), timed_out_htlcs, announcement_sigs));
6697                 }
6698
6699                 if matches!(self.context.channel_state, ChannelState::ChannelReady(_)) ||
6700                         self.context.channel_state.is_our_channel_ready() {
6701                         let mut funding_tx_confirmations = height as i64 - self.context.funding_tx_confirmation_height as i64 + 1;
6702                         if self.context.funding_tx_confirmation_height == 0 {
6703                                 // Note that check_get_channel_ready may reset funding_tx_confirmation_height to
6704                                 // zero if it has been reorged out, however in either case, our state flags
6705                                 // indicate we've already sent a channel_ready
6706                                 funding_tx_confirmations = 0;
6707                         }
6708
6709                         // If we've sent channel_ready (or have both sent and received channel_ready), and
6710                         // the funding transaction has become unconfirmed,
6711                         // close the channel and hope we can get the latest state on chain (because presumably
6712                         // the funding transaction is at least still in the mempool of most nodes).
6713                         //
6714                         // Note that ideally we wouldn't force-close if we see *any* reorg on a 1-conf or
6715                         // 0-conf channel, but not doing so may lead to the
6716                         // `ChannelManager::short_to_chan_info` map  being inconsistent, so we currently have
6717                         // to.
6718                         if funding_tx_confirmations == 0 && self.context.funding_tx_confirmed_in.is_some() {
6719                                 let err_reason = format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.",
6720                                         self.context.minimum_depth.unwrap(), funding_tx_confirmations);
6721                                 return Err(ClosureReason::ProcessingError { err: err_reason });
6722                         }
6723                 } else if !self.context.is_outbound() && self.context.funding_tx_confirmed_in.is_none() &&
6724                                 height >= self.context.channel_creation_height + FUNDING_CONF_DEADLINE_BLOCKS {
6725                         log_info!(logger, "Closing channel {} due to funding timeout", &self.context.channel_id);
6726                         // If funding_tx_confirmed_in is unset, the channel must not be active
6727                         assert!(self.context.channel_state <= ChannelState::ChannelReady(ChannelReadyFlags::new()));
6728                         assert!(!self.context.channel_state.is_our_channel_ready());
6729                         return Err(ClosureReason::FundingTimedOut);
6730                 }
6731
6732                 let announcement_sigs = if let Some((chain_hash, node_signer, user_config)) = chain_node_signer {
6733                         self.get_announcement_sigs(node_signer, chain_hash, user_config, height, logger)
6734                 } else { None };
6735                 Ok((None, timed_out_htlcs, announcement_sigs))
6736         }
6737
6738         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
6739         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
6740         /// before the channel has reached channel_ready and we can just wait for more blocks.
6741         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
6742                 if self.context.funding_tx_confirmation_height != 0 {
6743                         // We handle the funding disconnection by calling best_block_updated with a height one
6744                         // below where our funding was connected, implying a reorg back to conf_height - 1.
6745                         let reorg_height = self.context.funding_tx_confirmation_height - 1;
6746                         // We use the time field to bump the current time we set on channel updates if its
6747                         // larger. If we don't know that time has moved forward, we can just set it to the last
6748                         // time we saw and it will be ignored.
6749                         let best_time = self.context.update_time_counter;
6750                         match self.do_best_block_updated(reorg_height, best_time, None::<(ChainHash, &&dyn NodeSigner, &UserConfig)>, logger) {
6751                                 Ok((channel_ready, timed_out_htlcs, announcement_sigs)) => {
6752                                         assert!(channel_ready.is_none(), "We can't generate a funding with 0 confirmations?");
6753                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
6754                                         assert!(announcement_sigs.is_none(), "We can't generate an announcement_sigs with 0 confirmations?");
6755                                         Ok(())
6756                                 },
6757                                 Err(e) => Err(e)
6758                         }
6759                 } else {
6760                         // We never learned about the funding confirmation anyway, just ignore
6761                         Ok(())
6762                 }
6763         }
6764
6765         // Methods to get unprompted messages to send to the remote end (or where we already returned
6766         // something in the handler for the message that prompted this message):
6767
6768         /// Gets an UnsignedChannelAnnouncement for this channel. The channel must be publicly
6769         /// announceable and available for use (have exchanged [`ChannelReady`] messages in both
6770         /// directions). Should be used for both broadcasted announcements and in response to an
6771         /// AnnouncementSignatures message from the remote peer.
6772         ///
6773         /// Will only fail if we're not in a state where channel_announcement may be sent (including
6774         /// closing).
6775         ///
6776         /// This will only return ChannelError::Ignore upon failure.
6777         ///
6778         /// [`ChannelReady`]: crate::ln::msgs::ChannelReady
6779         fn get_channel_announcement<NS: Deref>(
6780                 &self, node_signer: &NS, chain_hash: ChainHash, user_config: &UserConfig,
6781         ) -> Result<msgs::UnsignedChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6782                 if !self.context.config.announced_channel {
6783                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
6784                 }
6785                 if !self.context.is_usable() {
6786                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel is not currently usable".to_owned()));
6787                 }
6788
6789                 let short_channel_id = self.context.get_short_channel_id()
6790                         .ok_or(ChannelError::Ignore("Cannot get a ChannelAnnouncement if the channel has not been confirmed yet".to_owned()))?;
6791                 let node_id = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
6792                         .map_err(|_| ChannelError::Ignore("Failed to retrieve own public key".to_owned()))?);
6793                 let counterparty_node_id = NodeId::from_pubkey(&self.context.get_counterparty_node_id());
6794                 let were_node_one = node_id.as_slice() < counterparty_node_id.as_slice();
6795
6796                 let msg = msgs::UnsignedChannelAnnouncement {
6797                         features: channelmanager::provided_channel_features(&user_config),
6798                         chain_hash,
6799                         short_channel_id,
6800                         node_id_1: if were_node_one { node_id } else { counterparty_node_id },
6801                         node_id_2: if were_node_one { counterparty_node_id } else { node_id },
6802                         bitcoin_key_1: NodeId::from_pubkey(if were_node_one { &self.context.get_holder_pubkeys().funding_pubkey } else { self.context.counterparty_funding_pubkey() }),
6803                         bitcoin_key_2: NodeId::from_pubkey(if were_node_one { self.context.counterparty_funding_pubkey() } else { &self.context.get_holder_pubkeys().funding_pubkey }),
6804                         excess_data: Vec::new(),
6805                 };
6806
6807                 Ok(msg)
6808         }
6809
6810         fn get_announcement_sigs<NS: Deref, L: Deref>(
6811                 &mut self, node_signer: &NS, chain_hash: ChainHash, user_config: &UserConfig,
6812                 best_block_height: u32, logger: &L
6813         ) -> Option<msgs::AnnouncementSignatures>
6814         where
6815                 NS::Target: NodeSigner,
6816                 L::Target: Logger
6817         {
6818                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6819                         return None;
6820                 }
6821
6822                 if !self.context.is_usable() {
6823                         return None;
6824                 }
6825
6826                 if self.context.channel_state.is_peer_disconnected() {
6827                         log_trace!(logger, "Cannot create an announcement_signatures as our peer is disconnected");
6828                         return None;
6829                 }
6830
6831                 if self.context.announcement_sigs_state != AnnouncementSigsState::NotSent {
6832                         return None;
6833                 }
6834
6835                 log_trace!(logger, "Creating an announcement_signatures message for channel {}", &self.context.channel_id());
6836                 let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
6837                         Ok(a) => a,
6838                         Err(e) => {
6839                                 log_trace!(logger, "{:?}", e);
6840                                 return None;
6841                         }
6842                 };
6843                 let our_node_sig = match node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement)) {
6844                         Err(_) => {
6845                                 log_error!(logger, "Failed to generate node signature for channel_announcement. Channel will not be announced!");
6846                                 return None;
6847                         },
6848                         Ok(v) => v
6849                 };
6850                 match &self.context.holder_signer {
6851                         ChannelSignerType::Ecdsa(ecdsa) => {
6852                                 let our_bitcoin_sig = match ecdsa.sign_channel_announcement_with_funding_key(&announcement, &self.context.secp_ctx) {
6853                                         Err(_) => {
6854                                                 log_error!(logger, "Signer rejected channel_announcement signing. Channel will not be announced!");
6855                                                 return None;
6856                                         },
6857                                         Ok(v) => v
6858                                 };
6859                                 let short_channel_id = match self.context.get_short_channel_id() {
6860                                         Some(scid) => scid,
6861                                         None => return None,
6862                                 };
6863
6864                                 self.context.announcement_sigs_state = AnnouncementSigsState::MessageSent;
6865
6866                                 Some(msgs::AnnouncementSignatures {
6867                                         channel_id: self.context.channel_id(),
6868                                         short_channel_id,
6869                                         node_signature: our_node_sig,
6870                                         bitcoin_signature: our_bitcoin_sig,
6871                                 })
6872                         },
6873                         // TODO (taproot|arik)
6874                         #[cfg(taproot)]
6875                         _ => todo!()
6876                 }
6877         }
6878
6879         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
6880         /// available.
6881         fn sign_channel_announcement<NS: Deref>(
6882                 &self, node_signer: &NS, announcement: msgs::UnsignedChannelAnnouncement
6883         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6884                 if let Some((their_node_sig, their_bitcoin_sig)) = self.context.announcement_sigs {
6885                         let our_node_key = NodeId::from_pubkey(&node_signer.get_node_id(Recipient::Node)
6886                                 .map_err(|_| ChannelError::Ignore("Signer failed to retrieve own public key".to_owned()))?);
6887                         let were_node_one = announcement.node_id_1 == our_node_key;
6888
6889                         let our_node_sig = node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelAnnouncement(&announcement))
6890                                 .map_err(|_| ChannelError::Ignore("Failed to generate node signature for channel_announcement".to_owned()))?;
6891                         match &self.context.holder_signer {
6892                                 ChannelSignerType::Ecdsa(ecdsa) => {
6893                                         let our_bitcoin_sig = ecdsa.sign_channel_announcement_with_funding_key(&announcement, &self.context.secp_ctx)
6894                                                 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
6895                                         Ok(msgs::ChannelAnnouncement {
6896                                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
6897                                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
6898                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
6899                                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
6900                                                 contents: announcement,
6901                                         })
6902                                 },
6903                                 // TODO (taproot|arik)
6904                                 #[cfg(taproot)]
6905                                 _ => todo!()
6906                         }
6907                 } else {
6908                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
6909                 }
6910         }
6911
6912         /// Processes an incoming announcement_signatures message, providing a fully-signed
6913         /// channel_announcement message which we can broadcast and storing our counterparty's
6914         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
6915         pub fn announcement_signatures<NS: Deref>(
6916                 &mut self, node_signer: &NS, chain_hash: ChainHash, best_block_height: u32,
6917                 msg: &msgs::AnnouncementSignatures, user_config: &UserConfig
6918         ) -> Result<msgs::ChannelAnnouncement, ChannelError> where NS::Target: NodeSigner {
6919                 let announcement = self.get_channel_announcement(node_signer, chain_hash, user_config)?;
6920
6921                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
6922
6923                 if self.context.secp_ctx.verify_ecdsa(&msghash, &msg.node_signature, &self.context.get_counterparty_node_id()).is_err() {
6924                         return Err(ChannelError::Close(format!(
6925                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
6926                                  &announcement, self.context.get_counterparty_node_id())));
6927                 }
6928                 if self.context.secp_ctx.verify_ecdsa(&msghash, &msg.bitcoin_signature, self.context.counterparty_funding_pubkey()).is_err() {
6929                         return Err(ChannelError::Close(format!(
6930                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
6931                                 &announcement, self.context.counterparty_funding_pubkey())));
6932                 }
6933
6934                 self.context.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
6935                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6936                         return Err(ChannelError::Ignore(
6937                                 "Got announcement_signatures prior to the required six confirmations - we may not have received a block yet that our peer has".to_owned()));
6938                 }
6939
6940                 self.sign_channel_announcement(node_signer, announcement)
6941         }
6942
6943         /// Gets a signed channel_announcement for this channel, if we previously received an
6944         /// announcement_signatures from our counterparty.
6945         pub fn get_signed_channel_announcement<NS: Deref>(
6946                 &self, node_signer: &NS, chain_hash: ChainHash, best_block_height: u32, user_config: &UserConfig
6947         ) -> Option<msgs::ChannelAnnouncement> where NS::Target: NodeSigner {
6948                 if self.context.funding_tx_confirmation_height == 0 || self.context.funding_tx_confirmation_height + 5 > best_block_height {
6949                         return None;
6950                 }
6951                 let announcement = match self.get_channel_announcement(node_signer, chain_hash, user_config) {
6952                         Ok(res) => res,
6953                         Err(_) => return None,
6954                 };
6955                 match self.sign_channel_announcement(node_signer, announcement) {
6956                         Ok(res) => Some(res),
6957                         Err(_) => None,
6958                 }
6959         }
6960
6961         /// May panic if called on a channel that wasn't immediately-previously
6962         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
6963         pub fn get_channel_reestablish<L: Deref>(&mut self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
6964                 assert!(self.context.channel_state.is_peer_disconnected());
6965                 assert_ne!(self.context.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
6966                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
6967                 // current to_remote balances. However, it no longer has any use, and thus is now simply
6968                 // set to a dummy (but valid, as required by the spec) public key.
6969                 // fuzzing mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
6970                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
6971                 // valid, and valid in fuzzing mode's arbitrary validity criteria:
6972                 let mut pk = [2; 33]; pk[1] = 0xff;
6973                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
6974                 let remote_last_secret = if self.context.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
6975                         let remote_last_secret = self.context.commitment_secrets.get_secret(self.context.cur_counterparty_commitment_transaction_number + 2).unwrap();
6976                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), &self.context.channel_id());
6977                         remote_last_secret
6978                 } else {
6979                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", &self.context.channel_id());
6980                         [0;32]
6981                 };
6982                 self.mark_awaiting_response();
6983                 msgs::ChannelReestablish {
6984                         channel_id: self.context.channel_id(),
6985                         // The protocol has two different commitment number concepts - the "commitment
6986                         // transaction number", which starts from 0 and counts up, and the "revocation key
6987                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
6988                         // commitment transaction numbers by the index which will be used to reveal the
6989                         // revocation key for that commitment transaction, which means we have to convert them
6990                         // to protocol-level commitment numbers here...
6991
6992                         // next_local_commitment_number is the next commitment_signed number we expect to
6993                         // receive (indicating if they need to resend one that we missed).
6994                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.context.holder_commitment_point.transaction_number(),
6995                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
6996                         // receive, however we track it by the next commitment number for a remote transaction
6997                         // (which is one further, as they always revoke previous commitment transaction, not
6998                         // the one we send) so we have to decrement by 1. Note that if
6999                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
7000                         // dropped this channel on disconnect as it hasn't yet reached AwaitingChannelReady so we can't
7001                         // overflow here.
7002                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.context.cur_counterparty_commitment_transaction_number - 1,
7003                         your_last_per_commitment_secret: remote_last_secret,
7004                         my_current_per_commitment_point: dummy_pubkey,
7005                         // TODO(dual_funding): If we've sent `commtiment_signed` for an interactive transaction
7006                         // construction but have not received `tx_signatures` we MUST set `next_funding_txid` to the
7007                         // txid of that interactive transaction, else we MUST NOT set it.
7008                         next_funding_txid: None,
7009                 }
7010         }
7011
7012
7013         // Send stuff to our remote peers:
7014
7015         /// Queues up an outbound HTLC to send by placing it in the holding cell. You should call
7016         /// [`Self::maybe_free_holding_cell_htlcs`] in order to actually generate and send the
7017         /// commitment update.
7018         ///
7019         /// `Err`s will only be [`ChannelError::Ignore`].
7020         pub fn queue_add_htlc<F: Deref, L: Deref>(
7021                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
7022                 onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
7023                 blinding_point: Option<PublicKey>, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
7024         ) -> Result<(), ChannelError>
7025         where F::Target: FeeEstimator, L::Target: Logger
7026         {
7027                 self
7028                         .send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, true,
7029                                 skimmed_fee_msat, blinding_point, fee_estimator, logger)
7030                         .map(|msg_opt| assert!(msg_opt.is_none(), "We forced holding cell?"))
7031                         .map_err(|err| {
7032                                 if let ChannelError::Ignore(_) = err { /* fine */ }
7033                                 else { debug_assert!(false, "Queueing cannot trigger channel failure"); }
7034                                 err
7035                         })
7036         }
7037
7038         /// Adds a pending outbound HTLC to this channel, note that you probably want
7039         /// [`Self::send_htlc_and_commit`] instead cause you'll want both messages at once.
7040         ///
7041         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
7042         /// the wire:
7043         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
7044         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
7045         ///   awaiting ACK.
7046         /// * In cases where we're marked MonitorUpdateInProgress, we cannot commit to a new state as
7047         ///   we may not yet have sent the previous commitment update messages and will need to
7048         ///   regenerate them.
7049         ///
7050         /// You MUST call [`Self::send_commitment_no_state_update`] prior to calling any other methods
7051         /// on this [`Channel`] if `force_holding_cell` is false.
7052         ///
7053         /// `Err`s will only be [`ChannelError::Ignore`].
7054         fn send_htlc<F: Deref, L: Deref>(
7055                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
7056                 onion_routing_packet: msgs::OnionPacket, mut force_holding_cell: bool,
7057                 skimmed_fee_msat: Option<u64>, blinding_point: Option<PublicKey>,
7058                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
7059         ) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError>
7060         where F::Target: FeeEstimator, L::Target: Logger
7061         {
7062                 if !matches!(self.context.channel_state, ChannelState::ChannelReady(_)) ||
7063                         self.context.channel_state.is_local_shutdown_sent() ||
7064                         self.context.channel_state.is_remote_shutdown_sent()
7065                 {
7066                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
7067                 }
7068                 let channel_total_msat = self.context.channel_value_satoshis * 1000;
7069                 if amount_msat > channel_total_msat {
7070                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
7071                 }
7072
7073                 if amount_msat == 0 {
7074                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
7075                 }
7076
7077                 let available_balances = self.context.get_available_balances(fee_estimator);
7078                 if amount_msat < available_balances.next_outbound_htlc_minimum_msat {
7079                         return Err(ChannelError::Ignore(format!("Cannot send less than our next-HTLC minimum - {} msat",
7080                                 available_balances.next_outbound_htlc_minimum_msat)));
7081                 }
7082
7083                 if amount_msat > available_balances.next_outbound_htlc_limit_msat {
7084                         return Err(ChannelError::Ignore(format!("Cannot send more than our next-HTLC maximum - {} msat",
7085                                 available_balances.next_outbound_htlc_limit_msat)));
7086                 }
7087
7088                 if self.context.channel_state.is_peer_disconnected() {
7089                         // Note that this should never really happen, if we're !is_live() on receipt of an
7090                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
7091                         // the user to send directly into a !is_live() channel. However, if we
7092                         // disconnected during the time the previous hop was doing the commitment dance we may
7093                         // end up getting here after the forwarding delay. In any case, returning an
7094                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
7095                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
7096                 }
7097
7098                 let need_holding_cell = !self.context.channel_state.can_generate_new_commitment();
7099                 log_debug!(logger, "Pushing new outbound HTLC with hash {} for {} msat {}",
7100                         payment_hash, amount_msat,
7101                         if force_holding_cell { "into holding cell" }
7102                         else if need_holding_cell { "into holding cell as we're awaiting an RAA or monitor" }
7103                         else { "to peer" });
7104
7105                 if need_holding_cell {
7106                         force_holding_cell = true;
7107                 }
7108
7109                 // Now update local state:
7110                 if force_holding_cell {
7111                         self.context.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
7112                                 amount_msat,
7113                                 payment_hash,
7114                                 cltv_expiry,
7115                                 source,
7116                                 onion_routing_packet,
7117                                 skimmed_fee_msat,
7118                                 blinding_point,
7119                         });
7120                         return Ok(None);
7121                 }
7122
7123                 self.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
7124                         htlc_id: self.context.next_holder_htlc_id,
7125                         amount_msat,
7126                         payment_hash: payment_hash.clone(),
7127                         cltv_expiry,
7128                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
7129                         source,
7130                         blinding_point,
7131                         skimmed_fee_msat,
7132                 });
7133
7134                 let res = msgs::UpdateAddHTLC {
7135                         channel_id: self.context.channel_id,
7136                         htlc_id: self.context.next_holder_htlc_id,
7137                         amount_msat,
7138                         payment_hash,
7139                         cltv_expiry,
7140                         onion_routing_packet,
7141                         skimmed_fee_msat,
7142                         blinding_point,
7143                 };
7144                 self.context.next_holder_htlc_id += 1;
7145
7146                 Ok(Some(res))
7147         }
7148
7149         fn build_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> ChannelMonitorUpdate where L::Target: Logger {
7150                 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
7151                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
7152                 // fail to generate this, we still are at least at a position where upgrading their status
7153                 // is acceptable.
7154                 for htlc in self.context.pending_inbound_htlcs.iter_mut() {
7155                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
7156                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
7157                         } else { None };
7158                         if let Some(state) = new_state {
7159                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", &htlc.payment_hash);
7160                                 htlc.state = state;
7161                         }
7162                 }
7163                 for htlc in self.context.pending_outbound_htlcs.iter_mut() {
7164                         if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut outcome) = &mut htlc.state {
7165                                 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", &htlc.payment_hash);
7166                                 // Grab the preimage, if it exists, instead of cloning
7167                                 let mut reason = OutboundHTLCOutcome::Success(None);
7168                                 mem::swap(outcome, &mut reason);
7169                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(reason);
7170                         }
7171                 }
7172                 if let Some((feerate, update_state)) = self.context.pending_update_fee {
7173                         if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
7174                                 debug_assert!(!self.context.is_outbound());
7175                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
7176                                 self.context.feerate_per_kw = feerate;
7177                                 self.context.pending_update_fee = None;
7178                         }
7179                 }
7180                 self.context.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
7181
7182                 let (mut htlcs_ref, counterparty_commitment_tx) =
7183                         self.build_commitment_no_state_update(logger);
7184                 let counterparty_commitment_txid = counterparty_commitment_tx.trust().txid();
7185                 let htlcs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
7186                         htlcs_ref.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
7187
7188                 if self.context.announcement_sigs_state == AnnouncementSigsState::MessageSent {
7189                         self.context.announcement_sigs_state = AnnouncementSigsState::Committed;
7190                 }
7191
7192                 self.context.latest_monitor_update_id += 1;
7193                 let monitor_update = ChannelMonitorUpdate {
7194                         update_id: self.context.latest_monitor_update_id,
7195                         counterparty_node_id: Some(self.context.counterparty_node_id),
7196                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
7197                                 commitment_txid: counterparty_commitment_txid,
7198                                 htlc_outputs: htlcs.clone(),
7199                                 commitment_number: self.context.cur_counterparty_commitment_transaction_number,
7200                                 their_per_commitment_point: self.context.counterparty_cur_commitment_point.unwrap(),
7201                                 feerate_per_kw: Some(counterparty_commitment_tx.feerate_per_kw()),
7202                                 to_broadcaster_value_sat: Some(counterparty_commitment_tx.to_broadcaster_value_sat()),
7203                                 to_countersignatory_value_sat: Some(counterparty_commitment_tx.to_countersignatory_value_sat()),
7204                         }],
7205                         channel_id: Some(self.context.channel_id()),
7206                 };
7207                 self.context.channel_state.set_awaiting_remote_revoke();
7208                 monitor_update
7209         }
7210
7211         fn build_commitment_no_state_update<L: Deref>(&self, logger: &L)
7212         -> (Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>, CommitmentTransaction)
7213         where L::Target: Logger
7214         {
7215                 let counterparty_keys = self.context.build_remote_transaction_keys();
7216                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
7217                 let counterparty_commitment_tx = commitment_stats.tx;
7218
7219                 #[cfg(any(test, fuzzing))]
7220                 {
7221                         if !self.context.is_outbound() {
7222                                 let projected_commit_tx_info = self.context.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
7223                                 *self.context.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
7224                                 if let Some(info) = projected_commit_tx_info {
7225                                         let total_pending_htlcs = self.context.pending_inbound_htlcs.len() + self.context.pending_outbound_htlcs.len();
7226                                         if info.total_pending_htlcs == total_pending_htlcs
7227                                                 && info.next_holder_htlc_id == self.context.next_holder_htlc_id
7228                                                 && info.next_counterparty_htlc_id == self.context.next_counterparty_htlc_id
7229                                                 && info.feerate == self.context.feerate_per_kw {
7230                                                         let actual_fee = commit_tx_fee_msat(self.context.feerate_per_kw, commitment_stats.num_nondust_htlcs, self.context.get_channel_type());
7231                                                         assert_eq!(actual_fee, info.fee);
7232                                                 }
7233                                 }
7234                         }
7235                 }
7236
7237                 (commitment_stats.htlcs_included, counterparty_commitment_tx)
7238         }
7239
7240         /// Only fails in case of signer rejection. Used for channel_reestablish commitment_signed
7241         /// generation when we shouldn't change HTLC/channel state.
7242         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
7243                 // Get the fee tests from `build_commitment_no_state_update`
7244                 #[cfg(any(test, fuzzing))]
7245                 self.build_commitment_no_state_update(logger);
7246
7247                 let counterparty_keys = self.context.build_remote_transaction_keys();
7248                 let commitment_stats = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
7249                 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
7250
7251                 match &self.context.holder_signer {
7252                         ChannelSignerType::Ecdsa(ecdsa) => {
7253                                 let (signature, htlc_signatures);
7254
7255                                 {
7256                                         let mut htlcs = Vec::with_capacity(commitment_stats.htlcs_included.len());
7257                                         for &(ref htlc, _) in commitment_stats.htlcs_included.iter() {
7258                                                 htlcs.push(htlc);
7259                                         }
7260
7261                                         let res = ecdsa.sign_counterparty_commitment(
7262                                                         &commitment_stats.tx,
7263                                                         commitment_stats.inbound_htlc_preimages,
7264                                                         commitment_stats.outbound_htlc_preimages,
7265                                                         &self.context.secp_ctx,
7266                                                 ).map_err(|_| ChannelError::Ignore("Failed to get signatures for new commitment_signed".to_owned()))?;
7267                                         signature = res.0;
7268                                         htlc_signatures = res.1;
7269
7270                                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
7271                                                 encode::serialize_hex(&commitment_stats.tx.trust().built_transaction().transaction),
7272                                                 &counterparty_commitment_txid, encode::serialize_hex(&self.context.get_funding_redeemscript()),
7273                                                 log_bytes!(signature.serialize_compact()[..]), &self.context.channel_id());
7274
7275                                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
7276                                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
7277                                                         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)),
7278                                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &self.context.channel_type, &counterparty_keys)),
7279                                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.to_public_key().serialize()),
7280                                                         log_bytes!(htlc_sig.serialize_compact()[..]), &self.context.channel_id());
7281                                         }
7282                                 }
7283
7284                                 Ok((msgs::CommitmentSigned {
7285                                         channel_id: self.context.channel_id,
7286                                         signature,
7287                                         htlc_signatures,
7288                                         #[cfg(taproot)]
7289                                         partial_signature_with_nonce: None,
7290                                 }, (counterparty_commitment_txid, commitment_stats.htlcs_included)))
7291                         },
7292                         // TODO (taproot|arik)
7293                         #[cfg(taproot)]
7294                         _ => todo!()
7295                 }
7296         }
7297
7298         /// Adds a pending outbound HTLC to this channel, and builds a new remote commitment
7299         /// transaction and generates the corresponding [`ChannelMonitorUpdate`] in one go.
7300         ///
7301         /// Shorthand for calling [`Self::send_htlc`] followed by a commitment update, see docs on
7302         /// [`Self::send_htlc`] and [`Self::build_commitment_no_state_update`] for more info.
7303         pub fn send_htlc_and_commit<F: Deref, L: Deref>(
7304                 &mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32,
7305                 source: HTLCSource, onion_routing_packet: msgs::OnionPacket, skimmed_fee_msat: Option<u64>,
7306                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L
7307         ) -> Result<Option<ChannelMonitorUpdate>, ChannelError>
7308         where F::Target: FeeEstimator, L::Target: Logger
7309         {
7310                 let send_res = self.send_htlc(amount_msat, payment_hash, cltv_expiry, source,
7311                         onion_routing_packet, false, skimmed_fee_msat, None, fee_estimator, logger);
7312                 if let Err(e) = &send_res { if let ChannelError::Ignore(_) = e {} else { debug_assert!(false, "Sending cannot trigger channel failure"); } }
7313                 match send_res? {
7314                         Some(_) => {
7315                                 let monitor_update = self.build_commitment_no_status_check(logger);
7316                                 self.monitor_updating_paused(false, true, false, Vec::new(), Vec::new(), Vec::new());
7317                                 Ok(self.push_ret_blockable_mon_update(monitor_update))
7318                         },
7319                         None => Ok(None)
7320                 }
7321         }
7322
7323         /// Applies the `ChannelUpdate` and returns a boolean indicating whether a change actually
7324         /// happened.
7325         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<bool, ChannelError> {
7326                 let new_forwarding_info = Some(CounterpartyForwardingInfo {
7327                         fee_base_msat: msg.contents.fee_base_msat,
7328                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
7329                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
7330                 });
7331                 let did_change = self.context.counterparty_forwarding_info != new_forwarding_info;
7332                 if did_change {
7333                         self.context.counterparty_forwarding_info = new_forwarding_info;
7334                 }
7335
7336                 Ok(did_change)
7337         }
7338
7339         /// Begins the shutdown process, getting a message for the remote peer and returning all
7340         /// holding cell HTLCs for payment failure.
7341         pub fn get_shutdown(&mut self, signer_provider: &SP, their_features: &InitFeatures,
7342                 target_feerate_sats_per_kw: Option<u32>, override_shutdown_script: Option<ShutdownScript>)
7343         -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
7344         {
7345                 for htlc in self.context.pending_outbound_htlcs.iter() {
7346                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
7347                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
7348                         }
7349                 }
7350                 if self.context.channel_state.is_local_shutdown_sent() {
7351                         return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
7352                 }
7353                 else if self.context.channel_state.is_remote_shutdown_sent() {
7354                         return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
7355                 }
7356                 if self.context.shutdown_scriptpubkey.is_some() && override_shutdown_script.is_some() {
7357                         return Err(APIError::APIMisuseError{err: "Cannot override shutdown script for a channel with one already set".to_owned()});
7358                 }
7359                 assert!(!matches!(self.context.channel_state, ChannelState::ShutdownComplete));
7360                 if self.context.channel_state.is_peer_disconnected() || self.context.channel_state.is_monitor_update_in_progress() {
7361                         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()});
7362                 }
7363
7364                 let update_shutdown_script = match self.context.shutdown_scriptpubkey {
7365                         Some(_) => false,
7366                         None => {
7367                                 // use override shutdown script if provided
7368                                 let shutdown_scriptpubkey = match override_shutdown_script {
7369                                         Some(script) => script,
7370                                         None => {
7371                                                 // otherwise, use the shutdown scriptpubkey provided by the signer
7372                                                 match signer_provider.get_shutdown_scriptpubkey() {
7373                                                         Ok(scriptpubkey) => scriptpubkey,
7374                                                         Err(_) => return Err(APIError::ChannelUnavailable{err: "Failed to get shutdown scriptpubkey".to_owned()}),
7375                                                 }
7376                                         },
7377                                 };
7378                                 if !shutdown_scriptpubkey.is_compatible(their_features) {
7379                                         return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
7380                                 }
7381                                 self.context.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
7382                                 true
7383                         },
7384                 };
7385
7386                 // From here on out, we may not fail!
7387                 self.context.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
7388                 self.context.channel_state.set_local_shutdown_sent();
7389                 self.context.local_initiated_shutdown = Some(());
7390                 self.context.update_time_counter += 1;
7391
7392                 let monitor_update = if update_shutdown_script {
7393                         self.context.latest_monitor_update_id += 1;
7394                         let monitor_update = ChannelMonitorUpdate {
7395                                 update_id: self.context.latest_monitor_update_id,
7396                                 counterparty_node_id: Some(self.context.counterparty_node_id),
7397                                 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
7398                                         scriptpubkey: self.get_closing_scriptpubkey(),
7399                                 }],
7400                                 channel_id: Some(self.context.channel_id()),
7401                         };
7402                         self.monitor_updating_paused(false, false, false, Vec::new(), Vec::new(), Vec::new());
7403                         self.push_ret_blockable_mon_update(monitor_update)
7404                 } else { None };
7405                 let shutdown = msgs::Shutdown {
7406                         channel_id: self.context.channel_id,
7407                         scriptpubkey: self.get_closing_scriptpubkey(),
7408                 };
7409
7410                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
7411                 // our shutdown until we've committed all of the pending changes.
7412                 self.context.holding_cell_update_fee = None;
7413                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.context.holding_cell_htlc_updates.len());
7414                 self.context.holding_cell_htlc_updates.retain(|htlc_update| {
7415                         match htlc_update {
7416                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
7417                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
7418                                         false
7419                                 },
7420                                 _ => true
7421                         }
7422                 });
7423
7424                 debug_assert!(!self.is_shutdown() || monitor_update.is_none(),
7425                         "we can't both complete shutdown and return a monitor update");
7426
7427                 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
7428         }
7429
7430         pub fn inflight_htlc_sources(&self) -> impl Iterator<Item=(&HTLCSource, &PaymentHash)> {
7431                 self.context.holding_cell_htlc_updates.iter()
7432                         .flat_map(|htlc_update| {
7433                                 match htlc_update {
7434                                         HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. }
7435                                                 => Some((source, payment_hash)),
7436                                         _ => None,
7437                                 }
7438                         })
7439                         .chain(self.context.pending_outbound_htlcs.iter().map(|htlc| (&htlc.source, &htlc.payment_hash)))
7440         }
7441 }
7442
7443 /// A not-yet-funded outbound (from holder) channel using V1 channel establishment.
7444 pub(super) struct OutboundV1Channel<SP: Deref> where SP::Target: SignerProvider {
7445         pub context: ChannelContext<SP>,
7446         pub unfunded_context: UnfundedChannelContext,
7447 }
7448
7449 impl<SP: Deref> OutboundV1Channel<SP> where SP::Target: SignerProvider {
7450         pub fn new<ES: Deref, F: Deref>(
7451                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP, counterparty_node_id: PublicKey, their_features: &InitFeatures,
7452                 channel_value_satoshis: u64, push_msat: u64, user_id: u128, config: &UserConfig, current_chain_height: u32,
7453                 outbound_scid_alias: u64, temporary_channel_id: Option<ChannelId>
7454         ) -> Result<OutboundV1Channel<SP>, APIError>
7455         where ES::Target: EntropySource,
7456               F::Target: FeeEstimator
7457         {
7458                 let holder_selected_channel_reserve_satoshis = get_holder_selected_channel_reserve_satoshis(channel_value_satoshis, config);
7459                 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
7460                         // Protocol level safety check in place, although it should never happen because
7461                         // of `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
7462                         return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below \
7463                                 implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
7464                 }
7465
7466                 let channel_keys_id = signer_provider.generate_channel_keys_id(false, channel_value_satoshis, user_id);
7467                 let holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
7468                 let pubkeys = holder_signer.pubkeys().clone();
7469
7470                 let chan = Self {
7471                         context: ChannelContext::new_for_outbound_channel(
7472                                 fee_estimator,
7473                                 entropy_source,
7474                                 signer_provider,
7475                                 counterparty_node_id,
7476                                 their_features,
7477                                 channel_value_satoshis,
7478                                 push_msat,
7479                                 user_id,
7480                                 config,
7481                                 current_chain_height,
7482                                 outbound_scid_alias,
7483                                 temporary_channel_id,
7484                                 holder_selected_channel_reserve_satoshis,
7485                                 channel_keys_id,
7486                                 holder_signer,
7487                                 pubkeys,
7488                         )?,
7489                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
7490                 };
7491                 Ok(chan)
7492         }
7493
7494         /// Only allowed after [`ChannelContext::channel_transaction_parameters`] is set.
7495         fn get_funding_created_msg<L: Deref>(&mut self, logger: &L) -> Option<msgs::FundingCreated> where L::Target: Logger {
7496                 let counterparty_keys = self.context.build_remote_transaction_keys();
7497                 let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
7498                 let signature = match &self.context.holder_signer {
7499                         // TODO (taproot|arik): move match into calling method for Taproot
7500                         ChannelSignerType::Ecdsa(ecdsa) => {
7501                                 ecdsa.sign_counterparty_commitment(&counterparty_initial_commitment_tx, Vec::new(), Vec::new(), &self.context.secp_ctx)
7502                                         .map(|(sig, _)| sig).ok()?
7503                         },
7504                         // TODO (taproot|arik)
7505                         #[cfg(taproot)]
7506                         _ => todo!()
7507                 };
7508
7509                 if self.context.signer_pending_funding {
7510                         log_trace!(logger, "Counterparty commitment signature ready for funding_created message: clearing signer_pending_funding");
7511                         self.context.signer_pending_funding = false;
7512                 }
7513
7514                 Some(msgs::FundingCreated {
7515                         temporary_channel_id: self.context.temporary_channel_id.unwrap(),
7516                         funding_txid: self.context.channel_transaction_parameters.funding_outpoint.as_ref().unwrap().txid,
7517                         funding_output_index: self.context.channel_transaction_parameters.funding_outpoint.as_ref().unwrap().index,
7518                         signature,
7519                         #[cfg(taproot)]
7520                         partial_signature_with_nonce: None,
7521                         #[cfg(taproot)]
7522                         next_local_nonce: None,
7523                 })
7524         }
7525
7526         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
7527         /// a funding_created message for the remote peer.
7528         /// Panics if called at some time other than immediately after initial handshake, if called twice,
7529         /// or if called on an inbound channel.
7530         /// Note that channel_id changes during this call!
7531         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
7532         /// If an Err is returned, it is a ChannelError::Close.
7533         pub fn get_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, is_batch_funding: bool, logger: &L)
7534         -> Result<Option<msgs::FundingCreated>, (Self, ChannelError)> where L::Target: Logger {
7535                 if !self.context.is_outbound() {
7536                         panic!("Tried to create outbound funding_created message on an inbound channel!");
7537                 }
7538                 if !matches!(
7539                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
7540                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
7541                 ) {
7542                         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)");
7543                 }
7544                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
7545                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
7546                                 self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
7547                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
7548                 }
7549
7550                 self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
7551                 self.context.holder_signer.as_mut().provide_channel_parameters(&self.context.channel_transaction_parameters);
7552
7553                 // Now that we're past error-generating stuff, update our local state:
7554
7555                 self.context.channel_state = ChannelState::FundingNegotiated;
7556                 self.context.channel_id = ChannelId::v1_from_funding_outpoint(funding_txo);
7557
7558                 // If the funding transaction is a coinbase transaction, we need to set the minimum depth to 100.
7559                 // We can skip this if it is a zero-conf channel.
7560                 if funding_transaction.is_coin_base() &&
7561                         self.context.minimum_depth.unwrap_or(0) > 0 &&
7562                         self.context.minimum_depth.unwrap_or(0) < COINBASE_MATURITY {
7563                         self.context.minimum_depth = Some(COINBASE_MATURITY);
7564                 }
7565
7566                 self.context.funding_transaction = Some(funding_transaction);
7567                 self.context.is_batch_funding = Some(()).filter(|_| is_batch_funding);
7568
7569                 let funding_created = self.get_funding_created_msg(logger);
7570                 if funding_created.is_none() {
7571                         #[cfg(not(async_signing))] {
7572                                 panic!("Failed to get signature for new funding creation");
7573                         }
7574                         #[cfg(async_signing)] {
7575                                 if !self.context.signer_pending_funding {
7576                                         log_trace!(logger, "funding_created awaiting signer; setting signer_pending_funding");
7577                                         self.context.signer_pending_funding = true;
7578                                 }
7579                         }
7580                 }
7581
7582                 Ok(funding_created)
7583         }
7584
7585         /// If we receive an error message, it may only be a rejection of the channel type we tried,
7586         /// not of our ability to open any channel at all. Thus, on error, we should first call this
7587         /// and see if we get a new `OpenChannel` message, otherwise the channel is failed.
7588         pub(crate) fn maybe_handle_error_without_close<F: Deref>(
7589                 &mut self, chain_hash: ChainHash, fee_estimator: &LowerBoundedFeeEstimator<F>
7590         ) -> Result<msgs::OpenChannel, ()>
7591         where
7592                 F::Target: FeeEstimator
7593         {
7594                 self.context.maybe_downgrade_channel_features(fee_estimator)?;
7595                 Ok(self.get_open_channel(chain_hash))
7596         }
7597
7598         /// Returns true if we can resume the channel by sending the [`msgs::OpenChannel`] again.
7599         pub fn is_resumable(&self) -> bool {
7600                 !self.context.have_received_message() &&
7601                         self.context.holder_commitment_point.transaction_number() == INITIAL_COMMITMENT_NUMBER
7602         }
7603
7604         pub fn get_open_channel(&self, chain_hash: ChainHash) -> msgs::OpenChannel {
7605                 if !self.context.is_outbound() {
7606                         panic!("Tried to open a channel for an inbound channel?");
7607                 }
7608                 if self.context.have_received_message() {
7609                         panic!("Cannot generate an open_channel after we've moved forward");
7610                 }
7611
7612                 if self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
7613                         panic!("Tried to send an open_channel for a channel that has already advanced");
7614                 }
7615
7616                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
7617                 let keys = self.context.get_holder_pubkeys();
7618
7619                 msgs::OpenChannel {
7620                         common_fields: msgs::CommonOpenChannelFields {
7621                                 chain_hash,
7622                                 temporary_channel_id: self.context.channel_id,
7623                                 funding_satoshis: self.context.channel_value_satoshis,
7624                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
7625                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
7626                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
7627                                 commitment_feerate_sat_per_1000_weight: self.context.feerate_per_kw as u32,
7628                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
7629                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
7630                                 funding_pubkey: keys.funding_pubkey,
7631                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
7632                                 payment_basepoint: keys.payment_point,
7633                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
7634                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
7635                                 first_per_commitment_point,
7636                                 channel_flags: if self.context.config.announced_channel {1} else {0},
7637                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
7638                                         Some(script) => script.clone().into_inner(),
7639                                         None => Builder::new().into_script(),
7640                                 }),
7641                                 channel_type: Some(self.context.channel_type.clone()),
7642                         },
7643                         push_msat: self.context.channel_value_satoshis * 1000 - self.context.value_to_self_msat,
7644                         channel_reserve_satoshis: self.context.holder_selected_channel_reserve_satoshis,
7645                 }
7646         }
7647
7648         // Message handlers
7649         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, default_limits: &ChannelHandshakeLimits, their_features: &InitFeatures) -> Result<(), ChannelError> {
7650                 let peer_limits = if let Some(ref limits) = self.context.inbound_handshake_limits_override { limits } else { default_limits };
7651
7652                 // Check sanity of message fields:
7653                 if !self.context.is_outbound() {
7654                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
7655                 }
7656                 if !matches!(self.context.channel_state, ChannelState::NegotiatingFunding(flags) if flags == NegotiatingFundingFlags::OUR_INIT_SENT) {
7657                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
7658                 }
7659                 if msg.common_fields.dust_limit_satoshis > 21000000 * 100000000 {
7660                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.common_fields.dust_limit_satoshis)));
7661                 }
7662                 if msg.channel_reserve_satoshis > self.context.channel_value_satoshis {
7663                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.context.channel_value_satoshis)));
7664                 }
7665                 if msg.common_fields.dust_limit_satoshis > self.context.holder_selected_channel_reserve_satoshis {
7666                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.common_fields.dust_limit_satoshis, self.context.holder_selected_channel_reserve_satoshis)));
7667                 }
7668                 if msg.channel_reserve_satoshis > self.context.channel_value_satoshis - self.context.holder_selected_channel_reserve_satoshis {
7669                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than channel value minus our reserve ({})",
7670                                 msg.channel_reserve_satoshis, self.context.channel_value_satoshis - self.context.holder_selected_channel_reserve_satoshis)));
7671                 }
7672                 let full_channel_value_msat = (self.context.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
7673                 if msg.common_fields.htlc_minimum_msat >= full_channel_value_msat {
7674                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.common_fields.htlc_minimum_msat, full_channel_value_msat)));
7675                 }
7676                 let max_delay_acceptable = u16::min(peer_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
7677                 if msg.common_fields.to_self_delay > max_delay_acceptable {
7678                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.common_fields.to_self_delay)));
7679                 }
7680                 if msg.common_fields.max_accepted_htlcs < 1 {
7681                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
7682                 }
7683                 if msg.common_fields.max_accepted_htlcs > MAX_HTLCS {
7684                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.common_fields.max_accepted_htlcs, MAX_HTLCS)));
7685                 }
7686
7687                 // Now check against optional parameters as set by config...
7688                 if msg.common_fields.htlc_minimum_msat > peer_limits.max_htlc_minimum_msat {
7689                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.common_fields.htlc_minimum_msat, peer_limits.max_htlc_minimum_msat)));
7690                 }
7691                 if msg.common_fields.max_htlc_value_in_flight_msat < peer_limits.min_max_htlc_value_in_flight_msat {
7692                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.common_fields.max_htlc_value_in_flight_msat, peer_limits.min_max_htlc_value_in_flight_msat)));
7693                 }
7694                 if msg.channel_reserve_satoshis > peer_limits.max_channel_reserve_satoshis {
7695                         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)));
7696                 }
7697                 if msg.common_fields.max_accepted_htlcs < peer_limits.min_max_accepted_htlcs {
7698                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.common_fields.max_accepted_htlcs, peer_limits.min_max_accepted_htlcs)));
7699                 }
7700                 if msg.common_fields.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
7701                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.common_fields.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
7702                 }
7703                 if msg.common_fields.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
7704                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.common_fields.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
7705                 }
7706                 if msg.common_fields.minimum_depth > peer_limits.max_minimum_depth {
7707                         return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", peer_limits.max_minimum_depth, msg.common_fields.minimum_depth)));
7708                 }
7709
7710                 if let Some(ty) = &msg.common_fields.channel_type {
7711                         if *ty != self.context.channel_type {
7712                                 return Err(ChannelError::Close("Channel Type in accept_channel didn't match the one sent in open_channel.".to_owned()));
7713                         }
7714                 } else if their_features.supports_channel_type() {
7715                         // Assume they've accepted the channel type as they said they understand it.
7716                 } else {
7717                         let channel_type = ChannelTypeFeatures::from_init(&their_features);
7718                         if channel_type != ChannelTypeFeatures::only_static_remote_key() {
7719                                 return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
7720                         }
7721                         self.context.channel_type = channel_type.clone();
7722                         self.context.channel_transaction_parameters.channel_type_features = channel_type;
7723                 }
7724
7725                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
7726                         match &msg.common_fields.shutdown_scriptpubkey {
7727                                 &Some(ref script) => {
7728                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
7729                                         if script.len() == 0 {
7730                                                 None
7731                                         } else {
7732                                                 if !script::is_bolt2_compliant(&script, their_features) {
7733                                                         return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
7734                                                 }
7735                                                 Some(script.clone())
7736                                         }
7737                                 },
7738                                 // 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
7739                                 &None => {
7740                                         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()));
7741                                 }
7742                         }
7743                 } else { None };
7744
7745                 self.context.counterparty_dust_limit_satoshis = msg.common_fields.dust_limit_satoshis;
7746                 self.context.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.common_fields.max_htlc_value_in_flight_msat, self.context.channel_value_satoshis * 1000);
7747                 self.context.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
7748                 self.context.counterparty_htlc_minimum_msat = msg.common_fields.htlc_minimum_msat;
7749                 self.context.counterparty_max_accepted_htlcs = msg.common_fields.max_accepted_htlcs;
7750
7751                 if peer_limits.trust_own_funding_0conf {
7752                         self.context.minimum_depth = Some(msg.common_fields.minimum_depth);
7753                 } else {
7754                         self.context.minimum_depth = Some(cmp::max(1, msg.common_fields.minimum_depth));
7755                 }
7756
7757                 let counterparty_pubkeys = ChannelPublicKeys {
7758                         funding_pubkey: msg.common_fields.funding_pubkey,
7759                         revocation_basepoint: RevocationBasepoint::from(msg.common_fields.revocation_basepoint),
7760                         payment_point: msg.common_fields.payment_basepoint,
7761                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(msg.common_fields.delayed_payment_basepoint),
7762                         htlc_basepoint: HtlcBasepoint::from(msg.common_fields.htlc_basepoint)
7763                 };
7764
7765                 self.context.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
7766                         selected_contest_delay: msg.common_fields.to_self_delay,
7767                         pubkeys: counterparty_pubkeys,
7768                 });
7769
7770                 self.context.counterparty_cur_commitment_point = Some(msg.common_fields.first_per_commitment_point);
7771                 self.context.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
7772
7773                 self.context.channel_state = ChannelState::NegotiatingFunding(
7774                         NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT
7775                 );
7776                 self.context.inbound_handshake_limits_override = None; // We're done enforcing limits on our peer's handshake now.
7777
7778                 Ok(())
7779         }
7780
7781         /// Handles a funding_signed message from the remote end.
7782         /// If this call is successful, broadcast the funding transaction (and not before!)
7783         pub fn funding_signed<L: Deref>(
7784                 mut self, msg: &msgs::FundingSigned, best_block: BestBlock, signer_provider: &SP, logger: &L
7785         ) -> Result<(Channel<SP>, ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>), (OutboundV1Channel<SP>, ChannelError)>
7786         where
7787                 L::Target: Logger
7788         {
7789                 if !self.context.is_outbound() {
7790                         return Err((self, ChannelError::Close("Received funding_signed for an inbound channel?".to_owned())));
7791                 }
7792                 if !matches!(self.context.channel_state, ChannelState::FundingNegotiated) {
7793                         return Err((self, ChannelError::Close("Received funding_signed in strange state!".to_owned())));
7794                 }
7795                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
7796                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
7797                                 self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
7798                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
7799                 }
7800
7801                 let funding_script = self.context.get_funding_redeemscript();
7802
7803                 let counterparty_keys = self.context.build_remote_transaction_keys();
7804                 let counterparty_initial_commitment_tx = self.context.build_commitment_transaction(self.context.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
7805                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
7806                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
7807
7808                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
7809                         &self.context.channel_id(), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
7810
7811                 let holder_signer = self.context.build_holder_transaction_keys(self.context.holder_commitment_point.transaction_number());
7812                 let initial_commitment_tx = self.context.build_commitment_transaction(self.context.holder_commitment_point.transaction_number(), &holder_signer, true, false, logger).tx;
7813                 {
7814                         let trusted_tx = initial_commitment_tx.trust();
7815                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
7816                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
7817                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
7818                         if let Err(_) = self.context.secp_ctx.verify_ecdsa(&sighash, &msg.signature, &self.context.get_counterparty_pubkeys().funding_pubkey) {
7819                                 return Err((self, ChannelError::Close("Invalid funding_signed signature from peer".to_owned())));
7820                         }
7821                 }
7822
7823                 let holder_commitment_tx = HolderCommitmentTransaction::new(
7824                         initial_commitment_tx,
7825                         msg.signature,
7826                         Vec::new(),
7827                         &self.context.get_holder_pubkeys().funding_pubkey,
7828                         self.context.counterparty_funding_pubkey()
7829                 );
7830
7831                 let validated =
7832                         self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, Vec::new());
7833                 if validated.is_err() {
7834                         return Err((self, ChannelError::Close("Failed to validate our commitment".to_owned())));
7835                 }
7836
7837                 let funding_redeemscript = self.context.get_funding_redeemscript();
7838                 let funding_txo = self.context.get_funding_txo().unwrap();
7839                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
7840                 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());
7841                 let shutdown_script = self.context.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
7842                 let mut monitor_signer = signer_provider.derive_channel_signer(self.context.channel_value_satoshis, self.context.channel_keys_id);
7843                 monitor_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
7844                 let channel_monitor = ChannelMonitor::new(self.context.secp_ctx.clone(), monitor_signer,
7845                                                           shutdown_script, self.context.get_holder_selected_contest_delay(),
7846                                                           &self.context.destination_script, (funding_txo, funding_txo_script),
7847                                                           &self.context.channel_transaction_parameters,
7848                                                           funding_redeemscript.clone(), self.context.channel_value_satoshis,
7849                                                           obscure_factor,
7850                                                           holder_commitment_tx, best_block, self.context.counterparty_node_id, self.context.channel_id());
7851                 channel_monitor.provide_initial_counterparty_commitment_tx(
7852                         counterparty_initial_bitcoin_tx.txid, Vec::new(),
7853                         self.context.cur_counterparty_commitment_transaction_number,
7854                         self.context.counterparty_cur_commitment_point.unwrap(),
7855                         counterparty_initial_commitment_tx.feerate_per_kw(),
7856                         counterparty_initial_commitment_tx.to_broadcaster_value_sat(),
7857                         counterparty_initial_commitment_tx.to_countersignatory_value_sat(), logger);
7858
7859                 assert!(!self.context.channel_state.is_monitor_update_in_progress()); // We have no had any monitor(s) yet to fail update!
7860                 if self.context.is_batch_funding() {
7861                         self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH);
7862                 } else {
7863                         self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new());
7864                 }
7865                 self.context.holder_commitment_point.advance(&self.context.holder_signer, &self.context.secp_ctx, logger);
7866                 self.context.cur_counterparty_commitment_transaction_number -= 1;
7867
7868                 log_info!(logger, "Received funding_signed from peer for channel {}", &self.context.channel_id());
7869
7870                 let mut channel = Channel {
7871                         context: self.context,
7872                         #[cfg(any(dual_funding, splicing))]
7873                         dual_funding_channel_context: None,
7874                 };
7875
7876                 let need_channel_ready = channel.check_get_channel_ready(0).is_some();
7877                 channel.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
7878                 Ok((channel, channel_monitor))
7879         }
7880
7881         /// Indicates that the signer may have some signatures for us, so we should retry if we're
7882         /// blocked.
7883         #[cfg(async_signing)]
7884         pub fn signer_maybe_unblocked<L: Deref>(&mut self, logger: &L) -> Option<msgs::FundingCreated> where L::Target: Logger {
7885                 if self.context.signer_pending_funding && self.context.is_outbound() {
7886                         log_trace!(logger, "Signer unblocked a funding_created");
7887                         self.get_funding_created_msg(logger)
7888                 } else { None }
7889         }
7890 }
7891
7892 /// A not-yet-funded inbound (from counterparty) channel using V1 channel establishment.
7893 pub(super) struct InboundV1Channel<SP: Deref> where SP::Target: SignerProvider {
7894         pub context: ChannelContext<SP>,
7895         pub unfunded_context: UnfundedChannelContext,
7896 }
7897
7898 /// Fetches the [`ChannelTypeFeatures`] that will be used for a channel built from a given
7899 /// [`msgs::CommonOpenChannelFields`].
7900 pub(super) fn channel_type_from_open_channel(
7901         common_fields: &msgs::CommonOpenChannelFields, their_features: &InitFeatures,
7902         our_supported_features: &ChannelTypeFeatures
7903 ) -> Result<ChannelTypeFeatures, ChannelError> {
7904         if let Some(channel_type) = &common_fields.channel_type {
7905                 if channel_type.supports_any_optional_bits() {
7906                         return Err(ChannelError::Close("Channel Type field contained optional bits - this is not allowed".to_owned()));
7907                 }
7908
7909                 // We only support the channel types defined by the `ChannelManager` in
7910                 // `provided_channel_type_features`. The channel type must always support
7911                 // `static_remote_key`.
7912                 if !channel_type.requires_static_remote_key() {
7913                         return Err(ChannelError::Close("Channel Type was not understood - we require static remote key".to_owned()));
7914                 }
7915                 // Make sure we support all of the features behind the channel type.
7916                 if !channel_type.is_subset(our_supported_features) {
7917                         return Err(ChannelError::Close("Channel Type contains unsupported features".to_owned()));
7918                 }
7919                 let announced_channel = if (common_fields.channel_flags & 1) == 1 { true } else { false };
7920                 if channel_type.requires_scid_privacy() && announced_channel {
7921                         return Err(ChannelError::Close("SCID Alias/Privacy Channel Type cannot be set on a public channel".to_owned()));
7922                 }
7923                 Ok(channel_type.clone())
7924         } else {
7925                 let channel_type = ChannelTypeFeatures::from_init(&their_features);
7926                 if channel_type != ChannelTypeFeatures::only_static_remote_key() {
7927                         return Err(ChannelError::Close("Only static_remote_key is supported for non-negotiated channel types".to_owned()));
7928                 }
7929                 Ok(channel_type)
7930         }
7931 }
7932
7933 impl<SP: Deref> InboundV1Channel<SP> where SP::Target: SignerProvider {
7934         /// Creates a new channel from a remote sides' request for one.
7935         /// Assumes chain_hash has already been checked and corresponds with what we expect!
7936         pub fn new<ES: Deref, F: Deref, L: Deref>(
7937                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
7938                 counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
7939                 their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u128, config: &UserConfig,
7940                 current_chain_height: u32, logger: &L, is_0conf: bool,
7941         ) -> Result<InboundV1Channel<SP>, ChannelError>
7942                 where ES::Target: EntropySource,
7943                           F::Target: FeeEstimator,
7944                           L::Target: Logger,
7945         {
7946                 let logger = WithContext::from(logger, Some(counterparty_node_id), Some(msg.common_fields.temporary_channel_id), None);
7947
7948                 // First check the channel type is known, failing before we do anything else if we don't
7949                 // support this channel type.
7950                 let channel_type = channel_type_from_open_channel(&msg.common_fields, their_features, our_supported_features)?;
7951
7952                 let holder_selected_channel_reserve_satoshis = get_holder_selected_channel_reserve_satoshis(msg.common_fields.funding_satoshis, config);
7953                 let counterparty_pubkeys = ChannelPublicKeys {
7954                         funding_pubkey: msg.common_fields.funding_pubkey,
7955                         revocation_basepoint: RevocationBasepoint::from(msg.common_fields.revocation_basepoint),
7956                         payment_point: msg.common_fields.payment_basepoint,
7957                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(msg.common_fields.delayed_payment_basepoint),
7958                         htlc_basepoint: HtlcBasepoint::from(msg.common_fields.htlc_basepoint)
7959                 };
7960
7961                 let chan = Self {
7962                         context: ChannelContext::new_for_inbound_channel(
7963                                 fee_estimator,
7964                                 entropy_source,
7965                                 signer_provider,
7966                                 counterparty_node_id,
7967                                 their_features,
7968                                 user_id,
7969                                 config,
7970                                 current_chain_height,
7971                                 &&logger,
7972                                 is_0conf,
7973                                 0,
7974
7975                                 counterparty_pubkeys,
7976                                 channel_type,
7977                                 holder_selected_channel_reserve_satoshis,
7978                                 msg.channel_reserve_satoshis,
7979                                 msg.push_msat,
7980                                 msg.common_fields.clone(),
7981                         )?,
7982                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 }
7983                 };
7984                 Ok(chan)
7985         }
7986
7987         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannel`] message which
7988         /// should be sent back to the counterparty node.
7989         ///
7990         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
7991         pub fn accept_inbound_channel(&mut self) -> msgs::AcceptChannel {
7992                 if self.context.is_outbound() {
7993                         panic!("Tried to send accept_channel for an outbound channel?");
7994                 }
7995                 if !matches!(
7996                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
7997                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
7998                 ) {
7999                         panic!("Tried to send accept_channel after channel had moved forward");
8000                 }
8001                 if self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
8002                         panic!("Tried to send an accept_channel for a channel that has already advanced");
8003                 }
8004
8005                 self.generate_accept_channel_message()
8006         }
8007
8008         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
8009         /// inbound channel. If the intention is to accept an inbound channel, use
8010         /// [`InboundV1Channel::accept_inbound_channel`] instead.
8011         ///
8012         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
8013         fn generate_accept_channel_message(&self) -> msgs::AcceptChannel {
8014                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
8015                 let keys = self.context.get_holder_pubkeys();
8016
8017                 msgs::AcceptChannel {
8018                         common_fields: msgs::CommonAcceptChannelFields {
8019                                 temporary_channel_id: self.context.channel_id,
8020                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
8021                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
8022                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
8023                                 minimum_depth: self.context.minimum_depth.unwrap(),
8024                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
8025                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
8026                                 funding_pubkey: keys.funding_pubkey,
8027                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
8028                                 payment_basepoint: keys.payment_point,
8029                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
8030                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
8031                                 first_per_commitment_point,
8032                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
8033                                         Some(script) => script.clone().into_inner(),
8034                                         None => Builder::new().into_script(),
8035                                 }),
8036                                 channel_type: Some(self.context.channel_type.clone()),
8037                         },
8038                         channel_reserve_satoshis: self.context.holder_selected_channel_reserve_satoshis,
8039                         #[cfg(taproot)]
8040                         next_local_nonce: None,
8041                 }
8042         }
8043
8044         /// Enables the possibility for tests to extract a [`msgs::AcceptChannel`] message for an
8045         /// inbound channel without accepting it.
8046         ///
8047         /// [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
8048         #[cfg(test)]
8049         pub fn get_accept_channel_message(&self) -> msgs::AcceptChannel {
8050                 self.generate_accept_channel_message()
8051         }
8052
8053         fn check_funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<CommitmentTransaction, ChannelError> where L::Target: Logger {
8054                 let funding_script = self.context.get_funding_redeemscript();
8055
8056                 let keys = self.context.build_holder_transaction_keys(self.context.holder_commitment_point.transaction_number());
8057                 let initial_commitment_tx = self.context.build_commitment_transaction(self.context.holder_commitment_point.transaction_number(), &keys, true, false, logger).tx;
8058                 let trusted_tx = initial_commitment_tx.trust();
8059                 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
8060                 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.context.channel_value_satoshis);
8061                 // They sign the holder commitment transaction...
8062                 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
8063                         log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.context.counterparty_funding_pubkey().serialize()),
8064                         encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
8065                         encode::serialize_hex(&funding_script), &self.context.channel_id());
8066                 secp_check!(self.context.secp_ctx.verify_ecdsa(&sighash, &sig, self.context.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
8067
8068                 Ok(initial_commitment_tx)
8069         }
8070
8071         pub fn funding_created<L: Deref>(
8072                 mut self, msg: &msgs::FundingCreated, best_block: BestBlock, signer_provider: &SP, logger: &L
8073         ) -> Result<(Channel<SP>, Option<msgs::FundingSigned>, ChannelMonitor<<SP::Target as SignerProvider>::EcdsaSigner>), (Self, ChannelError)>
8074         where
8075                 L::Target: Logger
8076         {
8077                 if self.context.is_outbound() {
8078                         return Err((self, ChannelError::Close("Received funding_created for an outbound channel?".to_owned())));
8079                 }
8080                 if !matches!(
8081                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
8082                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
8083                 ) {
8084                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
8085                         // remember the channel, so it's safe to just send an error_message here and drop the
8086                         // channel.
8087                         return Err((self, ChannelError::Close("Received funding_created after we got the channel!".to_owned())));
8088                 }
8089                 if self.context.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
8090                                 self.context.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
8091                                 self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
8092                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
8093                 }
8094
8095                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
8096                 self.context.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
8097                 // This is an externally observable change before we finish all our checks.  In particular
8098                 // check_funding_created_signature may fail.
8099                 self.context.holder_signer.as_mut().provide_channel_parameters(&self.context.channel_transaction_parameters);
8100
8101                 let initial_commitment_tx = match self.check_funding_created_signature(&msg.signature, logger) {
8102                         Ok(res) => res,
8103                         Err(ChannelError::Close(e)) => {
8104                                 self.context.channel_transaction_parameters.funding_outpoint = None;
8105                                 return Err((self, ChannelError::Close(e)));
8106                         },
8107                         Err(e) => {
8108                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
8109                                 // to make sure we don't continue with an inconsistent state.
8110                                 panic!("unexpected error type from check_funding_created_signature {:?}", e);
8111                         }
8112                 };
8113
8114                 let holder_commitment_tx = HolderCommitmentTransaction::new(
8115                         initial_commitment_tx,
8116                         msg.signature,
8117                         Vec::new(),
8118                         &self.context.get_holder_pubkeys().funding_pubkey,
8119                         self.context.counterparty_funding_pubkey()
8120                 );
8121
8122                 if let Err(_) = self.context.holder_signer.as_ref().validate_holder_commitment(&holder_commitment_tx, Vec::new()) {
8123                         return Err((self, ChannelError::Close("Failed to validate our commitment".to_owned())));
8124                 }
8125
8126                 // Now that we're past error-generating stuff, update our local state:
8127
8128                 self.context.channel_state = ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new());
8129                 self.context.channel_id = ChannelId::v1_from_funding_outpoint(funding_txo);
8130                 self.context.cur_counterparty_commitment_transaction_number -= 1;
8131                 self.context.holder_commitment_point.advance(&self.context.holder_signer, &self.context.secp_ctx, logger);
8132
8133                 let (counterparty_initial_commitment_tx, funding_signed) = self.context.get_funding_signed_msg(logger);
8134
8135                 let funding_redeemscript = self.context.get_funding_redeemscript();
8136                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
8137                 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());
8138                 let shutdown_script = self.context.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
8139                 let mut monitor_signer = signer_provider.derive_channel_signer(self.context.channel_value_satoshis, self.context.channel_keys_id);
8140                 monitor_signer.provide_channel_parameters(&self.context.channel_transaction_parameters);
8141                 let channel_monitor = ChannelMonitor::new(self.context.secp_ctx.clone(), monitor_signer,
8142                                                           shutdown_script, self.context.get_holder_selected_contest_delay(),
8143                                                           &self.context.destination_script, (funding_txo, funding_txo_script.clone()),
8144                                                           &self.context.channel_transaction_parameters,
8145                                                           funding_redeemscript.clone(), self.context.channel_value_satoshis,
8146                                                           obscure_factor,
8147                                                           holder_commitment_tx, best_block, self.context.counterparty_node_id, self.context.channel_id());
8148                 channel_monitor.provide_initial_counterparty_commitment_tx(
8149                         counterparty_initial_commitment_tx.trust().txid(), Vec::new(),
8150                         self.context.cur_counterparty_commitment_transaction_number + 1,
8151                         self.context.counterparty_cur_commitment_point.unwrap(), self.context.feerate_per_kw,
8152                         counterparty_initial_commitment_tx.to_broadcaster_value_sat(),
8153                         counterparty_initial_commitment_tx.to_countersignatory_value_sat(), logger);
8154
8155                 log_info!(logger, "{} funding_signed for peer for channel {}",
8156                         if funding_signed.is_some() { "Generated" } else { "Waiting for signature on" }, &self.context.channel_id());
8157
8158                 // Promote the channel to a full-fledged one now that we have updated the state and have a
8159                 // `ChannelMonitor`.
8160                 let mut channel = Channel {
8161                         context: self.context,
8162                         #[cfg(any(dual_funding, splicing))]
8163                         dual_funding_channel_context: None,
8164                 };
8165                 let need_channel_ready = channel.check_get_channel_ready(0).is_some();
8166                 channel.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
8167
8168                 Ok((channel, funding_signed, channel_monitor))
8169         }
8170 }
8171
8172 // A not-yet-funded outbound (from holder) channel using V2 channel establishment.
8173 #[cfg(any(dual_funding, splicing))]
8174 pub(super) struct OutboundV2Channel<SP: Deref> where SP::Target: SignerProvider {
8175         pub context: ChannelContext<SP>,
8176         pub unfunded_context: UnfundedChannelContext,
8177         #[cfg(any(dual_funding, splicing))]
8178         pub dual_funding_context: DualFundingChannelContext,
8179 }
8180
8181 #[cfg(any(dual_funding, splicing))]
8182 impl<SP: Deref> OutboundV2Channel<SP> where SP::Target: SignerProvider {
8183         pub fn new<ES: Deref, F: Deref>(
8184                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
8185                 counterparty_node_id: PublicKey, their_features: &InitFeatures, funding_satoshis: u64,
8186                 user_id: u128, config: &UserConfig, current_chain_height: u32, outbound_scid_alias: u64,
8187                 funding_confirmation_target: ConfirmationTarget,
8188         ) -> Result<OutboundV2Channel<SP>, APIError>
8189         where ES::Target: EntropySource,
8190               F::Target: FeeEstimator,
8191         {
8192                 let channel_keys_id = signer_provider.generate_channel_keys_id(false, funding_satoshis, user_id);
8193                 let holder_signer = signer_provider.derive_channel_signer(funding_satoshis, channel_keys_id);
8194                 let pubkeys = holder_signer.pubkeys().clone();
8195
8196                 let temporary_channel_id = Some(ChannelId::temporary_v2_from_revocation_basepoint(&pubkeys.revocation_basepoint));
8197
8198                 let holder_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8199                         funding_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
8200
8201                 let funding_feerate_sat_per_1000_weight = fee_estimator.bounded_sat_per_1000_weight(funding_confirmation_target);
8202                 let funding_tx_locktime = current_chain_height;
8203
8204                 let chan = Self {
8205                         context: ChannelContext::new_for_outbound_channel(
8206                                 fee_estimator,
8207                                 entropy_source,
8208                                 signer_provider,
8209                                 counterparty_node_id,
8210                                 their_features,
8211                                 funding_satoshis,
8212                                 0,
8213                                 user_id,
8214                                 config,
8215                                 current_chain_height,
8216                                 outbound_scid_alias,
8217                                 temporary_channel_id,
8218                                 holder_selected_channel_reserve_satoshis,
8219                                 channel_keys_id,
8220                                 holder_signer,
8221                                 pubkeys,
8222                         )?,
8223                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 },
8224                         dual_funding_context: DualFundingChannelContext {
8225                                 our_funding_satoshis: funding_satoshis,
8226                                 their_funding_satoshis: 0,
8227                                 funding_tx_locktime,
8228                                 funding_feerate_sat_per_1000_weight,
8229                         }
8230                 };
8231                 Ok(chan)
8232         }
8233
8234         /// If we receive an error message, it may only be a rejection of the channel type we tried,
8235         /// not of our ability to open any channel at all. Thus, on error, we should first call this
8236         /// and see if we get a new `OpenChannelV2` message, otherwise the channel is failed.
8237         pub(crate) fn maybe_handle_error_without_close<F: Deref>(
8238                 &mut self, chain_hash: ChainHash, fee_estimator: &LowerBoundedFeeEstimator<F>
8239         ) -> Result<msgs::OpenChannelV2, ()>
8240         where
8241                 F::Target: FeeEstimator
8242         {
8243                 self.context.maybe_downgrade_channel_features(fee_estimator)?;
8244                 Ok(self.get_open_channel_v2(chain_hash))
8245         }
8246
8247         pub fn get_open_channel_v2(&self, chain_hash: ChainHash) -> msgs::OpenChannelV2 {
8248                 if self.context.have_received_message() {
8249                         debug_assert!(false, "Cannot generate an open_channel2 after we've moved forward");
8250                 }
8251
8252                 if self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
8253                         debug_assert!(false, "Tried to send an open_channel2 for a channel that has already advanced");
8254                 }
8255
8256                 let first_per_commitment_point = self.context.holder_signer.as_ref()
8257                         .get_per_commitment_point(self.context.holder_commitment_point.transaction_number(),
8258                                 &self.context.secp_ctx);
8259                 let second_per_commitment_point = self.context.holder_signer.as_ref()
8260                         .get_per_commitment_point(self.context.holder_commitment_point.transaction_number() - 1,
8261                                 &self.context.secp_ctx);
8262                 let keys = self.context.get_holder_pubkeys();
8263
8264                 msgs::OpenChannelV2 {
8265                         common_fields: msgs::CommonOpenChannelFields {
8266                                 chain_hash,
8267                                 temporary_channel_id: self.context.temporary_channel_id.unwrap(),
8268                                 funding_satoshis: self.context.channel_value_satoshis,
8269                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
8270                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
8271                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
8272                                 commitment_feerate_sat_per_1000_weight: self.context.feerate_per_kw,
8273                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
8274                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
8275                                 funding_pubkey: keys.funding_pubkey,
8276                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
8277                                 payment_basepoint: keys.payment_point,
8278                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
8279                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
8280                                 first_per_commitment_point,
8281                                 channel_flags: if self.context.config.announced_channel {1} else {0},
8282                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
8283                                         Some(script) => script.clone().into_inner(),
8284                                         None => Builder::new().into_script(),
8285                                 }),
8286                                 channel_type: Some(self.context.channel_type.clone()),
8287                         },
8288                         funding_feerate_sat_per_1000_weight: self.context.feerate_per_kw,
8289                         second_per_commitment_point,
8290                         locktime: self.dual_funding_context.funding_tx_locktime,
8291                         require_confirmed_inputs: None,
8292                 }
8293         }
8294 }
8295
8296 // A not-yet-funded inbound (from counterparty) channel using V2 channel establishment.
8297 #[cfg(any(dual_funding, splicing))]
8298 pub(super) struct InboundV2Channel<SP: Deref> where SP::Target: SignerProvider {
8299         pub context: ChannelContext<SP>,
8300         pub unfunded_context: UnfundedChannelContext,
8301         pub dual_funding_context: DualFundingChannelContext,
8302 }
8303
8304 #[cfg(any(dual_funding, splicing))]
8305 impl<SP: Deref> InboundV2Channel<SP> where SP::Target: SignerProvider {
8306         /// Creates a new dual-funded channel from a remote side's request for one.
8307         /// Assumes chain_hash has already been checked and corresponds with what we expect!
8308         pub fn new<ES: Deref, F: Deref, L: Deref>(
8309                 fee_estimator: &LowerBoundedFeeEstimator<F>, entropy_source: &ES, signer_provider: &SP,
8310                 counterparty_node_id: PublicKey, our_supported_features: &ChannelTypeFeatures,
8311                 their_features: &InitFeatures, msg: &msgs::OpenChannelV2, funding_satoshis: u64, user_id: u128,
8312                 config: &UserConfig, current_chain_height: u32, logger: &L,
8313         ) -> Result<InboundV2Channel<SP>, ChannelError>
8314                 where ES::Target: EntropySource,
8315                           F::Target: FeeEstimator,
8316                           L::Target: Logger,
8317         {
8318                 let channel_value_satoshis = funding_satoshis.saturating_add(msg.common_fields.funding_satoshis);
8319                 let counterparty_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8320                         channel_value_satoshis, msg.common_fields.dust_limit_satoshis);
8321                 let holder_selected_channel_reserve_satoshis = get_v2_channel_reserve_satoshis(
8322                         channel_value_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
8323
8324                 // First check the channel type is known, failing before we do anything else if we don't
8325                 // support this channel type.
8326                 if msg.common_fields.channel_type.is_none() {
8327                         return Err(ChannelError::Close(format!("Rejecting V2 channel {} missing channel_type",
8328                                 msg.common_fields.temporary_channel_id)))
8329                 }
8330                 let channel_type = channel_type_from_open_channel(&msg.common_fields, their_features, our_supported_features)?;
8331
8332                 let counterparty_pubkeys = ChannelPublicKeys {
8333                         funding_pubkey: msg.common_fields.funding_pubkey,
8334                         revocation_basepoint: RevocationBasepoint(msg.common_fields.revocation_basepoint),
8335                         payment_point: msg.common_fields.payment_basepoint,
8336                         delayed_payment_basepoint: DelayedPaymentBasepoint(msg.common_fields.delayed_payment_basepoint),
8337                         htlc_basepoint: HtlcBasepoint(msg.common_fields.htlc_basepoint)
8338                 };
8339
8340                 let mut context = ChannelContext::new_for_inbound_channel(
8341                         fee_estimator,
8342                         entropy_source,
8343                         signer_provider,
8344                         counterparty_node_id,
8345                         their_features,
8346                         user_id,
8347                         config,
8348                         current_chain_height,
8349                         logger,
8350                         false,
8351
8352                         funding_satoshis,
8353
8354                         counterparty_pubkeys,
8355                         channel_type,
8356                         holder_selected_channel_reserve_satoshis,
8357                         counterparty_selected_channel_reserve_satoshis,
8358                         0 /* push_msat not used in dual-funding */,
8359                         msg.common_fields.clone(),
8360                 )?;
8361                 let channel_id = ChannelId::v2_from_revocation_basepoints(
8362                         &context.get_holder_pubkeys().revocation_basepoint,
8363                         &context.get_counterparty_pubkeys().revocation_basepoint);
8364                 context.channel_id = channel_id;
8365
8366                 let chan = Self {
8367                         context,
8368                         unfunded_context: UnfundedChannelContext { unfunded_channel_age_ticks: 0 },
8369                         dual_funding_context: DualFundingChannelContext {
8370                                 our_funding_satoshis: funding_satoshis,
8371                                 their_funding_satoshis: msg.common_fields.funding_satoshis,
8372                                 funding_tx_locktime: msg.locktime,
8373                                 funding_feerate_sat_per_1000_weight: msg.funding_feerate_sat_per_1000_weight,
8374                         }
8375                 };
8376
8377                 Ok(chan)
8378         }
8379
8380         /// Marks an inbound channel as accepted and generates a [`msgs::AcceptChannelV2`] message which
8381         /// should be sent back to the counterparty node.
8382         ///
8383         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8384         pub fn accept_inbound_dual_funded_channel(&mut self) -> msgs::AcceptChannelV2 {
8385                 if self.context.is_outbound() {
8386                         debug_assert!(false, "Tried to send accept_channel for an outbound channel?");
8387                 }
8388                 if !matches!(
8389                         self.context.channel_state, ChannelState::NegotiatingFunding(flags)
8390                         if flags == (NegotiatingFundingFlags::OUR_INIT_SENT | NegotiatingFundingFlags::THEIR_INIT_SENT)
8391                 ) {
8392                         debug_assert!(false, "Tried to send accept_channel2 after channel had moved forward");
8393                 }
8394                 if self.context.holder_commitment_point.transaction_number() != INITIAL_COMMITMENT_NUMBER {
8395                         debug_assert!(false, "Tried to send an accept_channel2 for a channel that has already advanced");
8396                 }
8397
8398                 self.generate_accept_channel_v2_message()
8399         }
8400
8401         /// This function is used to explicitly generate a [`msgs::AcceptChannel`] message for an
8402         /// inbound channel. If the intention is to accept an inbound channel, use
8403         /// [`InboundV1Channel::accept_inbound_channel`] instead.
8404         ///
8405         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8406         fn generate_accept_channel_v2_message(&self) -> msgs::AcceptChannelV2 {
8407                 let first_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(
8408                         self.context.holder_commitment_point.transaction_number(), &self.context.secp_ctx);
8409                 let second_per_commitment_point = self.context.holder_signer.as_ref().get_per_commitment_point(
8410                         self.context.holder_commitment_point.transaction_number() - 1, &self.context.secp_ctx);
8411                 let keys = self.context.get_holder_pubkeys();
8412
8413                 msgs::AcceptChannelV2 {
8414                         common_fields: msgs::CommonAcceptChannelFields {
8415                                 temporary_channel_id: self.context.temporary_channel_id.unwrap(),
8416                                 dust_limit_satoshis: self.context.holder_dust_limit_satoshis,
8417                                 max_htlc_value_in_flight_msat: self.context.holder_max_htlc_value_in_flight_msat,
8418                                 htlc_minimum_msat: self.context.holder_htlc_minimum_msat,
8419                                 minimum_depth: self.context.minimum_depth.unwrap(),
8420                                 to_self_delay: self.context.get_holder_selected_contest_delay(),
8421                                 max_accepted_htlcs: self.context.holder_max_accepted_htlcs,
8422                                 funding_pubkey: keys.funding_pubkey,
8423                                 revocation_basepoint: keys.revocation_basepoint.to_public_key(),
8424                                 payment_basepoint: keys.payment_point,
8425                                 delayed_payment_basepoint: keys.delayed_payment_basepoint.to_public_key(),
8426                                 htlc_basepoint: keys.htlc_basepoint.to_public_key(),
8427                                 first_per_commitment_point,
8428                                 shutdown_scriptpubkey: Some(match &self.context.shutdown_scriptpubkey {
8429                                         Some(script) => script.clone().into_inner(),
8430                                         None => Builder::new().into_script(),
8431                                 }),
8432                                 channel_type: Some(self.context.channel_type.clone()),
8433                         },
8434                         funding_satoshis: self.dual_funding_context.our_funding_satoshis,
8435                         second_per_commitment_point,
8436                         require_confirmed_inputs: None,
8437                 }
8438         }
8439
8440         /// Enables the possibility for tests to extract a [`msgs::AcceptChannelV2`] message for an
8441         /// inbound channel without accepting it.
8442         ///
8443         /// [`msgs::AcceptChannelV2`]: crate::ln::msgs::AcceptChannelV2
8444         #[cfg(test)]
8445         pub fn get_accept_channel_v2_message(&self) -> msgs::AcceptChannelV2 {
8446                 self.generate_accept_channel_v2_message()
8447         }
8448 }
8449
8450 // Unfunded channel utilities
8451
8452 fn get_initial_channel_type(config: &UserConfig, their_features: &InitFeatures) -> ChannelTypeFeatures {
8453         // The default channel type (ie the first one we try) depends on whether the channel is
8454         // public - if it is, we just go with `only_static_remotekey` as it's the only option
8455         // available. If it's private, we first try `scid_privacy` as it provides better privacy
8456         // with no other changes, and fall back to `only_static_remotekey`.
8457         let mut ret = ChannelTypeFeatures::only_static_remote_key();
8458         if !config.channel_handshake_config.announced_channel &&
8459                 config.channel_handshake_config.negotiate_scid_privacy &&
8460                 their_features.supports_scid_privacy() {
8461                 ret.set_scid_privacy_required();
8462         }
8463
8464         // Optionally, if the user would like to negotiate the `anchors_zero_fee_htlc_tx` option, we
8465         // set it now. If they don't understand it, we'll fall back to our default of
8466         // `only_static_remotekey`.
8467         if config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx &&
8468                 their_features.supports_anchors_zero_fee_htlc_tx() {
8469                 ret.set_anchors_zero_fee_htlc_tx_required();
8470         }
8471
8472         ret
8473 }
8474
8475 const SERIALIZATION_VERSION: u8 = 4;
8476 const MIN_SERIALIZATION_VERSION: u8 = 3;
8477
8478 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
8479         (0, FailRelay),
8480         (1, FailMalformed),
8481         (2, Fulfill),
8482 );
8483
8484 impl Writeable for ChannelUpdateStatus {
8485         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8486                 // We only care about writing out the current state as it was announced, ie only either
8487                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
8488                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
8489                 match self {
8490                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
8491                         ChannelUpdateStatus::DisabledStaged(_) => 0u8.write(writer)?,
8492                         ChannelUpdateStatus::EnabledStaged(_) => 1u8.write(writer)?,
8493                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
8494                 }
8495                 Ok(())
8496         }
8497 }
8498
8499 impl Readable for ChannelUpdateStatus {
8500         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
8501                 Ok(match <u8 as Readable>::read(reader)? {
8502                         0 => ChannelUpdateStatus::Enabled,
8503                         1 => ChannelUpdateStatus::Disabled,
8504                         _ => return Err(DecodeError::InvalidValue),
8505                 })
8506         }
8507 }
8508
8509 impl Writeable for AnnouncementSigsState {
8510         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8511                 // We only care about writing out the current state as if we had just disconnected, at
8512                 // which point we always set anything but AnnouncementSigsReceived to NotSent.
8513                 match self {
8514                         AnnouncementSigsState::NotSent => 0u8.write(writer),
8515                         AnnouncementSigsState::MessageSent => 0u8.write(writer),
8516                         AnnouncementSigsState::Committed => 0u8.write(writer),
8517                         AnnouncementSigsState::PeerReceived => 1u8.write(writer),
8518                 }
8519         }
8520 }
8521
8522 impl Readable for AnnouncementSigsState {
8523         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
8524                 Ok(match <u8 as Readable>::read(reader)? {
8525                         0 => AnnouncementSigsState::NotSent,
8526                         1 => AnnouncementSigsState::PeerReceived,
8527                         _ => return Err(DecodeError::InvalidValue),
8528                 })
8529         }
8530 }
8531
8532 impl<SP: Deref> Writeable for Channel<SP> where SP::Target: SignerProvider {
8533         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
8534                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
8535                 // called.
8536
8537                 let version_to_write = if self.context.pending_inbound_htlcs.iter().any(|htlc| match htlc.state {
8538                         InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_resolution)|
8539                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_resolution) => {
8540                                 matches!(htlc_resolution, InboundHTLCResolution::Pending { .. })
8541                         },
8542                         _ => false,
8543                 }) {
8544                         SERIALIZATION_VERSION
8545                 } else {
8546                         MIN_SERIALIZATION_VERSION
8547                 };
8548                 write_ver_prefix!(writer, version_to_write, MIN_SERIALIZATION_VERSION);
8549
8550                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8551                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We write
8552                 // the low bytes now and the optional high bytes later.
8553                 let user_id_low = self.context.user_id as u64;
8554                 user_id_low.write(writer)?;
8555
8556                 // Version 1 deserializers expected to read parts of the config object here. Version 2
8557                 // deserializers (0.0.99) now read config through TLVs, and as we now require them for
8558                 // `minimum_depth` we simply write dummy values here.
8559                 writer.write_all(&[0; 8])?;
8560
8561                 self.context.channel_id.write(writer)?;
8562                 {
8563                         let mut channel_state = self.context.channel_state;
8564                         if matches!(channel_state, ChannelState::AwaitingChannelReady(_)|ChannelState::ChannelReady(_)) {
8565                                 channel_state.set_peer_disconnected();
8566                         } else {
8567                                 debug_assert!(false, "Pre-funded/shutdown channels should not be written");
8568                         }
8569                         channel_state.to_u32().write(writer)?;
8570                 }
8571                 self.context.channel_value_satoshis.write(writer)?;
8572
8573                 self.context.latest_monitor_update_id.write(writer)?;
8574
8575                 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
8576                 // deserialized from that format.
8577                 match self.context.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
8578                         Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
8579                         None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
8580                 }
8581                 self.context.destination_script.write(writer)?;
8582
8583                 self.context.holder_commitment_point.transaction_number().write(writer)?;
8584                 self.context.cur_counterparty_commitment_transaction_number.write(writer)?;
8585                 self.context.value_to_self_msat.write(writer)?;
8586
8587                 let mut dropped_inbound_htlcs = 0;
8588                 for htlc in self.context.pending_inbound_htlcs.iter() {
8589                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
8590                                 dropped_inbound_htlcs += 1;
8591                         }
8592                 }
8593                 (self.context.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
8594                 for htlc in self.context.pending_inbound_htlcs.iter() {
8595                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
8596                                 continue; // Drop
8597                         }
8598                         htlc.htlc_id.write(writer)?;
8599                         htlc.amount_msat.write(writer)?;
8600                         htlc.cltv_expiry.write(writer)?;
8601                         htlc.payment_hash.write(writer)?;
8602                         match &htlc.state {
8603                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
8604                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_resolution) => {
8605                                         1u8.write(writer)?;
8606                                         if version_to_write <= 3 {
8607                                                 if let InboundHTLCResolution::Resolved { pending_htlc_status } = htlc_resolution {
8608                                                         pending_htlc_status.write(writer)?;
8609                                                 } else {
8610                                                         panic!();
8611                                                 }
8612                                         } else {
8613                                                 htlc_resolution.write(writer)?;
8614                                         }
8615                                 },
8616                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_resolution) => {
8617                                         2u8.write(writer)?;
8618                                         if version_to_write <= 3 {
8619                                                 if let InboundHTLCResolution::Resolved { pending_htlc_status } = htlc_resolution {
8620                                                         pending_htlc_status.write(writer)?;
8621                                                 } else {
8622                                                         panic!();
8623                                                 }
8624                                         } else {
8625                                                 htlc_resolution.write(writer)?;
8626                                         }
8627                                 },
8628                                 &InboundHTLCState::Committed => {
8629                                         3u8.write(writer)?;
8630                                 },
8631                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
8632                                         4u8.write(writer)?;
8633                                         removal_reason.write(writer)?;
8634                                 },
8635                         }
8636                 }
8637
8638                 let mut preimages: Vec<&Option<PaymentPreimage>> = vec![];
8639                 let mut pending_outbound_skimmed_fees: Vec<Option<u64>> = Vec::new();
8640                 let mut pending_outbound_blinding_points: Vec<Option<PublicKey>> = Vec::new();
8641
8642                 (self.context.pending_outbound_htlcs.len() as u64).write(writer)?;
8643                 for htlc in self.context.pending_outbound_htlcs.iter() {
8644                         htlc.htlc_id.write(writer)?;
8645                         htlc.amount_msat.write(writer)?;
8646                         htlc.cltv_expiry.write(writer)?;
8647                         htlc.payment_hash.write(writer)?;
8648                         htlc.source.write(writer)?;
8649                         match &htlc.state {
8650                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
8651                                         0u8.write(writer)?;
8652                                         onion_packet.write(writer)?;
8653                                 },
8654                                 &OutboundHTLCState::Committed => {
8655                                         1u8.write(writer)?;
8656                                 },
8657                                 &OutboundHTLCState::RemoteRemoved(_) => {
8658                                         // Treat this as a Committed because we haven't received the CS - they'll
8659                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
8660                                         1u8.write(writer)?;
8661                                 },
8662                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref outcome) => {
8663                                         3u8.write(writer)?;
8664                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
8665                                                 preimages.push(preimage);
8666                                         }
8667                                         let reason: Option<&HTLCFailReason> = outcome.into();
8668                                         reason.write(writer)?;
8669                                 }
8670                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref outcome) => {
8671                                         4u8.write(writer)?;
8672                                         if let OutboundHTLCOutcome::Success(preimage) = outcome {
8673                                                 preimages.push(preimage);
8674                                         }
8675                                         let reason: Option<&HTLCFailReason> = outcome.into();
8676                                         reason.write(writer)?;
8677                                 }
8678                         }
8679                         pending_outbound_skimmed_fees.push(htlc.skimmed_fee_msat);
8680                         pending_outbound_blinding_points.push(htlc.blinding_point);
8681                 }
8682
8683                 let mut holding_cell_skimmed_fees: Vec<Option<u64>> = Vec::new();
8684                 let mut holding_cell_blinding_points: Vec<Option<PublicKey>> = Vec::new();
8685                 // Vec of (htlc_id, failure_code, sha256_of_onion)
8686                 let mut malformed_htlcs: Vec<(u64, u16, [u8; 32])> = Vec::new();
8687                 (self.context.holding_cell_htlc_updates.len() as u64).write(writer)?;
8688                 for update in self.context.holding_cell_htlc_updates.iter() {
8689                         match update {
8690                                 &HTLCUpdateAwaitingACK::AddHTLC {
8691                                         ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet,
8692                                         blinding_point, skimmed_fee_msat,
8693                                 } => {
8694                                         0u8.write(writer)?;
8695                                         amount_msat.write(writer)?;
8696                                         cltv_expiry.write(writer)?;
8697                                         payment_hash.write(writer)?;
8698                                         source.write(writer)?;
8699                                         onion_routing_packet.write(writer)?;
8700
8701                                         holding_cell_skimmed_fees.push(skimmed_fee_msat);
8702                                         holding_cell_blinding_points.push(blinding_point);
8703                                 },
8704                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
8705                                         1u8.write(writer)?;
8706                                         payment_preimage.write(writer)?;
8707                                         htlc_id.write(writer)?;
8708                                 },
8709                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
8710                                         2u8.write(writer)?;
8711                                         htlc_id.write(writer)?;
8712                                         err_packet.write(writer)?;
8713                                 }
8714                                 &HTLCUpdateAwaitingACK::FailMalformedHTLC {
8715                                         htlc_id, failure_code, sha256_of_onion
8716                                 } => {
8717                                         // We don't want to break downgrading by adding a new variant, so write a dummy
8718                                         // `::FailHTLC` variant and write the real malformed error as an optional TLV.
8719                                         malformed_htlcs.push((htlc_id, failure_code, sha256_of_onion));
8720
8721                                         let dummy_err_packet = msgs::OnionErrorPacket { data: Vec::new() };
8722                                         2u8.write(writer)?;
8723                                         htlc_id.write(writer)?;
8724                                         dummy_err_packet.write(writer)?;
8725                                 }
8726                         }
8727                 }
8728
8729                 match self.context.resend_order {
8730                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
8731                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
8732                 }
8733
8734                 self.context.monitor_pending_channel_ready.write(writer)?;
8735                 self.context.monitor_pending_revoke_and_ack.write(writer)?;
8736                 self.context.monitor_pending_commitment_signed.write(writer)?;
8737
8738                 (self.context.monitor_pending_forwards.len() as u64).write(writer)?;
8739                 for &(ref pending_forward, ref htlc_id) in self.context.monitor_pending_forwards.iter() {
8740                         pending_forward.write(writer)?;
8741                         htlc_id.write(writer)?;
8742                 }
8743
8744                 (self.context.monitor_pending_failures.len() as u64).write(writer)?;
8745                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.context.monitor_pending_failures.iter() {
8746                         htlc_source.write(writer)?;
8747                         payment_hash.write(writer)?;
8748                         fail_reason.write(writer)?;
8749                 }
8750
8751                 if self.context.is_outbound() {
8752                         self.context.pending_update_fee.map(|(a, _)| a).write(writer)?;
8753                 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.context.pending_update_fee {
8754                         Some(feerate).write(writer)?;
8755                 } else {
8756                         // As for inbound HTLCs, if the update was only announced and never committed in a
8757                         // commitment_signed, drop it.
8758                         None::<u32>.write(writer)?;
8759                 }
8760                 self.context.holding_cell_update_fee.write(writer)?;
8761
8762                 self.context.next_holder_htlc_id.write(writer)?;
8763                 (self.context.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
8764                 self.context.update_time_counter.write(writer)?;
8765                 self.context.feerate_per_kw.write(writer)?;
8766
8767                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
8768                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
8769                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
8770                 // consider the stale state on reload.
8771                 0u8.write(writer)?;
8772
8773                 self.context.funding_tx_confirmed_in.write(writer)?;
8774                 self.context.funding_tx_confirmation_height.write(writer)?;
8775                 self.context.short_channel_id.write(writer)?;
8776
8777                 self.context.counterparty_dust_limit_satoshis.write(writer)?;
8778                 self.context.holder_dust_limit_satoshis.write(writer)?;
8779                 self.context.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
8780
8781                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
8782                 self.context.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
8783
8784                 self.context.counterparty_htlc_minimum_msat.write(writer)?;
8785                 self.context.holder_htlc_minimum_msat.write(writer)?;
8786                 self.context.counterparty_max_accepted_htlcs.write(writer)?;
8787
8788                 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
8789                 self.context.minimum_depth.unwrap_or(0).write(writer)?;
8790
8791                 match &self.context.counterparty_forwarding_info {
8792                         Some(info) => {
8793                                 1u8.write(writer)?;
8794                                 info.fee_base_msat.write(writer)?;
8795                                 info.fee_proportional_millionths.write(writer)?;
8796                                 info.cltv_expiry_delta.write(writer)?;
8797                         },
8798                         None => 0u8.write(writer)?
8799                 }
8800
8801                 self.context.channel_transaction_parameters.write(writer)?;
8802                 self.context.funding_transaction.write(writer)?;
8803
8804                 self.context.counterparty_cur_commitment_point.write(writer)?;
8805                 self.context.counterparty_prev_commitment_point.write(writer)?;
8806                 self.context.counterparty_node_id.write(writer)?;
8807
8808                 self.context.counterparty_shutdown_scriptpubkey.write(writer)?;
8809
8810                 self.context.commitment_secrets.write(writer)?;
8811
8812                 self.context.channel_update_status.write(writer)?;
8813
8814                 #[cfg(any(test, fuzzing))]
8815                 (self.context.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
8816                 #[cfg(any(test, fuzzing))]
8817                 for htlc in self.context.historical_inbound_htlc_fulfills.iter() {
8818                         htlc.write(writer)?;
8819                 }
8820
8821                 // If the channel type is something other than only-static-remote-key, then we need to have
8822                 // older clients fail to deserialize this channel at all. If the type is
8823                 // only-static-remote-key, we simply consider it "default" and don't write the channel type
8824                 // out at all.
8825                 let chan_type = if self.context.channel_type != ChannelTypeFeatures::only_static_remote_key() {
8826                         Some(&self.context.channel_type) } else { None };
8827
8828                 // The same logic applies for `holder_selected_channel_reserve_satoshis` values other than
8829                 // the default, and when `holder_max_htlc_value_in_flight_msat` is configured to be set to
8830                 // a different percentage of the channel value then 10%, which older versions of LDK used
8831                 // to set it to before the percentage was made configurable.
8832                 let serialized_holder_selected_reserve =
8833                         if self.context.holder_selected_channel_reserve_satoshis != get_legacy_default_holder_selected_channel_reserve_satoshis(self.context.channel_value_satoshis)
8834                         { Some(self.context.holder_selected_channel_reserve_satoshis) } else { None };
8835
8836                 let mut old_max_in_flight_percent_config = UserConfig::default().channel_handshake_config;
8837                 old_max_in_flight_percent_config.max_inbound_htlc_value_in_flight_percent_of_channel = MAX_IN_FLIGHT_PERCENT_LEGACY;
8838                 let serialized_holder_htlc_max_in_flight =
8839                         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)
8840                         { Some(self.context.holder_max_htlc_value_in_flight_msat) } else { None };
8841
8842                 let channel_pending_event_emitted = Some(self.context.channel_pending_event_emitted);
8843                 let channel_ready_event_emitted = Some(self.context.channel_ready_event_emitted);
8844
8845                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8846                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. Therefore,
8847                 // we write the high bytes as an option here.
8848                 let user_id_high_opt = Some((self.context.user_id >> 64) as u64);
8849
8850                 let holder_max_accepted_htlcs = if self.context.holder_max_accepted_htlcs == DEFAULT_MAX_HTLCS { None } else { Some(self.context.holder_max_accepted_htlcs) };
8851
8852                 let mut monitor_pending_update_adds = None;
8853                 if !self.context.monitor_pending_update_adds.is_empty() {
8854                         monitor_pending_update_adds = Some(&self.context.monitor_pending_update_adds);
8855                 }
8856
8857                 // `current_point` will become optional when async signing is implemented.
8858                 let cur_holder_commitment_point = Some(self.context.holder_commitment_point.current_point());
8859                 let next_holder_commitment_point = self.context.holder_commitment_point.next_point();
8860
8861                 write_tlv_fields!(writer, {
8862                         (0, self.context.announcement_sigs, option),
8863                         // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
8864                         // default value instead of being Option<>al. Thus, to maintain compatibility we write
8865                         // them twice, once with their original default values above, and once as an option
8866                         // here. On the read side, old versions will simply ignore the odd-type entries here,
8867                         // and new versions map the default values to None and allow the TLV entries here to
8868                         // override that.
8869                         (1, self.context.minimum_depth, option),
8870                         (2, chan_type, option),
8871                         (3, self.context.counterparty_selected_channel_reserve_satoshis, option),
8872                         (4, serialized_holder_selected_reserve, option),
8873                         (5, self.context.config, required),
8874                         (6, serialized_holder_htlc_max_in_flight, option),
8875                         (7, self.context.shutdown_scriptpubkey, option),
8876                         (8, self.context.blocked_monitor_updates, optional_vec),
8877                         (9, self.context.target_closing_feerate_sats_per_kw, option),
8878                         (10, monitor_pending_update_adds, option), // Added in 0.0.122
8879                         (11, self.context.monitor_pending_finalized_fulfills, required_vec),
8880                         (13, self.context.channel_creation_height, required),
8881                         (15, preimages, required_vec),
8882                         (17, self.context.announcement_sigs_state, required),
8883                         (19, self.context.latest_inbound_scid_alias, option),
8884                         (21, self.context.outbound_scid_alias, required),
8885                         (23, channel_ready_event_emitted, option),
8886                         (25, user_id_high_opt, option),
8887                         (27, self.context.channel_keys_id, required),
8888                         (28, holder_max_accepted_htlcs, option),
8889                         (29, self.context.temporary_channel_id, option),
8890                         (31, channel_pending_event_emitted, option),
8891                         (35, pending_outbound_skimmed_fees, optional_vec),
8892                         (37, holding_cell_skimmed_fees, optional_vec),
8893                         (38, self.context.is_batch_funding, option),
8894                         (39, pending_outbound_blinding_points, optional_vec),
8895                         (41, holding_cell_blinding_points, optional_vec),
8896                         (43, malformed_htlcs, optional_vec), // Added in 0.0.119
8897                         (45, cur_holder_commitment_point, option),
8898                         (47, next_holder_commitment_point, option),
8899                         (49, self.context.local_initiated_shutdown, option), // Added in 0.0.122
8900                 });
8901
8902                 Ok(())
8903         }
8904 }
8905
8906 const MAX_ALLOC_SIZE: usize = 64*1024;
8907 impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)> for Channel<SP>
8908                 where
8909                         ES::Target: EntropySource,
8910                         SP::Target: SignerProvider
8911 {
8912         fn read<R : io::Read>(reader: &mut R, args: (&'a ES, &'b SP, u32, &'c ChannelTypeFeatures)) -> Result<Self, DecodeError> {
8913                 let (entropy_source, signer_provider, serialized_height, our_supported_features) = args;
8914                 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
8915
8916                 // `user_id` used to be a single u64 value. In order to remain backwards compatible with
8917                 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values. We read
8918                 // the low bytes now and the high bytes later.
8919                 let user_id_low: u64 = Readable::read(reader)?;
8920
8921                 let mut config = Some(LegacyChannelConfig::default());
8922                 if ver == 1 {
8923                         // Read the old serialization of the ChannelConfig from version 0.0.98.
8924                         config.as_mut().unwrap().options.forwarding_fee_proportional_millionths = Readable::read(reader)?;
8925                         config.as_mut().unwrap().options.cltv_expiry_delta = Readable::read(reader)?;
8926                         config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
8927                         config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
8928                 } else {
8929                         // Read the 8 bytes of backwards-compatibility ChannelConfig data.
8930                         let mut _val: u64 = Readable::read(reader)?;
8931                 }
8932
8933                 let channel_id = Readable::read(reader)?;
8934                 let channel_state = ChannelState::from_u32(Readable::read(reader)?).map_err(|_| DecodeError::InvalidValue)?;
8935                 let channel_value_satoshis = Readable::read(reader)?;
8936
8937                 let latest_monitor_update_id = Readable::read(reader)?;
8938
8939                 let mut keys_data = None;
8940                 if ver <= 2 {
8941                         // Read the serialize signer bytes. We'll choose to deserialize them or not based on whether
8942                         // the `channel_keys_id` TLV is present below.
8943                         let keys_len: u32 = Readable::read(reader)?;
8944                         keys_data = Some(Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE)));
8945                         while keys_data.as_ref().unwrap().len() != keys_len as usize {
8946                                 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
8947                                 let mut data = [0; 1024];
8948                                 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.as_ref().unwrap().len())];
8949                                 reader.read_exact(read_slice)?;
8950                                 keys_data.as_mut().unwrap().extend_from_slice(read_slice);
8951                         }
8952                 }
8953
8954                 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
8955                 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
8956                         Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
8957                         Err(_) => None,
8958                 };
8959                 let destination_script = Readable::read(reader)?;
8960
8961                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
8962                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
8963                 let value_to_self_msat = Readable::read(reader)?;
8964
8965                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
8966
8967                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
8968                 for _ in 0..pending_inbound_htlc_count {
8969                         pending_inbound_htlcs.push(InboundHTLCOutput {
8970                                 htlc_id: Readable::read(reader)?,
8971                                 amount_msat: Readable::read(reader)?,
8972                                 cltv_expiry: Readable::read(reader)?,
8973                                 payment_hash: Readable::read(reader)?,
8974                                 state: match <u8 as Readable>::read(reader)? {
8975                                         1 => {
8976                                                 let resolution = if ver <= 3 {
8977                                                         InboundHTLCResolution::Resolved { pending_htlc_status: Readable::read(reader)? }
8978                                                 } else {
8979                                                         Readable::read(reader)?
8980                                                 };
8981                                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(resolution)
8982                                         },
8983                                         2 => {
8984                                                 let resolution = if ver <= 3 {
8985                                                         InboundHTLCResolution::Resolved { pending_htlc_status: Readable::read(reader)? }
8986                                                 } else {
8987                                                         Readable::read(reader)?
8988                                                 };
8989                                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(resolution)
8990                                         },
8991                                         3 => InboundHTLCState::Committed,
8992                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
8993                                         _ => return Err(DecodeError::InvalidValue),
8994                                 },
8995                         });
8996                 }
8997
8998                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
8999                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, DEFAULT_MAX_HTLCS as usize));
9000                 for _ in 0..pending_outbound_htlc_count {
9001                         pending_outbound_htlcs.push(OutboundHTLCOutput {
9002                                 htlc_id: Readable::read(reader)?,
9003                                 amount_msat: Readable::read(reader)?,
9004                                 cltv_expiry: Readable::read(reader)?,
9005                                 payment_hash: Readable::read(reader)?,
9006                                 source: Readable::read(reader)?,
9007                                 state: match <u8 as Readable>::read(reader)? {
9008                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
9009                                         1 => OutboundHTLCState::Committed,
9010                                         2 => {
9011                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
9012                                                 OutboundHTLCState::RemoteRemoved(option.into())
9013                                         },
9014                                         3 => {
9015                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
9016                                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(option.into())
9017                                         },
9018                                         4 => {
9019                                                 let option: Option<HTLCFailReason> = Readable::read(reader)?;
9020                                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(option.into())
9021                                         },
9022                                         _ => return Err(DecodeError::InvalidValue),
9023                                 },
9024                                 skimmed_fee_msat: None,
9025                                 blinding_point: None,
9026                         });
9027                 }
9028
9029                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
9030                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, DEFAULT_MAX_HTLCS as usize*2));
9031                 for _ in 0..holding_cell_htlc_update_count {
9032                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
9033                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
9034                                         amount_msat: Readable::read(reader)?,
9035                                         cltv_expiry: Readable::read(reader)?,
9036                                         payment_hash: Readable::read(reader)?,
9037                                         source: Readable::read(reader)?,
9038                                         onion_routing_packet: Readable::read(reader)?,
9039                                         skimmed_fee_msat: None,
9040                                         blinding_point: None,
9041                                 },
9042                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
9043                                         payment_preimage: Readable::read(reader)?,
9044                                         htlc_id: Readable::read(reader)?,
9045                                 },
9046                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
9047                                         htlc_id: Readable::read(reader)?,
9048                                         err_packet: Readable::read(reader)?,
9049                                 },
9050                                 _ => return Err(DecodeError::InvalidValue),
9051                         });
9052                 }
9053
9054                 let resend_order = match <u8 as Readable>::read(reader)? {
9055                         0 => RAACommitmentOrder::CommitmentFirst,
9056                         1 => RAACommitmentOrder::RevokeAndACKFirst,
9057                         _ => return Err(DecodeError::InvalidValue),
9058                 };
9059
9060                 let monitor_pending_channel_ready = Readable::read(reader)?;
9061                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
9062                 let monitor_pending_commitment_signed = Readable::read(reader)?;
9063
9064                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
9065                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, DEFAULT_MAX_HTLCS as usize));
9066                 for _ in 0..monitor_pending_forwards_count {
9067                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
9068                 }
9069
9070                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
9071                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, DEFAULT_MAX_HTLCS as usize));
9072                 for _ in 0..monitor_pending_failures_count {
9073                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
9074                 }
9075
9076                 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
9077
9078                 let holding_cell_update_fee = Readable::read(reader)?;
9079
9080                 let next_holder_htlc_id = Readable::read(reader)?;
9081                 let next_counterparty_htlc_id = Readable::read(reader)?;
9082                 let update_time_counter = Readable::read(reader)?;
9083                 let feerate_per_kw = Readable::read(reader)?;
9084
9085                 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
9086                 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
9087                 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
9088                 // consider the stale state on reload.
9089                 match <u8 as Readable>::read(reader)? {
9090                         0 => {},
9091                         1 => {
9092                                 let _: u32 = Readable::read(reader)?;
9093                                 let _: u64 = Readable::read(reader)?;
9094                                 let _: Signature = Readable::read(reader)?;
9095                         },
9096                         _ => return Err(DecodeError::InvalidValue),
9097                 }
9098
9099                 let funding_tx_confirmed_in = Readable::read(reader)?;
9100                 let funding_tx_confirmation_height = Readable::read(reader)?;
9101                 let short_channel_id = Readable::read(reader)?;
9102
9103                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
9104                 let holder_dust_limit_satoshis = Readable::read(reader)?;
9105                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
9106                 let mut counterparty_selected_channel_reserve_satoshis = None;
9107                 if ver == 1 {
9108                         // Read the old serialization from version 0.0.98.
9109                         counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
9110                 } else {
9111                         // Read the 8 bytes of backwards-compatibility data.
9112                         let _dummy: u64 = Readable::read(reader)?;
9113                 }
9114                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
9115                 let holder_htlc_minimum_msat = Readable::read(reader)?;
9116                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
9117
9118                 let mut minimum_depth = None;
9119                 if ver == 1 {
9120                         // Read the old serialization from version 0.0.98.
9121                         minimum_depth = Some(Readable::read(reader)?);
9122                 } else {
9123                         // Read the 4 bytes of backwards-compatibility data.
9124                         let _dummy: u32 = Readable::read(reader)?;
9125                 }
9126
9127                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
9128                         0 => None,
9129                         1 => Some(CounterpartyForwardingInfo {
9130                                 fee_base_msat: Readable::read(reader)?,
9131                                 fee_proportional_millionths: Readable::read(reader)?,
9132                                 cltv_expiry_delta: Readable::read(reader)?,
9133                         }),
9134                         _ => return Err(DecodeError::InvalidValue),
9135                 };
9136
9137                 let mut channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
9138                 let funding_transaction: Option<Transaction> = Readable::read(reader)?;
9139
9140                 let counterparty_cur_commitment_point = Readable::read(reader)?;
9141
9142                 let counterparty_prev_commitment_point = Readable::read(reader)?;
9143                 let counterparty_node_id = Readable::read(reader)?;
9144
9145                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
9146                 let commitment_secrets = Readable::read(reader)?;
9147
9148                 let channel_update_status = Readable::read(reader)?;
9149
9150                 #[cfg(any(test, fuzzing))]
9151                 let mut historical_inbound_htlc_fulfills = new_hash_set();
9152                 #[cfg(any(test, fuzzing))]
9153                 {
9154                         let htlc_fulfills_len: u64 = Readable::read(reader)?;
9155                         for _ in 0..htlc_fulfills_len {
9156                                 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
9157                         }
9158                 }
9159
9160                 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
9161                         Some((feerate, if channel_parameters.is_outbound_from_holder {
9162                                 FeeUpdateState::Outbound
9163                         } else {
9164                                 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
9165                         }))
9166                 } else {
9167                         None
9168                 };
9169
9170                 let mut announcement_sigs = None;
9171                 let mut target_closing_feerate_sats_per_kw = None;
9172                 let mut monitor_pending_finalized_fulfills = Some(Vec::new());
9173                 let mut holder_selected_channel_reserve_satoshis = Some(get_legacy_default_holder_selected_channel_reserve_satoshis(channel_value_satoshis));
9174                 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));
9175                 // Prior to supporting channel type negotiation, all of our channels were static_remotekey
9176                 // only, so we default to that if none was written.
9177                 let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
9178                 let mut channel_creation_height = Some(serialized_height);
9179                 let mut preimages_opt: Option<Vec<Option<PaymentPreimage>>> = None;
9180
9181                 // If we read an old Channel, for simplicity we just treat it as "we never sent an
9182                 // AnnouncementSignatures" which implies we'll re-send it on reconnect, but that's fine.
9183                 let mut announcement_sigs_state = Some(AnnouncementSigsState::NotSent);
9184                 let mut latest_inbound_scid_alias = None;
9185                 let mut outbound_scid_alias = None;
9186                 let mut channel_pending_event_emitted = None;
9187                 let mut channel_ready_event_emitted = None;
9188
9189                 let mut user_id_high_opt: Option<u64> = None;
9190                 let mut channel_keys_id: Option<[u8; 32]> = None;
9191                 let mut temporary_channel_id: Option<ChannelId> = None;
9192                 let mut holder_max_accepted_htlcs: Option<u16> = None;
9193
9194                 let mut blocked_monitor_updates = Some(Vec::new());
9195
9196                 let mut pending_outbound_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
9197                 let mut holding_cell_skimmed_fees_opt: Option<Vec<Option<u64>>> = None;
9198
9199                 let mut is_batch_funding: Option<()> = None;
9200
9201                 let mut local_initiated_shutdown: Option<()> = None;
9202
9203                 let mut pending_outbound_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
9204                 let mut holding_cell_blinding_points_opt: Option<Vec<Option<PublicKey>>> = None;
9205
9206                 let mut malformed_htlcs: Option<Vec<(u64, u16, [u8; 32])>> = None;
9207                 let mut monitor_pending_update_adds: Option<Vec<msgs::UpdateAddHTLC>> = None;
9208
9209                 let mut cur_holder_commitment_point_opt: Option<PublicKey> = None;
9210                 let mut next_holder_commitment_point_opt: Option<PublicKey> = None;
9211
9212                 read_tlv_fields!(reader, {
9213                         (0, announcement_sigs, option),
9214                         (1, minimum_depth, option),
9215                         (2, channel_type, option),
9216                         (3, counterparty_selected_channel_reserve_satoshis, option),
9217                         (4, holder_selected_channel_reserve_satoshis, option),
9218                         (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
9219                         (6, holder_max_htlc_value_in_flight_msat, option),
9220                         (7, shutdown_scriptpubkey, option),
9221                         (8, blocked_monitor_updates, optional_vec),
9222                         (9, target_closing_feerate_sats_per_kw, option),
9223                         (10, monitor_pending_update_adds, option), // Added in 0.0.122
9224                         (11, monitor_pending_finalized_fulfills, optional_vec),
9225                         (13, channel_creation_height, option),
9226                         (15, preimages_opt, optional_vec),
9227                         (17, announcement_sigs_state, option),
9228                         (19, latest_inbound_scid_alias, option),
9229                         (21, outbound_scid_alias, option),
9230                         (23, channel_ready_event_emitted, option),
9231                         (25, user_id_high_opt, option),
9232                         (27, channel_keys_id, option),
9233                         (28, holder_max_accepted_htlcs, option),
9234                         (29, temporary_channel_id, option),
9235                         (31, channel_pending_event_emitted, option),
9236                         (35, pending_outbound_skimmed_fees_opt, optional_vec),
9237                         (37, holding_cell_skimmed_fees_opt, optional_vec),
9238                         (38, is_batch_funding, option),
9239                         (39, pending_outbound_blinding_points_opt, optional_vec),
9240                         (41, holding_cell_blinding_points_opt, optional_vec),
9241                         (43, malformed_htlcs, optional_vec), // Added in 0.0.119
9242                         (45, cur_holder_commitment_point_opt, option),
9243                         (47, next_holder_commitment_point_opt, option),
9244                         (49, local_initiated_shutdown, option),
9245                 });
9246
9247                 let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
9248                         let mut holder_signer = signer_provider.derive_channel_signer(channel_value_satoshis, channel_keys_id);
9249                         // If we've gotten to the funding stage of the channel, populate the signer with its
9250                         // required channel parameters.
9251                         if channel_state >= ChannelState::FundingNegotiated {
9252                                 holder_signer.provide_channel_parameters(&channel_parameters);
9253                         }
9254                         (channel_keys_id, holder_signer)
9255                 } else {
9256                         // `keys_data` can be `None` if we had corrupted data.
9257                         let keys_data = keys_data.ok_or(DecodeError::InvalidValue)?;
9258                         let holder_signer = signer_provider.read_chan_signer(&keys_data)?;
9259                         (holder_signer.channel_keys_id(), holder_signer)
9260                 };
9261
9262                 if let Some(preimages) = preimages_opt {
9263                         let mut iter = preimages.into_iter();
9264                         for htlc in pending_outbound_htlcs.iter_mut() {
9265                                 match &htlc.state {
9266                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(None)) => {
9267                                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
9268                                         }
9269                                         OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(None)) => {
9270                                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(OutboundHTLCOutcome::Success(iter.next().ok_or(DecodeError::InvalidValue)?));
9271                                         }
9272                                         _ => {}
9273                                 }
9274                         }
9275                         // We expect all preimages to be consumed above
9276                         if iter.next().is_some() {
9277                                 return Err(DecodeError::InvalidValue);
9278                         }
9279                 }
9280
9281                 let chan_features = channel_type.as_ref().unwrap();
9282                 if !chan_features.is_subset(our_supported_features) {
9283                         // If the channel was written by a new version and negotiated with features we don't
9284                         // understand yet, refuse to read it.
9285                         return Err(DecodeError::UnknownRequiredFeature);
9286                 }
9287
9288                 // ChannelTransactionParameters may have had an empty features set upon deserialization.
9289                 // To account for that, we're proactively setting/overriding the field here.
9290                 channel_parameters.channel_type_features = chan_features.clone();
9291
9292                 let mut secp_ctx = Secp256k1::new();
9293                 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
9294
9295                 // `user_id` used to be a single u64 value. In order to remain backwards
9296                 // compatible with versions prior to 0.0.113, the u128 is serialized as two
9297                 // separate u64 values.
9298                 let user_id = user_id_low as u128 + ((user_id_high_opt.unwrap_or(0) as u128) << 64);
9299
9300                 let holder_max_accepted_htlcs = holder_max_accepted_htlcs.unwrap_or(DEFAULT_MAX_HTLCS);
9301
9302                 if let Some(skimmed_fees) = pending_outbound_skimmed_fees_opt {
9303                         let mut iter = skimmed_fees.into_iter();
9304                         for htlc in pending_outbound_htlcs.iter_mut() {
9305                                 htlc.skimmed_fee_msat = iter.next().ok_or(DecodeError::InvalidValue)?;
9306                         }
9307                         // We expect all skimmed fees to be consumed above
9308                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9309                 }
9310                 if let Some(skimmed_fees) = holding_cell_skimmed_fees_opt {
9311                         let mut iter = skimmed_fees.into_iter();
9312                         for htlc in holding_cell_htlc_updates.iter_mut() {
9313                                 if let HTLCUpdateAwaitingACK::AddHTLC { ref mut skimmed_fee_msat, .. } = htlc {
9314                                         *skimmed_fee_msat = iter.next().ok_or(DecodeError::InvalidValue)?;
9315                                 }
9316                         }
9317                         // We expect all skimmed fees to be consumed above
9318                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9319                 }
9320                 if let Some(blinding_pts) = pending_outbound_blinding_points_opt {
9321                         let mut iter = blinding_pts.into_iter();
9322                         for htlc in pending_outbound_htlcs.iter_mut() {
9323                                 htlc.blinding_point = iter.next().ok_or(DecodeError::InvalidValue)?;
9324                         }
9325                         // We expect all blinding points to be consumed above
9326                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9327                 }
9328                 if let Some(blinding_pts) = holding_cell_blinding_points_opt {
9329                         let mut iter = blinding_pts.into_iter();
9330                         for htlc in holding_cell_htlc_updates.iter_mut() {
9331                                 if let HTLCUpdateAwaitingACK::AddHTLC { ref mut blinding_point, .. } = htlc {
9332                                         *blinding_point = iter.next().ok_or(DecodeError::InvalidValue)?;
9333                                 }
9334                         }
9335                         // We expect all blinding points to be consumed above
9336                         if iter.next().is_some() { return Err(DecodeError::InvalidValue) }
9337                 }
9338
9339                 if let Some(malformed_htlcs) = malformed_htlcs {
9340                         for (malformed_htlc_id, failure_code, sha256_of_onion) in malformed_htlcs {
9341                                 let htlc_idx = holding_cell_htlc_updates.iter().position(|htlc| {
9342                                         if let HTLCUpdateAwaitingACK::FailHTLC { htlc_id, err_packet } = htlc {
9343                                                 let matches = *htlc_id == malformed_htlc_id;
9344                                                 if matches { debug_assert!(err_packet.data.is_empty()) }
9345                                                 matches
9346                                         } else { false }
9347                                 }).ok_or(DecodeError::InvalidValue)?;
9348                                 let malformed_htlc = HTLCUpdateAwaitingACK::FailMalformedHTLC {
9349                                         htlc_id: malformed_htlc_id, failure_code, sha256_of_onion
9350                                 };
9351                                 let _ = core::mem::replace(&mut holding_cell_htlc_updates[htlc_idx], malformed_htlc);
9352                         }
9353                 }
9354
9355                 // If we're restoring this channel for the first time after an upgrade, then we require that the
9356                 // signer be available so that we can immediately populate the current commitment point. Channel
9357                 // restoration will fail if this is not possible.
9358                 let holder_commitment_point = match (cur_holder_commitment_point_opt, next_holder_commitment_point_opt) {
9359                         (Some(current), Some(next)) => HolderCommitmentPoint::Available {
9360                                 transaction_number: cur_holder_commitment_transaction_number, current, next
9361                         },
9362                         (Some(current), _) => HolderCommitmentPoint::Available {
9363                                 transaction_number: cur_holder_commitment_transaction_number, current,
9364                                 next: holder_signer.get_per_commitment_point(cur_holder_commitment_transaction_number - 1, &secp_ctx),
9365                         },
9366                         (_, _) => HolderCommitmentPoint::Available {
9367                                 transaction_number: cur_holder_commitment_transaction_number,
9368                                 current: holder_signer.get_per_commitment_point(cur_holder_commitment_transaction_number, &secp_ctx),
9369                                 next: holder_signer.get_per_commitment_point(cur_holder_commitment_transaction_number - 1, &secp_ctx),
9370                         },
9371                 };
9372
9373                 Ok(Channel {
9374                         context: ChannelContext {
9375                                 user_id,
9376
9377                                 config: config.unwrap(),
9378
9379                                 prev_config: None,
9380
9381                                 // Note that we don't care about serializing handshake limits as we only ever serialize
9382                                 // channel data after the handshake has completed.
9383                                 inbound_handshake_limits_override: None,
9384
9385                                 channel_id,
9386                                 temporary_channel_id,
9387                                 channel_state,
9388                                 announcement_sigs_state: announcement_sigs_state.unwrap(),
9389                                 secp_ctx,
9390                                 channel_value_satoshis,
9391
9392                                 latest_monitor_update_id,
9393
9394                                 holder_signer: ChannelSignerType::Ecdsa(holder_signer),
9395                                 shutdown_scriptpubkey,
9396                                 destination_script,
9397
9398                                 holder_commitment_point,
9399                                 cur_counterparty_commitment_transaction_number,
9400                                 value_to_self_msat,
9401
9402                                 holder_max_accepted_htlcs,
9403                                 pending_inbound_htlcs,
9404                                 pending_outbound_htlcs,
9405                                 holding_cell_htlc_updates,
9406
9407                                 resend_order,
9408
9409                                 monitor_pending_channel_ready,
9410                                 monitor_pending_revoke_and_ack,
9411                                 monitor_pending_commitment_signed,
9412                                 monitor_pending_forwards,
9413                                 monitor_pending_failures,
9414                                 monitor_pending_finalized_fulfills: monitor_pending_finalized_fulfills.unwrap(),
9415                                 monitor_pending_update_adds: monitor_pending_update_adds.unwrap_or(Vec::new()),
9416
9417                                 signer_pending_commitment_update: false,
9418                                 signer_pending_funding: false,
9419
9420                                 pending_update_fee,
9421                                 holding_cell_update_fee,
9422                                 next_holder_htlc_id,
9423                                 next_counterparty_htlc_id,
9424                                 update_time_counter,
9425                                 feerate_per_kw,
9426
9427                                 #[cfg(debug_assertions)]
9428                                 holder_max_commitment_tx_output: Mutex::new((0, 0)),
9429                                 #[cfg(debug_assertions)]
9430                                 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
9431
9432                                 last_sent_closing_fee: None,
9433                                 pending_counterparty_closing_signed: None,
9434                                 expecting_peer_commitment_signed: false,
9435                                 closing_fee_limits: None,
9436                                 target_closing_feerate_sats_per_kw,
9437
9438                                 funding_tx_confirmed_in,
9439                                 funding_tx_confirmation_height,
9440                                 short_channel_id,
9441                                 channel_creation_height: channel_creation_height.unwrap(),
9442
9443                                 counterparty_dust_limit_satoshis,
9444                                 holder_dust_limit_satoshis,
9445                                 counterparty_max_htlc_value_in_flight_msat,
9446                                 holder_max_htlc_value_in_flight_msat: holder_max_htlc_value_in_flight_msat.unwrap(),
9447                                 counterparty_selected_channel_reserve_satoshis,
9448                                 holder_selected_channel_reserve_satoshis: holder_selected_channel_reserve_satoshis.unwrap(),
9449                                 counterparty_htlc_minimum_msat,
9450                                 holder_htlc_minimum_msat,
9451                                 counterparty_max_accepted_htlcs,
9452                                 minimum_depth,
9453
9454                                 counterparty_forwarding_info,
9455
9456                                 channel_transaction_parameters: channel_parameters,
9457                                 funding_transaction,
9458                                 is_batch_funding,
9459
9460                                 counterparty_cur_commitment_point,
9461                                 counterparty_prev_commitment_point,
9462                                 counterparty_node_id,
9463
9464                                 counterparty_shutdown_scriptpubkey,
9465
9466                                 commitment_secrets,
9467
9468                                 channel_update_status,
9469                                 closing_signed_in_flight: false,
9470
9471                                 announcement_sigs,
9472
9473                                 #[cfg(any(test, fuzzing))]
9474                                 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
9475                                 #[cfg(any(test, fuzzing))]
9476                                 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
9477
9478                                 workaround_lnd_bug_4006: None,
9479                                 sent_message_awaiting_response: None,
9480
9481                                 latest_inbound_scid_alias,
9482                                 // Later in the ChannelManager deserialization phase we scan for channels and assign scid aliases if its missing
9483                                 outbound_scid_alias: outbound_scid_alias.unwrap_or(0),
9484
9485                                 channel_pending_event_emitted: channel_pending_event_emitted.unwrap_or(true),
9486                                 channel_ready_event_emitted: channel_ready_event_emitted.unwrap_or(true),
9487
9488                                 #[cfg(any(test, fuzzing))]
9489                                 historical_inbound_htlc_fulfills,
9490
9491                                 channel_type: channel_type.unwrap(),
9492                                 channel_keys_id,
9493
9494                                 local_initiated_shutdown,
9495
9496                                 blocked_monitor_updates: blocked_monitor_updates.unwrap(),
9497                         },
9498                         #[cfg(any(dual_funding, splicing))]
9499                         dual_funding_channel_context: None,
9500                 })
9501         }
9502 }
9503
9504 #[cfg(test)]
9505 mod tests {
9506         use std::cmp;
9507         use bitcoin::blockdata::constants::ChainHash;
9508         use bitcoin::blockdata::script::{ScriptBuf, Builder};
9509         use bitcoin::blockdata::transaction::{Transaction, TxOut};
9510         use bitcoin::blockdata::opcodes;
9511         use bitcoin::network::constants::Network;
9512         use crate::ln::onion_utils::INVALID_ONION_BLINDING;
9513         use crate::ln::types::{PaymentHash, PaymentPreimage};
9514         use crate::ln::channel_keys::{RevocationKey, RevocationBasepoint};
9515         use crate::ln::channelmanager::{self, HTLCSource, PaymentId};
9516         use crate::ln::channel::InitFeatures;
9517         use crate::ln::channel::{AwaitingChannelReadyFlags, Channel, ChannelState, InboundHTLCOutput, OutboundV1Channel, InboundV1Channel, OutboundHTLCOutput, InboundHTLCState, OutboundHTLCState, HTLCCandidate, HTLCInitiator, HTLCUpdateAwaitingACK, commit_tx_fee_msat};
9518         use crate::ln::channel::{MAX_FUNDING_SATOSHIS_NO_WUMBO, TOTAL_BITCOIN_SUPPLY_SATOSHIS, MIN_THEIR_CHAN_RESERVE_SATOSHIS};
9519         use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, NodeFeatures};
9520         use crate::ln::msgs;
9521         use crate::ln::msgs::{ChannelUpdate, DecodeError, UnsignedChannelUpdate, MAX_VALUE_MSAT};
9522         use crate::ln::script::ShutdownScript;
9523         use crate::ln::chan_utils::{self, htlc_success_tx_weight, htlc_timeout_tx_weight};
9524         use crate::chain::BestBlock;
9525         use crate::chain::chaininterface::{FeeEstimator, LowerBoundedFeeEstimator, ConfirmationTarget};
9526         use crate::sign::{ChannelSigner, InMemorySigner, EntropySource, SignerProvider};
9527         use crate::chain::transaction::OutPoint;
9528         use crate::routing::router::{Path, RouteHop};
9529         use crate::util::config::UserConfig;
9530         use crate::util::errors::APIError;
9531         use crate::util::ser::{ReadableArgs, Writeable};
9532         use crate::util::test_utils;
9533         use crate::util::test_utils::{OnGetShutdownScriptpubkey, TestKeysInterface};
9534         use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature};
9535         use bitcoin::secp256k1::ffi::Signature as FFISignature;
9536         use bitcoin::secp256k1::{SecretKey,PublicKey};
9537         use bitcoin::hashes::sha256::Hash as Sha256;
9538         use bitcoin::hashes::Hash;
9539         use bitcoin::hashes::hex::FromHex;
9540         use bitcoin::hash_types::WPubkeyHash;
9541         use bitcoin::blockdata::locktime::absolute::LockTime;
9542         use bitcoin::address::{WitnessProgram, WitnessVersion};
9543         use crate::prelude::*;
9544
9545         #[test]
9546         fn test_channel_state_order() {
9547                 use crate::ln::channel::NegotiatingFundingFlags;
9548                 use crate::ln::channel::AwaitingChannelReadyFlags;
9549                 use crate::ln::channel::ChannelReadyFlags;
9550
9551                 assert!(ChannelState::NegotiatingFunding(NegotiatingFundingFlags::new()) < ChannelState::FundingNegotiated);
9552                 assert!(ChannelState::FundingNegotiated < ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new()));
9553                 assert!(ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::new()) < ChannelState::ChannelReady(ChannelReadyFlags::new()));
9554                 assert!(ChannelState::ChannelReady(ChannelReadyFlags::new()) < ChannelState::ShutdownComplete);
9555         }
9556
9557         struct TestFeeEstimator {
9558                 fee_est: u32
9559         }
9560         impl FeeEstimator for TestFeeEstimator {
9561                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
9562                         self.fee_est
9563                 }
9564         }
9565
9566         #[test]
9567         fn test_max_funding_satoshis_no_wumbo() {
9568                 assert_eq!(TOTAL_BITCOIN_SUPPLY_SATOSHIS, 21_000_000 * 100_000_000);
9569                 assert!(MAX_FUNDING_SATOSHIS_NO_WUMBO <= TOTAL_BITCOIN_SUPPLY_SATOSHIS,
9570                         "MAX_FUNDING_SATOSHIS_NO_WUMBO is greater than all satoshis in existence");
9571         }
9572
9573         struct Keys {
9574                 signer: InMemorySigner,
9575         }
9576
9577         impl EntropySource for Keys {
9578                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
9579         }
9580
9581         impl SignerProvider for Keys {
9582                 type EcdsaSigner = InMemorySigner;
9583                 #[cfg(taproot)]
9584                 type TaprootSigner = InMemorySigner;
9585
9586                 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] {
9587                         self.signer.channel_keys_id()
9588                 }
9589
9590                 fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner {
9591                         self.signer.clone()
9592                 }
9593
9594                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::EcdsaSigner, DecodeError> { panic!(); }
9595
9596                 fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> {
9597                         let secp_ctx = Secp256k1::signing_only();
9598                         let channel_monitor_claim_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
9599                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
9600                         Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(channel_monitor_claim_key_hash).into_script())
9601                 }
9602
9603                 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
9604                         let secp_ctx = Secp256k1::signing_only();
9605                         let channel_close_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
9606                         Ok(ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key)))
9607                 }
9608         }
9609
9610         #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
9611         fn public_from_secret_hex(secp_ctx: &Secp256k1<bitcoin::secp256k1::All>, hex: &str) -> PublicKey {
9612                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&<Vec<u8>>::from_hex(hex).unwrap()[..]).unwrap())
9613         }
9614
9615         #[test]
9616         fn upfront_shutdown_script_incompatibility() {
9617                 let features = channelmanager::provided_init_features(&UserConfig::default()).clear_shutdown_anysegwit();
9618                 let non_v0_segwit_shutdown_script = ShutdownScript::new_witness_program(
9619                         &WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap(),
9620                 ).unwrap();
9621
9622                 let seed = [42; 32];
9623                 let network = Network::Testnet;
9624                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9625                 keys_provider.expect(OnGetShutdownScriptpubkey {
9626                         returns: non_v0_segwit_shutdown_script.clone(),
9627                 });
9628
9629                 let secp_ctx = Secp256k1::new();
9630                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9631                 let config = UserConfig::default();
9632                 match OutboundV1Channel::<&TestKeysInterface>::new(&LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 253 }), &&keys_provider, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config, 0, 42, None) {
9633                         Err(APIError::IncompatibleShutdownScript { script }) => {
9634                                 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
9635                         },
9636                         Err(e) => panic!("Unexpected error: {:?}", e),
9637                         Ok(_) => panic!("Expected error"),
9638                 }
9639         }
9640
9641         // Check that, during channel creation, we use the same feerate in the open channel message
9642         // as we do in the Channel object creation itself.
9643         #[test]
9644         fn test_open_channel_msg_fee() {
9645                 let original_fee = 253;
9646                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
9647                 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(&fee_est);
9648                 let secp_ctx = Secp256k1::new();
9649                 let seed = [42; 32];
9650                 let network = Network::Testnet;
9651                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9652
9653                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9654                 let config = UserConfig::default();
9655                 let node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&bounded_fee_estimator, &&keys_provider, &&keys_provider, node_a_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9656
9657                 // Now change the fee so we can check that the fee in the open_channel message is the
9658                 // same as the old fee.
9659                 fee_est.fee_est = 500;
9660                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
9661                 assert_eq!(open_channel_msg.common_fields.commitment_feerate_sat_per_1000_weight, original_fee);
9662         }
9663
9664         #[test]
9665         fn test_holder_vs_counterparty_dust_limit() {
9666                 // Test that when calculating the local and remote commitment transaction fees, the correct
9667                 // dust limits are used.
9668                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9669                 let secp_ctx = Secp256k1::new();
9670                 let seed = [42; 32];
9671                 let network = Network::Testnet;
9672                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9673                 let logger = test_utils::TestLogger::new();
9674                 let best_block = BestBlock::from_network(network);
9675
9676                 // Go through the flow of opening a channel between two nodes, making sure
9677                 // they have different dust limits.
9678
9679                 // Create Node A's channel pointing to Node B's pubkey
9680                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9681                 let config = UserConfig::default();
9682                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9683
9684                 // Create Node B's channel by receiving Node A's open_channel message
9685                 // Make sure A's dust limit is as we expect.
9686                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
9687                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9688                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9689
9690                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
9691                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel();
9692                 accept_channel_msg.common_fields.dust_limit_satoshis = 546;
9693                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
9694                 node_a_chan.context.holder_dust_limit_satoshis = 1560;
9695
9696                 // Node A --> Node B: funding created
9697                 let output_script = node_a_chan.context.get_funding_redeemscript();
9698                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9699                         value: 10000000, script_pubkey: output_script.clone(),
9700                 }]};
9701                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9702                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
9703                 let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
9704
9705                 // Node B --> Node A: funding signed
9706                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
9707                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
9708
9709                 // Put some inbound and outbound HTLCs in A's channel.
9710                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
9711                 node_a_chan.context.pending_inbound_htlcs.push(InboundHTLCOutput {
9712                         htlc_id: 0,
9713                         amount_msat: htlc_amount_msat,
9714                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).to_byte_array()),
9715                         cltv_expiry: 300000000,
9716                         state: InboundHTLCState::Committed,
9717                 });
9718
9719                 node_a_chan.context.pending_outbound_htlcs.push(OutboundHTLCOutput {
9720                         htlc_id: 1,
9721                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
9722                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).to_byte_array()),
9723                         cltv_expiry: 200000000,
9724                         state: OutboundHTLCState::Committed,
9725                         source: HTLCSource::OutboundRoute {
9726                                 path: Path { hops: Vec::new(), blinded_tail: None },
9727                                 session_priv: SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
9728                                 first_hop_htlc_msat: 548,
9729                                 payment_id: PaymentId([42; 32]),
9730                         },
9731                         skimmed_fee_msat: None,
9732                         blinding_point: None,
9733                 });
9734
9735                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
9736                 // the dust limit check.
9737                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
9738                 let local_commit_tx_fee = node_a_chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9739                 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());
9740                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
9741
9742                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
9743                 // of the HTLCs are seen to be above the dust limit.
9744                 node_a_chan.context.channel_transaction_parameters.is_outbound_from_holder = false;
9745                 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());
9746                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
9747                 let remote_commit_tx_fee = node_a_chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9748                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
9749         }
9750
9751         #[test]
9752         fn test_timeout_vs_success_htlc_dust_limit() {
9753                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
9754                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
9755                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
9756                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
9757                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 253 });
9758                 let secp_ctx = Secp256k1::new();
9759                 let seed = [42; 32];
9760                 let network = Network::Testnet;
9761                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9762
9763                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9764                 let config = UserConfig::default();
9765                 let mut chan = OutboundV1Channel::<&TestKeysInterface>::new(&fee_est, &&keys_provider, &&keys_provider, node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9766
9767                 let commitment_tx_fee_0_htlcs = commit_tx_fee_msat(chan.context.feerate_per_kw, 0, chan.context.get_channel_type());
9768                 let commitment_tx_fee_1_htlc = commit_tx_fee_msat(chan.context.feerate_per_kw, 1, chan.context.get_channel_type());
9769
9770                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
9771                 // counted as dust when it shouldn't be.
9772                 let htlc_amt_above_timeout = ((253 * htlc_timeout_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.holder_dust_limit_satoshis + 1) * 1000;
9773                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
9774                 let commitment_tx_fee = chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9775                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
9776
9777                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
9778                 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;
9779                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
9780                 let commitment_tx_fee = chan.context.next_local_commit_tx_fee_msat(htlc_candidate, None);
9781                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
9782
9783                 chan.context.channel_transaction_parameters.is_outbound_from_holder = false;
9784
9785                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
9786                 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;
9787                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
9788                 let commitment_tx_fee = chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9789                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
9790
9791                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
9792                 let htlc_amt_below_success = ((253 * htlc_success_tx_weight(chan.context.get_channel_type()) / 1000) + chan.context.counterparty_dust_limit_satoshis - 1) * 1000;
9793                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
9794                 let commitment_tx_fee = chan.context.next_remote_commit_tx_fee_msat(htlc_candidate, None);
9795                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
9796         }
9797
9798         #[test]
9799         fn channel_reestablish_no_updates() {
9800                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9801                 let logger = test_utils::TestLogger::new();
9802                 let secp_ctx = Secp256k1::new();
9803                 let seed = [42; 32];
9804                 let network = Network::Testnet;
9805                 let best_block = BestBlock::from_network(network);
9806                 let chain_hash = ChainHash::using_genesis_block(network);
9807                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9808
9809                 // Go through the flow of opening a channel between two nodes.
9810
9811                 // Create Node A's channel pointing to Node B's pubkey
9812                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9813                 let config = UserConfig::default();
9814                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
9815
9816                 // Create Node B's channel by receiving Node A's open_channel message
9817                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
9818                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9819                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9820
9821                 // Node B --> Node A: accept channel
9822                 let accept_channel_msg = node_b_chan.accept_inbound_channel();
9823                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
9824
9825                 // Node A --> Node B: funding created
9826                 let output_script = node_a_chan.context.get_funding_redeemscript();
9827                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
9828                         value: 10000000, script_pubkey: output_script.clone(),
9829                 }]};
9830                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
9831                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
9832                 let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
9833
9834                 // Node B --> Node A: funding signed
9835                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
9836                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
9837
9838                 // Now disconnect the two nodes and check that the commitment point in
9839                 // Node B's channel_reestablish message is sane.
9840                 assert!(node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok());
9841                 let msg = node_b_chan.get_channel_reestablish(&&logger);
9842                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
9843                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
9844                 assert_eq!(msg.your_last_per_commitment_secret, [0; 32]);
9845
9846                 // Check that the commitment point in Node A's channel_reestablish message
9847                 // is sane.
9848                 assert!(node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger).is_ok());
9849                 let msg = node_a_chan.get_channel_reestablish(&&logger);
9850                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
9851                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
9852                 assert_eq!(msg.your_last_per_commitment_secret, [0; 32]);
9853         }
9854
9855         #[test]
9856         fn test_configured_holder_max_htlc_value_in_flight() {
9857                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9858                 let logger = test_utils::TestLogger::new();
9859                 let secp_ctx = Secp256k1::new();
9860                 let seed = [42; 32];
9861                 let network = Network::Testnet;
9862                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9863                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9864                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9865
9866                 let mut config_2_percent = UserConfig::default();
9867                 config_2_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 2;
9868                 let mut config_99_percent = UserConfig::default();
9869                 config_99_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 99;
9870                 let mut config_0_percent = UserConfig::default();
9871                 config_0_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 0;
9872                 let mut config_101_percent = UserConfig::default();
9873                 config_101_percent.channel_handshake_config.max_inbound_htlc_value_in_flight_percent_of_channel = 101;
9874
9875                 // Test that `OutboundV1Channel::new` creates a channel with the correct value for
9876                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
9877                 // which is set to the lower bound + 1 (2%) of the `channel_value`.
9878                 let chan_1 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_2_percent), 10000000, 100000, 42, &config_2_percent, 0, 42, None).unwrap();
9879                 let chan_1_value_msat = chan_1.context.channel_value_satoshis * 1000;
9880                 assert_eq!(chan_1.context.holder_max_htlc_value_in_flight_msat, (chan_1_value_msat as f64 * 0.02) as u64);
9881
9882                 // Test with the upper bound - 1 of valid values (99%).
9883                 let chan_2 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_99_percent), 10000000, 100000, 42, &config_99_percent, 0, 42, None).unwrap();
9884                 let chan_2_value_msat = chan_2.context.channel_value_satoshis * 1000;
9885                 assert_eq!(chan_2.context.holder_max_htlc_value_in_flight_msat, (chan_2_value_msat as f64 * 0.99) as u64);
9886
9887                 let chan_1_open_channel_msg = chan_1.get_open_channel(ChainHash::using_genesis_block(network));
9888
9889                 // Test that `InboundV1Channel::new` creates a channel with the correct value for
9890                 // `holder_max_htlc_value_in_flight_msat`, when configured with a valid percentage value,
9891                 // which is set to the lower bound - 1 (2%) of the `channel_value`.
9892                 let chan_3 = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9893                 let chan_3_value_msat = chan_3.context.channel_value_satoshis * 1000;
9894                 assert_eq!(chan_3.context.holder_max_htlc_value_in_flight_msat, (chan_3_value_msat as f64 * 0.02) as u64);
9895
9896                 // Test with the upper bound - 1 of valid values (99%).
9897                 let chan_4 = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9898                 let chan_4_value_msat = chan_4.context.channel_value_satoshis * 1000;
9899                 assert_eq!(chan_4.context.holder_max_htlc_value_in_flight_msat, (chan_4_value_msat as f64 * 0.99) as u64);
9900
9901                 // Test that `OutboundV1Channel::new` uses the lower bound of the configurable percentage values (1%)
9902                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
9903                 let chan_5 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_0_percent), 10000000, 100000, 42, &config_0_percent, 0, 42, None).unwrap();
9904                 let chan_5_value_msat = chan_5.context.channel_value_satoshis * 1000;
9905                 assert_eq!(chan_5.context.holder_max_htlc_value_in_flight_msat, (chan_5_value_msat as f64 * 0.01) as u64);
9906
9907                 // Test that `OutboundV1Channel::new` uses the upper bound of the configurable percentage values
9908                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
9909                 // than 100.
9910                 let chan_6 = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, outbound_node_id, &channelmanager::provided_init_features(&config_101_percent), 10000000, 100000, 42, &config_101_percent, 0, 42, None).unwrap();
9911                 let chan_6_value_msat = chan_6.context.channel_value_satoshis * 1000;
9912                 assert_eq!(chan_6.context.holder_max_htlc_value_in_flight_msat, chan_6_value_msat);
9913
9914                 // Test that `InboundV1Channel::new` uses the lower bound of the configurable percentage values (1%)
9915                 // if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a value less than 1.
9916                 let chan_7 = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9917                 let chan_7_value_msat = chan_7.context.channel_value_satoshis * 1000;
9918                 assert_eq!(chan_7.context.holder_max_htlc_value_in_flight_msat, (chan_7_value_msat as f64 * 0.01) as u64);
9919
9920                 // Test that `InboundV1Channel::new` uses the upper bound of the configurable percentage values
9921                 // (100%) if `max_inbound_htlc_value_in_flight_percent_of_channel` is set to a larger value
9922                 // than 100.
9923                 let chan_8 = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9924                 let chan_8_value_msat = chan_8.context.channel_value_satoshis * 1000;
9925                 assert_eq!(chan_8.context.holder_max_htlc_value_in_flight_msat, chan_8_value_msat);
9926         }
9927
9928         #[test]
9929         fn test_configured_holder_selected_channel_reserve_satoshis() {
9930
9931                 // Test that `OutboundV1Channel::new` and `InboundV1Channel::new` create a channel with the correct
9932                 // channel reserves, when `their_channel_reserve_proportional_millionths` is configured.
9933                 test_self_and_counterparty_channel_reserve(10_000_000, 0.02, 0.02);
9934
9935                 // Test with valid but unreasonably high channel reserves
9936                 // Requesting and accepting parties have requested for 49%-49% and 60%-30% channel reserve
9937                 test_self_and_counterparty_channel_reserve(10_000_000, 0.49, 0.49);
9938                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.30);
9939
9940                 // Test with calculated channel reserve less than lower bound
9941                 // i.e `MIN_THEIR_CHAN_RESERVE_SATOSHIS`
9942                 test_self_and_counterparty_channel_reserve(100_000, 0.00002, 0.30);
9943
9944                 // Test with invalid channel reserves since sum of both is greater than or equal
9945                 // to channel value
9946                 test_self_and_counterparty_channel_reserve(10_000_000, 0.50, 0.50);
9947                 test_self_and_counterparty_channel_reserve(10_000_000, 0.60, 0.50);
9948         }
9949
9950         fn test_self_and_counterparty_channel_reserve(channel_value_satoshis: u64, outbound_selected_channel_reserve_perc: f64, inbound_selected_channel_reserve_perc: f64) {
9951                 let fee_est = LowerBoundedFeeEstimator::new(&TestFeeEstimator { fee_est: 15_000 });
9952                 let logger = test_utils::TestLogger::new();
9953                 let secp_ctx = Secp256k1::new();
9954                 let seed = [42; 32];
9955                 let network = Network::Testnet;
9956                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9957                 let outbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9958                 let inbound_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
9959
9960
9961                 let mut outbound_node_config = UserConfig::default();
9962                 outbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (outbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
9963                 let chan = OutboundV1Channel::<&TestKeysInterface>::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, None).unwrap();
9964
9965                 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);
9966                 assert_eq!(chan.context.holder_selected_channel_reserve_satoshis, expected_outbound_selected_chan_reserve);
9967
9968                 let chan_open_channel_msg = chan.get_open_channel(ChainHash::using_genesis_block(network));
9969                 let mut inbound_node_config = UserConfig::default();
9970                 inbound_node_config.channel_handshake_config.their_channel_reserve_proportional_millionths = (inbound_selected_channel_reserve_perc * 1_000_000.0) as u32;
9971
9972                 if outbound_selected_channel_reserve_perc + inbound_selected_channel_reserve_perc < 1.0 {
9973                         let chan_inbound_node = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
9974
9975                         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);
9976
9977                         assert_eq!(chan_inbound_node.context.holder_selected_channel_reserve_satoshis, expected_inbound_selected_chan_reserve);
9978                         assert_eq!(chan_inbound_node.context.counterparty_selected_channel_reserve_satoshis.unwrap(), expected_outbound_selected_chan_reserve);
9979                 } else {
9980                         // Channel Negotiations failed
9981                         let result = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false);
9982                         assert!(result.is_err());
9983                 }
9984         }
9985
9986         #[test]
9987         fn channel_update() {
9988                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
9989                 let logger = test_utils::TestLogger::new();
9990                 let secp_ctx = Secp256k1::new();
9991                 let seed = [42; 32];
9992                 let network = Network::Testnet;
9993                 let best_block = BestBlock::from_network(network);
9994                 let chain_hash = ChainHash::using_genesis_block(network);
9995                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
9996
9997                 // Create Node A's channel pointing to Node B's pubkey
9998                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
9999                 let config = UserConfig::default();
10000                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
10001
10002                 // Create Node B's channel by receiving Node A's open_channel message
10003                 // Make sure A's dust limit is as we expect.
10004                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
10005                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
10006                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::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, /*is_0conf=*/false).unwrap();
10007
10008                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
10009                 let mut accept_channel_msg = node_b_chan.accept_inbound_channel();
10010                 accept_channel_msg.common_fields.dust_limit_satoshis = 546;
10011                 node_a_chan.accept_channel(&accept_channel_msg, &config.channel_handshake_limits, &channelmanager::provided_init_features(&config)).unwrap();
10012                 node_a_chan.context.holder_dust_limit_satoshis = 1560;
10013
10014                 // Node A --> Node B: funding created
10015                 let output_script = node_a_chan.context.get_funding_redeemscript();
10016                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10017                         value: 10000000, script_pubkey: output_script.clone(),
10018                 }]};
10019                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
10020                 let funding_created_msg = node_a_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap();
10021                 let (_, funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg.unwrap(), best_block, &&keys_provider, &&logger).map_err(|_| ()).unwrap();
10022
10023                 // Node B --> Node A: funding signed
10024                 let res = node_a_chan.funding_signed(&funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger);
10025                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
10026
10027                 // Make sure that receiving a channel update will update the Channel as expected.
10028                 let update = ChannelUpdate {
10029                         contents: UnsignedChannelUpdate {
10030                                 chain_hash,
10031                                 short_channel_id: 0,
10032                                 timestamp: 0,
10033                                 flags: 0,
10034                                 cltv_expiry_delta: 100,
10035                                 htlc_minimum_msat: 5,
10036                                 htlc_maximum_msat: MAX_VALUE_MSAT,
10037                                 fee_base_msat: 110,
10038                                 fee_proportional_millionths: 11,
10039                                 excess_data: Vec::new(),
10040                         },
10041                         signature: Signature::from(unsafe { FFISignature::new() })
10042                 };
10043                 assert!(node_a_chan.channel_update(&update).unwrap());
10044
10045                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
10046                 // change our official htlc_minimum_msat.
10047                 assert_eq!(node_a_chan.context.holder_htlc_minimum_msat, 1);
10048                 match node_a_chan.context.counterparty_forwarding_info() {
10049                         Some(info) => {
10050                                 assert_eq!(info.cltv_expiry_delta, 100);
10051                                 assert_eq!(info.fee_base_msat, 110);
10052                                 assert_eq!(info.fee_proportional_millionths, 11);
10053                         },
10054                         None => panic!("expected counterparty forwarding info to be Some")
10055                 }
10056
10057                 assert!(!node_a_chan.channel_update(&update).unwrap());
10058         }
10059
10060         #[test]
10061         fn blinding_point_skimmed_fee_malformed_ser() {
10062                 // Ensure that channel blinding points, skimmed fees, and malformed HTLCs are (de)serialized
10063                 // properly.
10064                 let logger = test_utils::TestLogger::new();
10065                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10066                 let secp_ctx = Secp256k1::new();
10067                 let seed = [42; 32];
10068                 let network = Network::Testnet;
10069                 let best_block = BestBlock::from_network(network);
10070                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
10071
10072                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
10073                 let config = UserConfig::default();
10074                 let features = channelmanager::provided_init_features(&config);
10075                 let mut outbound_chan = OutboundV1Channel::<&TestKeysInterface>::new(
10076                         &feeest, &&keys_provider, &&keys_provider, node_b_node_id, &features, 10000000, 100000, 42, &config, 0, 42, None
10077                 ).unwrap();
10078                 let inbound_chan = InboundV1Channel::<&TestKeysInterface>::new(
10079                         &feeest, &&keys_provider, &&keys_provider, node_b_node_id, &channelmanager::provided_channel_type_features(&config),
10080                         &features, &outbound_chan.get_open_channel(ChainHash::using_genesis_block(network)), 7, &config, 0, &&logger, false
10081                 ).unwrap();
10082                 outbound_chan.accept_channel(&inbound_chan.get_accept_channel_message(), &config.channel_handshake_limits, &features).unwrap();
10083                 let tx = Transaction { version: 1, lock_time: LockTime::ZERO, input: Vec::new(), output: vec![TxOut {
10084                         value: 10000000, script_pubkey: outbound_chan.context.get_funding_redeemscript(),
10085                 }]};
10086                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
10087                 let funding_created = outbound_chan.get_funding_created(tx.clone(), funding_outpoint, false, &&logger).map_err(|_| ()).unwrap().unwrap();
10088                 let mut chan = match inbound_chan.funding_created(&funding_created, best_block, &&keys_provider, &&logger) {
10089                         Ok((chan, _, _)) => chan,
10090                         Err((_, e)) => panic!("{}", e),
10091                 };
10092
10093                 let dummy_htlc_source = HTLCSource::OutboundRoute {
10094                         path: Path {
10095                                 hops: vec![RouteHop {
10096                                         pubkey: test_utils::pubkey(2), channel_features: ChannelFeatures::empty(),
10097                                         node_features: NodeFeatures::empty(), short_channel_id: 0, fee_msat: 0,
10098                                         cltv_expiry_delta: 0, maybe_announced_channel: false,
10099                                 }],
10100                                 blinded_tail: None
10101                         },
10102                         session_priv: test_utils::privkey(42),
10103                         first_hop_htlc_msat: 0,
10104                         payment_id: PaymentId([42; 32]),
10105                 };
10106                 let dummy_outbound_output = OutboundHTLCOutput {
10107                         htlc_id: 0,
10108                         amount_msat: 0,
10109                         payment_hash: PaymentHash([43; 32]),
10110                         cltv_expiry: 0,
10111                         state: OutboundHTLCState::Committed,
10112                         source: dummy_htlc_source.clone(),
10113                         skimmed_fee_msat: None,
10114                         blinding_point: None,
10115                 };
10116                 let mut pending_outbound_htlcs = vec![dummy_outbound_output.clone(); 10];
10117                 for (idx, htlc) in pending_outbound_htlcs.iter_mut().enumerate() {
10118                         if idx % 2 == 0 {
10119                                 htlc.blinding_point = Some(test_utils::pubkey(42 + idx as u8));
10120                         }
10121                         if idx % 3 == 0 {
10122                                 htlc.skimmed_fee_msat = Some(1);
10123                         }
10124                 }
10125                 chan.context.pending_outbound_htlcs = pending_outbound_htlcs.clone();
10126
10127                 let dummy_holding_cell_add_htlc = HTLCUpdateAwaitingACK::AddHTLC {
10128                         amount_msat: 0,
10129                         cltv_expiry: 0,
10130                         payment_hash: PaymentHash([43; 32]),
10131                         source: dummy_htlc_source.clone(),
10132                         onion_routing_packet: msgs::OnionPacket {
10133                                 version: 0,
10134                                 public_key: Ok(test_utils::pubkey(1)),
10135                                 hop_data: [0; 20*65],
10136                                 hmac: [0; 32]
10137                         },
10138                         skimmed_fee_msat: None,
10139                         blinding_point: None,
10140                 };
10141                 let dummy_holding_cell_claim_htlc = HTLCUpdateAwaitingACK::ClaimHTLC {
10142                         payment_preimage: PaymentPreimage([42; 32]),
10143                         htlc_id: 0,
10144                 };
10145                 let dummy_holding_cell_failed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailHTLC {
10146                         htlc_id, err_packet: msgs::OnionErrorPacket { data: vec![42] }
10147                 };
10148                 let dummy_holding_cell_malformed_htlc = |htlc_id| HTLCUpdateAwaitingACK::FailMalformedHTLC {
10149                         htlc_id, failure_code: INVALID_ONION_BLINDING, sha256_of_onion: [0; 32],
10150                 };
10151                 let mut holding_cell_htlc_updates = Vec::with_capacity(12);
10152                 for i in 0..12 {
10153                         if i % 5 == 0 {
10154                                 holding_cell_htlc_updates.push(dummy_holding_cell_add_htlc.clone());
10155                         } else if i % 5 == 1 {
10156                                 holding_cell_htlc_updates.push(dummy_holding_cell_claim_htlc.clone());
10157                         } else if i % 5 == 2 {
10158                                 let mut dummy_add = dummy_holding_cell_add_htlc.clone();
10159                                 if let HTLCUpdateAwaitingACK::AddHTLC {
10160                                         ref mut blinding_point, ref mut skimmed_fee_msat, ..
10161                                 } = &mut dummy_add {
10162                                         *blinding_point = Some(test_utils::pubkey(42 + i));
10163                                         *skimmed_fee_msat = Some(42);
10164                                 } else { panic!() }
10165                                 holding_cell_htlc_updates.push(dummy_add);
10166                         } else if i % 5 == 3 {
10167                                 holding_cell_htlc_updates.push(dummy_holding_cell_malformed_htlc(i as u64));
10168                         } else {
10169                                 holding_cell_htlc_updates.push(dummy_holding_cell_failed_htlc(i as u64));
10170                         }
10171                 }
10172                 chan.context.holding_cell_htlc_updates = holding_cell_htlc_updates.clone();
10173
10174                 // Encode and decode the channel and ensure that the HTLCs within are the same.
10175                 let encoded_chan = chan.encode();
10176                 let mut s = crate::io::Cursor::new(&encoded_chan);
10177                 let mut reader = crate::util::ser::FixedLengthReader::new(&mut s, encoded_chan.len() as u64);
10178                 let features = channelmanager::provided_channel_type_features(&config);
10179                 let decoded_chan = Channel::read(&mut reader, (&&keys_provider, &&keys_provider, 0, &features)).unwrap();
10180                 assert_eq!(decoded_chan.context.pending_outbound_htlcs, pending_outbound_htlcs);
10181                 assert_eq!(decoded_chan.context.holding_cell_htlc_updates, holding_cell_htlc_updates);
10182         }
10183
10184         #[cfg(all(feature = "_test_vectors", not(feature = "grind_signatures")))]
10185         #[test]
10186         fn outbound_commitment_test() {
10187                 use bitcoin::sighash;
10188                 use bitcoin::consensus::encode::serialize;
10189                 use bitcoin::sighash::EcdsaSighashType;
10190                 use bitcoin::hashes::hex::FromHex;
10191                 use bitcoin::hash_types::Txid;
10192                 use bitcoin::secp256k1::Message;
10193                 use crate::sign::{ChannelDerivationParameters, HTLCDescriptor, ecdsa::EcdsaChannelSigner};
10194                 use crate::ln::PaymentPreimage;
10195                 use crate::ln::channel::{HTLCOutputInCommitment ,TxCreationKeys};
10196                 use crate::ln::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint};
10197                 use crate::ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters};
10198                 use crate::util::logger::Logger;
10199                 use crate::sync::Arc;
10200                 use core::str::FromStr;
10201                 use hex::DisplayHex;
10202
10203                 // Test vectors from BOLT 3 Appendices C and F (anchors):
10204                 let feeest = TestFeeEstimator{fee_est: 15000};
10205                 let logger : Arc<dyn Logger> = Arc::new(test_utils::TestLogger::new());
10206                 let secp_ctx = Secp256k1::new();
10207
10208                 let mut signer = InMemorySigner::new(
10209                         &secp_ctx,
10210                         SecretKey::from_slice(&<Vec<u8>>::from_hex("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
10211                         SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
10212                         SecretKey::from_slice(&<Vec<u8>>::from_hex("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
10213                         SecretKey::from_slice(&<Vec<u8>>::from_hex("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
10214                         SecretKey::from_slice(&<Vec<u8>>::from_hex("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
10215
10216                         // These aren't set in the test vectors:
10217                         [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],
10218                         10_000_000,
10219                         [0; 32],
10220                         [0; 32],
10221                 );
10222
10223                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
10224                                 <Vec<u8>>::from_hex("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
10225                 let keys_provider = Keys { signer: signer.clone() };
10226
10227                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
10228                 let mut config = UserConfig::default();
10229                 config.channel_handshake_config.announced_channel = false;
10230                 let mut chan = OutboundV1Channel::<&Keys>::new(&LowerBoundedFeeEstimator::new(&feeest), &&keys_provider, &&keys_provider, counterparty_node_id, &channelmanager::provided_init_features(&config), 10_000_000, 0, 42, &config, 0, 42, None).unwrap(); // Nothing uses their network key in this test
10231                 chan.context.holder_dust_limit_satoshis = 546;
10232                 chan.context.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
10233
10234                 let funding_info = OutPoint{ txid: Txid::from_str("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
10235
10236                 let counterparty_pubkeys = ChannelPublicKeys {
10237                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
10238                         revocation_basepoint: RevocationBasepoint::from(PublicKey::from_slice(&<Vec<u8>>::from_hex("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap()),
10239                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
10240                         delayed_payment_basepoint: DelayedPaymentBasepoint::from(public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13")),
10241                         htlc_basepoint: HtlcBasepoint::from(public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"))
10242                 };
10243                 chan.context.channel_transaction_parameters.counterparty_parameters = Some(
10244                         CounterpartyChannelTransactionParameters {
10245                                 pubkeys: counterparty_pubkeys.clone(),
10246                                 selected_contest_delay: 144
10247                         });
10248                 chan.context.channel_transaction_parameters.funding_outpoint = Some(funding_info);
10249                 signer.provide_channel_parameters(&chan.context.channel_transaction_parameters);
10250
10251                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
10252                            <Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
10253
10254                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
10255                            <Vec<u8>>::from_hex("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
10256
10257                 assert_eq!(counterparty_pubkeys.htlc_basepoint.to_public_key().serialize()[..],
10258                            <Vec<u8>>::from_hex("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
10259
10260                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
10261                 // derived from a commitment_seed, so instead we copy it here and call
10262                 // build_commitment_transaction.
10263                 let delayed_payment_base = &chan.context.holder_signer.as_ref().pubkeys().delayed_payment_basepoint;
10264                 let per_commitment_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
10265                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
10266                 let htlc_basepoint = &chan.context.holder_signer.as_ref().pubkeys().htlc_basepoint;
10267                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint);
10268
10269                 macro_rules! test_commitment {
10270                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
10271                                 chan.context.channel_transaction_parameters.channel_type_features = ChannelTypeFeatures::only_static_remote_key();
10272                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, &ChannelTypeFeatures::only_static_remote_key(), $($remain)*);
10273                         };
10274                 }
10275
10276                 macro_rules! test_commitment_with_anchors {
10277                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $($remain:tt)* ) => {
10278                                 chan.context.channel_transaction_parameters.channel_type_features = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10279                                 test_commitment_common!($counterparty_sig_hex, $sig_hex, $tx_hex, &ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies(), $($remain)*);
10280                         };
10281                 }
10282
10283                 macro_rules! test_commitment_common {
10284                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, $opt_anchors: expr, {
10285                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
10286                         } ) => { {
10287                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
10288                                         let mut commitment_stats = chan.context.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
10289
10290                                         let htlcs = commitment_stats.htlcs_included.drain(..)
10291                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
10292                                                 .collect();
10293                                         (commitment_stats.tx, htlcs)
10294                                 };
10295                                 let trusted_tx = commitment_tx.trust();
10296                                 let unsigned_tx = trusted_tx.built_transaction();
10297                                 let redeemscript = chan.context.get_funding_redeemscript();
10298                                 let counterparty_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_sig_hex).unwrap()[..]).unwrap();
10299                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.context.channel_value_satoshis);
10300                                 log_trace!(logger, "unsigned_tx = {}", serialize(&unsigned_tx.transaction).as_hex());
10301                                 assert!(secp_ctx.verify_ecdsa(&sighash, &counterparty_signature, chan.context.counterparty_funding_pubkey()).is_ok(), "verify counterparty commitment sig");
10302
10303                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
10304                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
10305                                 let mut counterparty_htlc_sigs = Vec::new();
10306                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
10307                                 $({
10308                                         let remote_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
10309                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
10310                                         counterparty_htlc_sigs.push(remote_signature);
10311                                 })*
10312                                 assert_eq!(htlcs.len(), per_htlc.len());
10313
10314                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
10315                                         commitment_tx.clone(),
10316                                         counterparty_signature,
10317                                         counterparty_htlc_sigs,
10318                                         &chan.context.holder_signer.as_ref().pubkeys().funding_pubkey,
10319                                         chan.context.counterparty_funding_pubkey()
10320                                 );
10321                                 let holder_sig = signer.sign_holder_commitment(&holder_commitment_tx, &secp_ctx).unwrap();
10322                                 assert_eq!(Signature::from_der(&<Vec<u8>>::from_hex($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
10323
10324                                 let funding_redeemscript = chan.context.get_funding_redeemscript();
10325                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
10326                                 assert_eq!(serialize(&tx)[..], <Vec<u8>>::from_hex($tx_hex).unwrap()[..], "tx");
10327
10328                                 // ((htlc, counterparty_sig), (index, holder_sig))
10329                                 let mut htlc_counterparty_sig_iter = holder_commitment_tx.counterparty_htlc_sigs.iter();
10330
10331                                 $({
10332                                         log_trace!(logger, "verifying htlc {}", $htlc_idx);
10333                                         let remote_signature = Signature::from_der(&<Vec<u8>>::from_hex($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
10334
10335                                         let ref htlc = htlcs[$htlc_idx];
10336                                         let mut htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.context.feerate_per_kw,
10337                                                 chan.context.get_counterparty_selected_contest_delay().unwrap(),
10338                                                 &htlc, $opt_anchors, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
10339                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, $opt_anchors, &keys);
10340                                         let htlc_sighashtype = if $opt_anchors.supports_anchors_zero_fee_htlc_tx() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
10341                                         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();
10342                                         assert!(secp_ctx.verify_ecdsa(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key.to_public_key()).is_ok(), "verify counterparty htlc sig");
10343
10344                                         let mut preimage: Option<PaymentPreimage> = None;
10345                                         if !htlc.offered {
10346                                                 for i in 0..5 {
10347                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).to_byte_array());
10348                                                         if out == htlc.payment_hash {
10349                                                                 preimage = Some(PaymentPreimage([i; 32]));
10350                                                         }
10351                                                 }
10352
10353                                                 assert!(preimage.is_some());
10354                                         }
10355
10356                                         let htlc_counterparty_sig = htlc_counterparty_sig_iter.next().unwrap();
10357                                         let htlc_holder_sig = signer.sign_holder_htlc_transaction(&htlc_tx, 0, &HTLCDescriptor {
10358                                                 channel_derivation_parameters: ChannelDerivationParameters {
10359                                                         value_satoshis: chan.context.channel_value_satoshis,
10360                                                         keys_id: chan.context.channel_keys_id,
10361                                                         transaction_parameters: chan.context.channel_transaction_parameters.clone(),
10362                                                 },
10363                                                 commitment_txid: trusted_tx.txid(),
10364                                                 per_commitment_number: trusted_tx.commitment_number(),
10365                                                 per_commitment_point: trusted_tx.per_commitment_point(),
10366                                                 feerate_per_kw: trusted_tx.feerate_per_kw(),
10367                                                 htlc: htlc.clone(),
10368                                                 preimage: preimage.clone(),
10369                                                 counterparty_sig: *htlc_counterparty_sig,
10370                                         }, &secp_ctx).unwrap();
10371                                         let num_anchors = if $opt_anchors.supports_anchors_zero_fee_htlc_tx() { 2 } else { 0 };
10372                                         assert_eq!(htlc.transaction_output_index, Some($htlc_idx + num_anchors), "output index");
10373
10374                                         let signature = Signature::from_der(&<Vec<u8>>::from_hex($htlc_sig_hex).unwrap()[..]).unwrap();
10375                                         assert_eq!(signature, htlc_holder_sig, "htlc sig");
10376                                         let trusted_tx = holder_commitment_tx.trust();
10377                                         htlc_tx.input[0].witness = trusted_tx.build_htlc_input_witness($htlc_idx, htlc_counterparty_sig, &htlc_holder_sig, &preimage);
10378                                         log_trace!(logger, "htlc_tx = {}", serialize(&htlc_tx).as_hex());
10379                                         assert_eq!(serialize(&htlc_tx)[..], <Vec<u8>>::from_hex($htlc_tx_hex).unwrap()[..], "htlc tx");
10380                                 })*
10381                                 assert!(htlc_counterparty_sig_iter.next().is_none());
10382                         } }
10383                 }
10384
10385                 // anchors: simple commitment tx with no HTLCs and single anchor
10386                 test_commitment_with_anchors!("30440220655bf909fb6fa81d086f1336ac72c97906dce29d1b166e305c99152d810e26e1022051f577faa46412c46707aaac46b65d50053550a66334e00a44af2706f27a8658",
10387                                                  "3044022007cf6b405e9c9b4f527b0ecad9d8bb661fabb8b12abf7d1c0b3ad1855db3ed490220616d5c1eeadccc63bd775a131149455d62d95a42c2a1b01cc7821fc42dce7778",
10388                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f10529800000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022007cf6b405e9c9b4f527b0ecad9d8bb661fabb8b12abf7d1c0b3ad1855db3ed490220616d5c1eeadccc63bd775a131149455d62d95a42c2a1b01cc7821fc42dce7778014730440220655bf909fb6fa81d086f1336ac72c97906dce29d1b166e305c99152d810e26e1022051f577faa46412c46707aaac46b65d50053550a66334e00a44af2706f27a865801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10389
10390                 // simple commitment tx with no HTLCs
10391                 chan.context.value_to_self_msat = 7000000000;
10392
10393                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
10394                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
10395                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10396
10397                 // anchors: simple commitment tx with no HTLCs
10398                 test_commitment_with_anchors!("3045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f3",
10399                                                  "30450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f7",
10400                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a508b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008266ac6db5ea71aac3c95d97b0e172ff596844851a3216eb88382a8dddfd33d2022050e240974cfd5d708708b4365574517c18e7ae535ef732a3484d43d0d82be9f701483045022100f89034eba16b2be0e5581f750a0a6309192b75cce0f202f0ee2b4ec0cc394850022076c65dc507fe42276152b7a3d90e961e678adbe966e916ecfe85e64d430e75f301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10401
10402                 chan.context.pending_inbound_htlcs.push({
10403                         let mut out = InboundHTLCOutput{
10404                                 htlc_id: 0,
10405                                 amount_msat: 1000000,
10406                                 cltv_expiry: 500,
10407                                 payment_hash: PaymentHash([0; 32]),
10408                                 state: InboundHTLCState::Committed,
10409                         };
10410                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).to_byte_array();
10411                         out
10412                 });
10413                 chan.context.pending_inbound_htlcs.push({
10414                         let mut out = InboundHTLCOutput{
10415                                 htlc_id: 1,
10416                                 amount_msat: 2000000,
10417                                 cltv_expiry: 501,
10418                                 payment_hash: PaymentHash([0; 32]),
10419                                 state: InboundHTLCState::Committed,
10420                         };
10421                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).to_byte_array();
10422                         out
10423                 });
10424                 chan.context.pending_outbound_htlcs.push({
10425                         let mut out = OutboundHTLCOutput{
10426                                 htlc_id: 2,
10427                                 amount_msat: 2000000,
10428                                 cltv_expiry: 502,
10429                                 payment_hash: PaymentHash([0; 32]),
10430                                 state: OutboundHTLCState::Committed,
10431                                 source: HTLCSource::dummy(),
10432                                 skimmed_fee_msat: None,
10433                                 blinding_point: None,
10434                         };
10435                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).to_byte_array();
10436                         out
10437                 });
10438                 chan.context.pending_outbound_htlcs.push({
10439                         let mut out = OutboundHTLCOutput{
10440                                 htlc_id: 3,
10441                                 amount_msat: 3000000,
10442                                 cltv_expiry: 503,
10443                                 payment_hash: PaymentHash([0; 32]),
10444                                 state: OutboundHTLCState::Committed,
10445                                 source: HTLCSource::dummy(),
10446                                 skimmed_fee_msat: None,
10447                                 blinding_point: None,
10448                         };
10449                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).to_byte_array();
10450                         out
10451                 });
10452                 chan.context.pending_inbound_htlcs.push({
10453                         let mut out = InboundHTLCOutput{
10454                                 htlc_id: 4,
10455                                 amount_msat: 4000000,
10456                                 cltv_expiry: 504,
10457                                 payment_hash: PaymentHash([0; 32]),
10458                                 state: InboundHTLCState::Committed,
10459                         };
10460                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).to_byte_array();
10461                         out
10462                 });
10463
10464                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
10465                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10466                 chan.context.feerate_per_kw = 0;
10467
10468                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
10469                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
10470                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10471
10472                                   { 0,
10473                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
10474                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
10475                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
10476
10477                                   { 1,
10478                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
10479                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
10480                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10481
10482                                   { 2,
10483                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
10484                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
10485                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10486
10487                                   { 3,
10488                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
10489                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
10490                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10491
10492                                   { 4,
10493                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
10494                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
10495                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10496                 } );
10497
10498                 // commitment tx with seven outputs untrimmed (maximum feerate)
10499                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10500                 chan.context.feerate_per_kw = 647;
10501
10502                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
10503                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
10504                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10505
10506                                   { 0,
10507                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
10508                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
10509                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
10510
10511                                   { 1,
10512                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
10513                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
10514                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10515
10516                                   { 2,
10517                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
10518                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
10519                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10520
10521                                   { 3,
10522                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
10523                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
10524                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10525
10526                                   { 4,
10527                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
10528                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
10529                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10530                 } );
10531
10532                 // commitment tx with six outputs untrimmed (minimum feerate)
10533                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10534                 chan.context.feerate_per_kw = 648;
10535
10536                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
10537                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
10538                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10539
10540                                   { 0,
10541                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
10542                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
10543                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10544
10545                                   { 1,
10546                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
10547                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
10548                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10549
10550                                   { 2,
10551                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
10552                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
10553                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10554
10555                                   { 3,
10556                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
10557                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
10558                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10559                 } );
10560
10561                 // anchors: commitment tx with six outputs untrimmed (minimum dust limit)
10562                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10563                 chan.context.feerate_per_kw = 645;
10564                 chan.context.holder_dust_limit_satoshis = 1001;
10565
10566                 test_commitment_with_anchors!("3044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc312",
10567                                  "3045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d0051",
10568                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80084a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d0070000000000002200203e68115ae0b15b8de75b6c6bc9af5ac9f01391544e0870dae443a1e8fe7837ead007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5eb80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994abc996a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d57697c707b6f6d053febf24b98e8989f186eea42e37e9e91663ec2c70bb8f70022079b0715a472118f262f43016a674f59c015d9cafccec885968e76d9d9c5d005101473044022025d97466c8049e955a5afce28e322f4b34d2561118e52332fb400f9b908cc0a402205dc6fba3a0d67ee142c428c535580cd1f2ff42e2f89b47e0c8a01847caffc31201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10569
10570                                   { 0,
10571                                   "3045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc282",
10572                                   "3045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef09",
10573                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320002000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e04d160a326432659fe9fb127304c1d348dfeaba840081bdc57d8efd902a48d8022008a824e7cf5492b97e4d9e03c06a09f822775a44f6b5b2533a2088904abfc28283483045022100b7c49846466b13b190ff739bbe3005c105482fc55539e55b1c561f76b6982b6c02200e5c35808619cf543c8405cff9fedd25f333a4a2f6f6d5e8af8150090c40ef0901008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6851b27568f6010000" },
10574
10575                                   { 1,
10576                                   "3045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e",
10577                                   "3045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac",
10578                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320003000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fbdc3c367ce3bf30796025cc590ee1f2ce0e72ae1ac19f5986d6d0a4fc76211f02207e45ae9267e8e820d188569604f71d1abd11bd385d58853dd7dc034cdb3e9a6e83483045022100d29330f24db213b262068706099b39c15fa7e070c3fcdf8836c09723fc4d365602203ce57d01e9f28601e461a0b5c4a50119b270bde8b70148d133a6849c70b115ac012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
10579
10580                                   { 2,
10581                                   "3044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c1",
10582                                   "304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e",
10583                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320004000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022066c5ef625cee3ddd2bc7b6bfb354b5834cf1cc6d52dd972fb41b7b225437ae4a022066cb85647df65c6b87a54e416dcdcca778a776c36a9643d2b5dc793c9b29f4c18347304402202d4ce515cd9000ec37575972d70b8d24f73909fb7012e8ebd8c2066ef6fe187902202830b53e64ea565fecd0f398100691da6bb2a5cf9bb0d1926f1d71d05828a11e01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
10584
10585                                   { 3,
10586                                   "3044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc615",
10587                                   "3045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226",
10588                                   "02000000000101104f394af4c4fad78337f95e3e9f802f4c0d86ab231853af09b285348561320005000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022022c7e11595c53ee89a57ca76baf0aed730da035952d6ab3fe6459f5eff3b337a022075e10cc5f5fd724a35ce4087a5d03cd616698626c69814032132b50bb97dc61583483045022100b20cd63e0587d1711beaebda4730775c4ac8b8b2ec78fe18a0c44c3f168c25230220079abb7fc4924e2fca5950842e5b9e416735585026914570078c4ef62f286226012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10589                 } );
10590
10591                 // commitment tx with six outputs untrimmed (maximum feerate)
10592                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10593                 chan.context.feerate_per_kw = 2069;
10594                 chan.context.holder_dust_limit_satoshis = 546;
10595
10596                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
10597                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
10598                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10599
10600                                   { 0,
10601                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
10602                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
10603                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10604
10605                                   { 1,
10606                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
10607                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
10608                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10609
10610                                   { 2,
10611                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
10612                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
10613                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10614
10615                                   { 3,
10616                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
10617                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
10618                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10619                 } );
10620
10621                 // commitment tx with five outputs untrimmed (minimum feerate)
10622                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10623                 chan.context.feerate_per_kw = 2070;
10624
10625                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
10626                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
10627                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10628
10629                                   { 0,
10630                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
10631                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
10632                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10633
10634                                   { 1,
10635                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
10636                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
10637                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10638
10639                                   { 2,
10640                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
10641                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
10642                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10643                 } );
10644
10645                 // commitment tx with five outputs untrimmed (maximum feerate)
10646                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10647                 chan.context.feerate_per_kw = 2194;
10648
10649                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
10650                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
10651                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10652
10653                                   { 0,
10654                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
10655                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
10656                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
10657
10658                                   { 1,
10659                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
10660                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
10661                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10662
10663                                   { 2,
10664                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
10665                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
10666                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10667                 } );
10668
10669                 // commitment tx with four outputs untrimmed (minimum feerate)
10670                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10671                 chan.context.feerate_per_kw = 2195;
10672
10673                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
10674                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
10675                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10676
10677                                   { 0,
10678                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
10679                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
10680                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10681
10682                                   { 1,
10683                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
10684                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
10685                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10686                 } );
10687
10688                 // anchors: commitment tx with four outputs untrimmed (minimum dust limit)
10689                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10690                 chan.context.feerate_per_kw = 2185;
10691                 chan.context.holder_dust_limit_satoshis = 2001;
10692                 let cached_channel_type = chan.context.channel_type;
10693                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10694
10695                 test_commitment_with_anchors!("3044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c0",
10696                                  "3045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd5",
10697                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80064a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994b80b000000000000220020f96d0334feb64a4f40eb272031d07afcb038db56aa57446d60308c9f8ccadef9a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ac5916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100cd8479cfe1edb1e5a1d487391e0451a469c7171e51e680183f19eb4321f20e9b02204eab7d5a6384b1b08e03baa6e4d9748dfd2b5ab2bae7e39604a0d0055bbffdd501473044022040f63a16148cf35c8d3d41827f5ae7f7c3746885bb64d4d1b895892a83812b3e02202fcf95c2bf02c466163b3fa3ced6a24926fbb4035095a96842ef516e86ba54c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10698
10699                                   { 0,
10700                                   "304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb",
10701                                   "30440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f",
10702                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc02000000000100000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206870514a72ad6e723ff7f1e0370d7a33c1cd2a0b9272674143ebaf6a1d02dee102205bd953c34faf5e7322e9a1c0103581cb090280fda4f1039ee8552668afa90ebb834730440220669de9ca7910eff65a7773ebd14a9fc371fe88cde5b8e2a81609d85c87ac939b02201ac29472fa4067322e92d75b624942d60be5050139b20bb363db75be79eb946f01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6851b27568f7010000" },
10703
10704                                   { 1,
10705                                   "3045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd7271",
10706                                   "3045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688",
10707                                   "02000000000101ac13a7715f80b8e52dda43c6929cade5521bdced3a405da02b443f1ffb1e33cc03000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100949e8dd938da56445b1cdfdebe1b7efea086edd05d89910d205a1e2e033ce47102202cbd68b5262ab144d9ec12653f87dfb0bb6bd05d1f58ae1e523f028eaefd727183483045022100e3104ed8b239f8019e5f0a1a73d7782a94a8c36e7984f476c3a0b3cb0e62e27902207e3d52884600985f8a2098e53a5c30dd6a5e857733acfaa07ab2162421ed2688012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10708                 } );
10709
10710                 // commitment tx with four outputs untrimmed (maximum feerate)
10711                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10712                 chan.context.feerate_per_kw = 3702;
10713                 chan.context.holder_dust_limit_satoshis = 546;
10714                 chan.context.channel_type = cached_channel_type.clone();
10715
10716                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
10717                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
10718                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10719
10720                                   { 0,
10721                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
10722                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
10723                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
10724
10725                                   { 1,
10726                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
10727                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
10728                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10729                 } );
10730
10731                 // commitment tx with three outputs untrimmed (minimum feerate)
10732                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10733                 chan.context.feerate_per_kw = 3703;
10734
10735                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
10736                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
10737                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10738
10739                                   { 0,
10740                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
10741                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
10742                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10743                 } );
10744
10745                 // anchors: commitment tx with three outputs untrimmed (minimum dust limit)
10746                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10747                 chan.context.feerate_per_kw = 3687;
10748                 chan.context.holder_dust_limit_satoshis = 3001;
10749                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10750
10751                 test_commitment_with_anchors!("3045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c228377",
10752                                  "3045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d",
10753                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80054a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994a00f000000000000220020ce6e751274836ff59622a0d1e07f8831d80bd6730bd48581398bfadd2bb8da9ac0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aa28b6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c970799bcb33f43179eb43b3378a0a61991cf2923f69b36ef12548c3df0e6d500220413dc27d2e39ee583093adfcb7799be680141738babb31cc7b0669a777a31f5d01483045022100ad6c71569856b2d7ff42e838b4abe74a713426b37f22fa667a195a4c88908c6902202b37272b02a42dc6d9f4f82cab3eaf84ac882d9ed762859e1e75455c2c22837701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10754
10755                                   { 0,
10756                                   "3044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c",
10757                                   "3045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de",
10758                                   "02000000000101542562b326c08e3a076d9cfca2be175041366591da334d8d513ff1686fd95a6002000000000100000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022017b558a3cf5f0cb94269e2e927b29ed22bd2416abb8a7ce6de4d1256f359b93602202e9ca2b1a23ea3e69f433c704e327739e219804b8c188b1d52f74fd5a9de954c83483045022100af7a8b7c7ff2080c68995254cb66d64d9954edcc5baac3bb4f27ed2d29aaa6120220421c27da7a60574a9263f271e0f3bd34594ec6011095190022b3b54596ea03de012004040404040404040404040404040404040404040404040404040404040404048d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac6851b2756800000000" }
10759                 } );
10760
10761                 // commitment tx with three outputs untrimmed (maximum feerate)
10762                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10763                 chan.context.feerate_per_kw = 4914;
10764                 chan.context.holder_dust_limit_satoshis = 546;
10765                 chan.context.channel_type = cached_channel_type.clone();
10766
10767                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
10768                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
10769                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10770
10771                                   { 0,
10772                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
10773                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
10774                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
10775                 } );
10776
10777                 // commitment tx with two outputs untrimmed (minimum feerate)
10778                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10779                 chan.context.feerate_per_kw = 4915;
10780                 chan.context.holder_dust_limit_satoshis = 546;
10781
10782                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
10783                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
10784                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10785
10786                 // anchors: commitment tx with two outputs untrimmed (minimum dust limit)
10787                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10788                 chan.context.feerate_per_kw = 4894;
10789                 chan.context.holder_dust_limit_satoshis = 4001;
10790                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10791
10792                 test_commitment_with_anchors!("3045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b95",
10793                                  "30450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd",
10794                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80044a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994ad0886a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009f16ac85d232e4eddb3fcd750a68ebf0b58e3356eaada45d3513ede7e817bf4c02207c2b043b4e5f971261975406cb955219fa56bffe5d834a833694b5abc1ce4cfd01483045022100e784a66b1588575801e237d35e510fd92a81ae3a4a2a1b90c031ad803d07b3f3022021bc5f16501f167607d63b681442da193eb0a76b4b7fd25c2ed4f8b28fd35b9501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10795
10796                 // commitment tx with two outputs untrimmed (maximum feerate)
10797                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10798                 chan.context.feerate_per_kw = 9651180;
10799                 chan.context.holder_dust_limit_satoshis = 546;
10800                 chan.context.channel_type = cached_channel_type.clone();
10801
10802                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
10803                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
10804                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10805
10806                 // commitment tx with one output untrimmed (minimum feerate)
10807                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10808                 chan.context.feerate_per_kw = 9651181;
10809
10810                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
10811                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
10812                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10813
10814                 // anchors: commitment tx with one output untrimmed (minimum dust limit)
10815                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10816                 chan.context.feerate_per_kw = 6216010;
10817                 chan.context.holder_dust_limit_satoshis = 4001;
10818                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10819
10820                 test_commitment_with_anchors!("30450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf",
10821                                  "30450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1",
10822                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80024a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994a04004830450221009ad80792e3038fe6968d12ff23e6888a565c3ddd065037f357445f01675d63f3022018384915e5f1f4ae157e15debf4f49b61c8d9d2b073c7d6f97c4a68caa3ed4c1014830450221008fd5dbff02e4b59020d4cd23a3c30d3e287065fda75a0a09b402980adf68ccda022001e0b8b620cd915ddff11f1de32addf23d81d51b90e6841b2cb8dcaf3faa5ecf01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10823
10824                 // commitment tx with fee greater than funder amount
10825                 chan.context.value_to_self_msat = 6993000000; // 7000000000 - 7000000
10826                 chan.context.feerate_per_kw = 9651936;
10827                 chan.context.holder_dust_limit_satoshis = 546;
10828                 chan.context.channel_type = cached_channel_type;
10829
10830                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
10831                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
10832                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
10833
10834                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
10835                 chan.context.value_to_self_msat = 7_000_000_000 - 2_000_000;
10836                 chan.context.feerate_per_kw = 253;
10837                 chan.context.pending_inbound_htlcs.clear();
10838                 chan.context.pending_inbound_htlcs.push({
10839                         let mut out = InboundHTLCOutput{
10840                                 htlc_id: 1,
10841                                 amount_msat: 2000000,
10842                                 cltv_expiry: 501,
10843                                 payment_hash: PaymentHash([0; 32]),
10844                                 state: InboundHTLCState::Committed,
10845                         };
10846                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).to_byte_array();
10847                         out
10848                 });
10849                 chan.context.pending_outbound_htlcs.clear();
10850                 chan.context.pending_outbound_htlcs.push({
10851                         let mut out = OutboundHTLCOutput{
10852                                 htlc_id: 6,
10853                                 amount_msat: 5000001,
10854                                 cltv_expiry: 506,
10855                                 payment_hash: PaymentHash([0; 32]),
10856                                 state: OutboundHTLCState::Committed,
10857                                 source: HTLCSource::dummy(),
10858                                 skimmed_fee_msat: None,
10859                                 blinding_point: None,
10860                         };
10861                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).to_byte_array();
10862                         out
10863                 });
10864                 chan.context.pending_outbound_htlcs.push({
10865                         let mut out = OutboundHTLCOutput{
10866                                 htlc_id: 5,
10867                                 amount_msat: 5000000,
10868                                 cltv_expiry: 505,
10869                                 payment_hash: PaymentHash([0; 32]),
10870                                 state: OutboundHTLCState::Committed,
10871                                 source: HTLCSource::dummy(),
10872                                 skimmed_fee_msat: None,
10873                                 blinding_point: None,
10874                         };
10875                         out.payment_hash.0 = Sha256::hash(&<Vec<u8>>::from_hex("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).to_byte_array();
10876                         out
10877                 });
10878
10879                 test_commitment!("304402207d0870964530f97b62497b11153c551dca0a1e226815ef0a336651158da0f82402200f5378beee0e77759147b8a0a284decd11bfd2bc55c8fafa41c134fe996d43c8",
10880                                  "304402200d10bf5bc5397fc59d7188ae438d80c77575595a2d488e41bd6363a810cc8d72022012b57e714fbbfdf7a28c47d5b370cb8ac37c8545f596216e5b21e9b236ef457c",
10881                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a69f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200d10bf5bc5397fc59d7188ae438d80c77575595a2d488e41bd6363a810cc8d72022012b57e714fbbfdf7a28c47d5b370cb8ac37c8545f596216e5b21e9b236ef457c0147304402207d0870964530f97b62497b11153c551dca0a1e226815ef0a336651158da0f82402200f5378beee0e77759147b8a0a284decd11bfd2bc55c8fafa41c134fe996d43c801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10882
10883                                   { 0,
10884                                   "3045022100b470fe12e5b7fea9eccb8cbff1972cea4f96758041898982a02bcc7f9d56d50b0220338a75b2afaab4ec00cdd2d9273c68c7581ff5a28bcbb40c4d138b81f1d45ce5",
10885                                   "3044022017b90c65207522a907fb6a137f9dd528b3389465a8ae72308d9e1d564f512cf402204fc917b4f0e88604a3e994f85bfae7c7c1f9d9e9f78e8cd112e0889720d9405b",
10886                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100b470fe12e5b7fea9eccb8cbff1972cea4f96758041898982a02bcc7f9d56d50b0220338a75b2afaab4ec00cdd2d9273c68c7581ff5a28bcbb40c4d138b81f1d45ce501473044022017b90c65207522a907fb6a137f9dd528b3389465a8ae72308d9e1d564f512cf402204fc917b4f0e88604a3e994f85bfae7c7c1f9d9e9f78e8cd112e0889720d9405b012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
10887                                   { 1,
10888                                   "3045022100b575379f6d8743cb0087648f81cfd82d17a97fbf8f67e058c65ce8b9d25df9500220554a210d65b02d9f36c6adf0f639430ca8293196ba5089bf67cc3a9813b7b00a",
10889                                   "3045022100ee2e16b90930a479b13f8823a7f14b600198c838161160b9436ed086d3fc57e002202a66fa2324f342a17129949c640bfe934cbc73a869ba7c06aa25c5a3d0bfb53d",
10890                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec01000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100b575379f6d8743cb0087648f81cfd82d17a97fbf8f67e058c65ce8b9d25df9500220554a210d65b02d9f36c6adf0f639430ca8293196ba5089bf67cc3a9813b7b00a01483045022100ee2e16b90930a479b13f8823a7f14b600198c838161160b9436ed086d3fc57e002202a66fa2324f342a17129949c640bfe934cbc73a869ba7c06aa25c5a3d0bfb53d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
10891                                   { 2,
10892                                   "30440220471c9f3ad92e49b13b7b8059f43ecf8f7887b0dccbb9fdb54bfe23d62a8ae332022024bd22fae0740e86a44228c35330da9526fd7306dffb2b9dc362d5e78abef7cc",
10893                                   "304402207157f452f2506d73c315192311893800cfb3cc235cc1185b1cfcc136b55230db022014be242dbc6c5da141fec4034e7f387f74d6ff1899453d72ba957467540e1ecb",
10894                                   "020000000001014bdccf28653066a2c554cafeffdfe1e678e64a69b056684deb0c4fba909423ec02000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220471c9f3ad92e49b13b7b8059f43ecf8f7887b0dccbb9fdb54bfe23d62a8ae332022024bd22fae0740e86a44228c35330da9526fd7306dffb2b9dc362d5e78abef7cc0147304402207157f452f2506d73c315192311893800cfb3cc235cc1185b1cfcc136b55230db022014be242dbc6c5da141fec4034e7f387f74d6ff1899453d72ba957467540e1ecb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
10895                 } );
10896
10897                 chan.context.channel_type = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
10898                 test_commitment_with_anchors!("3044022027b38dfb654c34032ffb70bb43022981652fce923cbbe3cbe7394e2ade8b34230220584195b78da6e25c2e8da6b4308d9db25b65b64975db9266163ef592abb7c725",
10899                                  "3045022100b4014970d9d7962853f3f85196144671d7d5d87426250f0a5fdaf9a55292e92502205360910c9abb397467e19dbd63d081deb4a3240903114c98cec0a23591b79b76",
10900                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b80074a010000000000002200202b1b5854183c12d3316565972c4668929d314d81c5dcdbb21cb45fe8a9a8114f4a01000000000000220020e9e86e4823faa62e222ebc858a226636856158f07e69898da3b0d1af0ddb3994d007000000000000220020fe0598d74fee2205cc3672e6e6647706b4f3099713b4661b62482c3addd04a5e881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7881300000000000022002018e40f9072c44350f134bdc887bab4d9bdfc8aa468a25616c80e21757ba5dac7c0c62d0000000000220020f3394e1e619b0eca1f91be2fb5ab4dfc59ba5b84ebe014ad1d43a564d012994aad9c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b4014970d9d7962853f3f85196144671d7d5d87426250f0a5fdaf9a55292e92502205360910c9abb397467e19dbd63d081deb4a3240903114c98cec0a23591b79b7601473044022027b38dfb654c34032ffb70bb43022981652fce923cbbe3cbe7394e2ade8b34230220584195b78da6e25c2e8da6b4308d9db25b65b64975db9266163ef592abb7c72501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
10901
10902                                   { 0,
10903                                   "30440220078fe5343dab88c348a3a8a9c1a9293259dbf35507ae971702cc39dd623ea9af022011ed0c0f35243cd0bb4d9ca3c772379b2b5f4af93140e9fdc5600dfec1cdb0c2",
10904                                   "304402205df665e2908c7690d2d33eb70e6e119958c28febe141a94ed0dd9a55ce7c8cfc0220364d02663a5d019af35c5cd5fda9465d985d85bbd12db207738d61163449a424",
10905                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c402000000000100000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220078fe5343dab88c348a3a8a9c1a9293259dbf35507ae971702cc39dd623ea9af022011ed0c0f35243cd0bb4d9ca3c772379b2b5f4af93140e9fdc5600dfec1cdb0c28347304402205df665e2908c7690d2d33eb70e6e119958c28febe141a94ed0dd9a55ce7c8cfc0220364d02663a5d019af35c5cd5fda9465d985d85bbd12db207738d61163449a424012001010101010101010101010101010101010101010101010101010101010101018d76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac6851b2756800000000" },
10906                                   { 1,
10907                                   "304402202df6bf0f98a42cfd0172a16bded7d1b16c14f5f42ba23f5c54648c14b647531302200fe1508626817f23925bb56951d5e4b2654c751743ab6db48a6cce7dda17c01c",
10908                                   "304402203f99ec05cdd89558a23683b471c1dcce8f6a92295f1fff3b0b5d21be4d4f97ea022019d29070690fc2c126fe27cc4ab2f503f289d362721b2efa7418e7fddb939a5b",
10909                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c40300000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202df6bf0f98a42cfd0172a16bded7d1b16c14f5f42ba23f5c54648c14b647531302200fe1508626817f23925bb56951d5e4b2654c751743ab6db48a6cce7dda17c01c8347304402203f99ec05cdd89558a23683b471c1dcce8f6a92295f1fff3b0b5d21be4d4f97ea022019d29070690fc2c126fe27cc4ab2f503f289d362721b2efa7418e7fddb939a5b01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568f9010000" },
10910                                   { 2,
10911                                   "3045022100bd206b420c495f3aa714d3ea4766cbe95441deacb5d2f737f1913349aee7c2ae02200249d2c950dd3b15326bf378ae5d2b871d33d6737f5d70735f3de8383140f2a1",
10912                                   "3045022100f2cd35e385b9b7e15b92a5d78d120b6b2c5af4e974bc01e884c5facb3bb5966c0220706e0506477ce809a40022d6de8e041e9ef13136c45abee9c36f58a01fdb188b",
10913                                   "020000000001013d060d0305c9616eaabc21d41fae85bcb5477b5d7f1c92aa429cf15339bbe1c40400000000010000000188130000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100bd206b420c495f3aa714d3ea4766cbe95441deacb5d2f737f1913349aee7c2ae02200249d2c950dd3b15326bf378ae5d2b871d33d6737f5d70735f3de8383140f2a183483045022100f2cd35e385b9b7e15b92a5d78d120b6b2c5af4e974bc01e884c5facb3bb5966c0220706e0506477ce809a40022d6de8e041e9ef13136c45abee9c36f58a01fdb188b01008876a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6851b27568fa010000" }
10914                 } );
10915         }
10916
10917         #[test]
10918         fn test_per_commitment_secret_gen() {
10919                 // Test vectors from BOLT 3 Appendix D:
10920
10921                 let mut seed = [0; 32];
10922                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
10923                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
10924                            <Vec<u8>>::from_hex("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
10925
10926                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
10927                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
10928                            <Vec<u8>>::from_hex("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
10929
10930                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
10931                            <Vec<u8>>::from_hex("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
10932
10933                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
10934                            <Vec<u8>>::from_hex("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
10935
10936                 seed[0..32].clone_from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
10937                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
10938                            <Vec<u8>>::from_hex("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
10939         }
10940
10941         #[test]
10942         fn test_key_derivation() {
10943                 // Test vectors from BOLT 3 Appendix E:
10944                 let secp_ctx = Secp256k1::new();
10945
10946                 let base_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
10947                 let per_commitment_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
10948
10949                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
10950                 assert_eq!(base_point.serialize()[..], <Vec<u8>>::from_hex("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
10951
10952                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
10953                 assert_eq!(per_commitment_point.serialize()[..], <Vec<u8>>::from_hex("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
10954
10955                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret),
10956                                 SecretKey::from_slice(&<Vec<u8>>::from_hex("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
10957
10958                 assert_eq!(RevocationKey::from_basepoint(&secp_ctx, &RevocationBasepoint::from(base_point), &per_commitment_point).to_public_key().serialize()[..],
10959                                 <Vec<u8>>::from_hex("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
10960
10961                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret),
10962                                 SecretKey::from_slice(&<Vec<u8>>::from_hex("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
10963         }
10964
10965         #[test]
10966         fn test_zero_conf_channel_type_support() {
10967                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10968                 let secp_ctx = Secp256k1::new();
10969                 let seed = [42; 32];
10970                 let network = Network::Testnet;
10971                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
10972                 let logger = test_utils::TestLogger::new();
10973
10974                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
10975                 let config = UserConfig::default();
10976                 let node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider,
10977                         node_b_node_id, &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42, None).unwrap();
10978
10979                 let mut channel_type_features = ChannelTypeFeatures::only_static_remote_key();
10980                 channel_type_features.set_zero_conf_required();
10981
10982                 let mut open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
10983                 open_channel_msg.common_fields.channel_type = Some(channel_type_features);
10984                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
10985                 let res = InboundV1Channel::<&TestKeysInterface>::new(&feeest, &&keys_provider, &&keys_provider,
10986                         node_b_node_id, &channelmanager::provided_channel_type_features(&config),
10987                         &channelmanager::provided_init_features(&config), &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false);
10988                 assert!(res.is_ok());
10989         }
10990
10991         #[test]
10992         fn test_supports_anchors_zero_htlc_tx_fee() {
10993                 // Tests that if both sides support and negotiate `anchors_zero_fee_htlc_tx`, it is the
10994                 // resulting `channel_type`.
10995                 let secp_ctx = Secp256k1::new();
10996                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
10997                 let network = Network::Testnet;
10998                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
10999                 let logger = test_utils::TestLogger::new();
11000
11001                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
11002                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
11003
11004                 let mut config = UserConfig::default();
11005                 config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
11006
11007                 // It is not enough for just the initiator to signal `option_anchors_zero_fee_htlc_tx`, both
11008                 // need to signal it.
11009                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11010                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
11011                         &channelmanager::provided_init_features(&UserConfig::default()), 10000000, 100000, 42,
11012                         &config, 0, 42, None
11013                 ).unwrap();
11014                 assert!(!channel_a.context.channel_type.supports_anchors_zero_fee_htlc_tx());
11015
11016                 let mut expected_channel_type = ChannelTypeFeatures::empty();
11017                 expected_channel_type.set_static_remote_key_required();
11018                 expected_channel_type.set_anchors_zero_fee_htlc_tx_required();
11019
11020                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11021                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
11022                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
11023                         None
11024                 ).unwrap();
11025
11026                 let open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11027                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
11028                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11029                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
11030                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11031                 ).unwrap();
11032
11033                 assert_eq!(channel_a.context.channel_type, expected_channel_type);
11034                 assert_eq!(channel_b.context.channel_type, expected_channel_type);
11035         }
11036
11037         #[test]
11038         fn test_rejects_implicit_simple_anchors() {
11039                 // Tests that if `option_anchors` is being negotiated implicitly through the intersection of
11040                 // each side's `InitFeatures`, it is rejected.
11041                 let secp_ctx = Secp256k1::new();
11042                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
11043                 let network = Network::Testnet;
11044                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
11045                 let logger = test_utils::TestLogger::new();
11046
11047                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
11048                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
11049
11050                 let config = UserConfig::default();
11051
11052                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
11053                 let static_remote_key_required: u64 = 1 << 12;
11054                 let simple_anchors_required: u64 = 1 << 20;
11055                 let raw_init_features = static_remote_key_required | simple_anchors_required;
11056                 let init_features_with_simple_anchors = InitFeatures::from_le_bytes(raw_init_features.to_le_bytes().to_vec());
11057
11058                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11059                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
11060                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
11061                         None
11062                 ).unwrap();
11063
11064                 // Set `channel_type` to `None` to force the implicit feature negotiation.
11065                 let mut open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11066                 open_channel_msg.common_fields.channel_type = None;
11067
11068                 // Since A supports both `static_remote_key` and `option_anchors`, but B only accepts
11069                 // `static_remote_key`, it will fail the channel.
11070                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
11071                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11072                         &channelmanager::provided_channel_type_features(&config), &init_features_with_simple_anchors,
11073                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11074                 );
11075                 assert!(channel_b.is_err());
11076         }
11077
11078         #[test]
11079         fn test_rejects_simple_anchors_channel_type() {
11080                 // Tests that if `option_anchors` is being negotiated through the `channel_type` feature,
11081                 // it is rejected.
11082                 let secp_ctx = Secp256k1::new();
11083                 let fee_estimator = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
11084                 let network = Network::Testnet;
11085                 let keys_provider = test_utils::TestKeysInterface::new(&[42; 32], network);
11086                 let logger = test_utils::TestLogger::new();
11087
11088                 let node_id_a = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[1; 32]).unwrap());
11089                 let node_id_b = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[2; 32]).unwrap());
11090
11091                 let config = UserConfig::default();
11092
11093                 // See feature bit assignments: https://github.com/lightning/bolts/blob/master/09-features.md
11094                 let static_remote_key_required: u64 = 1 << 12;
11095                 let simple_anchors_required: u64 = 1 << 20;
11096                 let simple_anchors_raw_features = static_remote_key_required | simple_anchors_required;
11097                 let simple_anchors_init = InitFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
11098                 let simple_anchors_channel_type = ChannelTypeFeatures::from_le_bytes(simple_anchors_raw_features.to_le_bytes().to_vec());
11099                 assert!(!simple_anchors_init.requires_unknown_bits());
11100                 assert!(!simple_anchors_channel_type.requires_unknown_bits());
11101
11102                 // First, we'll try to open a channel between A and B where A requests a channel type for
11103                 // the original `option_anchors` feature (non zero fee htlc tx). This should be rejected by
11104                 // B as it's not supported by LDK.
11105                 let channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11106                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b,
11107                         &channelmanager::provided_init_features(&config), 10000000, 100000, 42, &config, 0, 42,
11108                         None
11109                 ).unwrap();
11110
11111                 let mut open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11112                 open_channel_msg.common_fields.channel_type = Some(simple_anchors_channel_type.clone());
11113
11114                 let res = InboundV1Channel::<&TestKeysInterface>::new(
11115                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11116                         &channelmanager::provided_channel_type_features(&config), &simple_anchors_init,
11117                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11118                 );
11119                 assert!(res.is_err());
11120
11121                 // Then, we'll try to open another channel where A requests a channel type for
11122                 // `anchors_zero_fee_htlc_tx`. B is malicious and tries to downgrade the channel type to the
11123                 // original `option_anchors` feature, which should be rejected by A as it's not supported by
11124                 // LDK.
11125                 let mut channel_a = OutboundV1Channel::<&TestKeysInterface>::new(
11126                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_b, &simple_anchors_init,
11127                         10000000, 100000, 42, &config, 0, 42, None
11128                 ).unwrap();
11129
11130                 let open_channel_msg = channel_a.get_open_channel(ChainHash::using_genesis_block(network));
11131
11132                 let channel_b = InboundV1Channel::<&TestKeysInterface>::new(
11133                         &fee_estimator, &&keys_provider, &&keys_provider, node_id_a,
11134                         &channelmanager::provided_channel_type_features(&config), &channelmanager::provided_init_features(&config),
11135                         &open_channel_msg, 7, &config, 0, &&logger, /*is_0conf=*/false
11136                 ).unwrap();
11137
11138                 let mut accept_channel_msg = channel_b.get_accept_channel_message();
11139                 accept_channel_msg.common_fields.channel_type = Some(simple_anchors_channel_type.clone());
11140
11141                 let res = channel_a.accept_channel(
11142                         &accept_channel_msg, &config.channel_handshake_limits, &simple_anchors_init
11143                 );
11144                 assert!(res.is_err());
11145         }
11146
11147         #[test]
11148         fn test_waiting_for_batch() {
11149                 let feeest = LowerBoundedFeeEstimator::new(&TestFeeEstimator{fee_est: 15000});
11150                 let logger = test_utils::TestLogger::new();
11151                 let secp_ctx = Secp256k1::new();
11152                 let seed = [42; 32];
11153                 let network = Network::Testnet;
11154                 let best_block = BestBlock::from_network(network);
11155                 let chain_hash = ChainHash::using_genesis_block(network);
11156                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
11157
11158                 let mut config = UserConfig::default();
11159                 // Set trust_own_funding_0conf while ensuring we don't send channel_ready for a
11160                 // channel in a batch before all channels are ready.
11161                 config.channel_handshake_limits.trust_own_funding_0conf = true;
11162
11163                 // Create a channel from node a to node b that will be part of batch funding.
11164                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
11165                 let mut node_a_chan = OutboundV1Channel::<&TestKeysInterface>::new(
11166                         &feeest,
11167                         &&keys_provider,
11168                         &&keys_provider,
11169                         node_b_node_id,
11170                         &channelmanager::provided_init_features(&config),
11171                         10000000,
11172                         100000,
11173                         42,
11174                         &config,
11175                         0,
11176                         42,
11177                         None
11178                 ).unwrap();
11179
11180                 let open_channel_msg = node_a_chan.get_open_channel(ChainHash::using_genesis_block(network));
11181                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
11182                 let mut node_b_chan = InboundV1Channel::<&TestKeysInterface>::new(
11183                         &feeest,
11184                         &&keys_provider,
11185                         &&keys_provider,
11186                         node_b_node_id,
11187                         &channelmanager::provided_channel_type_features(&config),
11188                         &channelmanager::provided_init_features(&config),
11189                         &open_channel_msg,
11190                         7,
11191                         &config,
11192                         0,
11193                         &&logger,
11194                         true,  // Allow node b to send a 0conf channel_ready.
11195                 ).unwrap();
11196
11197                 let accept_channel_msg = node_b_chan.accept_inbound_channel();
11198                 node_a_chan.accept_channel(
11199                         &accept_channel_msg,
11200                         &config.channel_handshake_limits,
11201                         &channelmanager::provided_init_features(&config),
11202                 ).unwrap();
11203
11204                 // Fund the channel with a batch funding transaction.
11205                 let output_script = node_a_chan.context.get_funding_redeemscript();
11206                 let tx = Transaction {
11207                         version: 1,
11208                         lock_time: LockTime::ZERO,
11209                         input: Vec::new(),
11210                         output: vec![
11211                                 TxOut {
11212                                         value: 10000000, script_pubkey: output_script.clone(),
11213                                 },
11214                                 TxOut {
11215                                         value: 10000000, script_pubkey: Builder::new().into_script(),
11216                                 },
11217                         ]};
11218                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
11219                 let funding_created_msg = node_a_chan.get_funding_created(
11220                         tx.clone(), funding_outpoint, true, &&logger,
11221                 ).map_err(|_| ()).unwrap();
11222                 let (mut node_b_chan, funding_signed_msg, _) = node_b_chan.funding_created(
11223                         &funding_created_msg.unwrap(),
11224                         best_block,
11225                         &&keys_provider,
11226                         &&logger,
11227                 ).map_err(|_| ()).unwrap();
11228                 let node_b_updates = node_b_chan.monitor_updating_restored(
11229                         &&logger,
11230                         &&keys_provider,
11231                         chain_hash,
11232                         &config,
11233                         0,
11234                 );
11235
11236                 // Receive funding_signed, but the channel will be configured to hold sending channel_ready and
11237                 // broadcasting the funding transaction until the batch is ready.
11238                 let res = node_a_chan.funding_signed(
11239                         &funding_signed_msg.unwrap(), best_block, &&keys_provider, &&logger,
11240                 );
11241                 let (mut node_a_chan, _) = if let Ok(res) = res { res } else { panic!(); };
11242                 let node_a_updates = node_a_chan.monitor_updating_restored(
11243                         &&logger,
11244                         &&keys_provider,
11245                         chain_hash,
11246                         &config,
11247                         0,
11248                 );
11249                 // Our channel_ready shouldn't be sent yet, even with trust_own_funding_0conf set,
11250                 // as the funding transaction depends on all channels in the batch becoming ready.
11251                 assert!(node_a_updates.channel_ready.is_none());
11252                 assert!(node_a_updates.funding_broadcastable.is_none());
11253                 assert_eq!(node_a_chan.context.channel_state, ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH));
11254
11255                 // It is possible to receive a 0conf channel_ready from the remote node.
11256                 node_a_chan.channel_ready(
11257                         &node_b_updates.channel_ready.unwrap(),
11258                         &&keys_provider,
11259                         chain_hash,
11260                         &config,
11261                         &best_block,
11262                         &&logger,
11263                 ).unwrap();
11264                 assert_eq!(
11265                         node_a_chan.context.channel_state,
11266                         ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::WAITING_FOR_BATCH | AwaitingChannelReadyFlags::THEIR_CHANNEL_READY)
11267                 );
11268
11269                 // Clear the ChannelState::WaitingForBatch only when called by ChannelManager.
11270                 node_a_chan.set_batch_ready();
11271                 assert_eq!(node_a_chan.context.channel_state, ChannelState::AwaitingChannelReady(AwaitingChannelReadyFlags::THEIR_CHANNEL_READY));
11272                 assert!(node_a_chan.check_get_channel_ready(0).is_some());
11273         }
11274 }