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