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