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