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