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