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