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