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