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