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