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