Track HTLCSource in ChannelMonitor
[rust-lightning] / src / ln / channel.rs
1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::{BitcoinHash, Sha256dHash, Hash160};
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
8
9 use secp256k1::key::{PublicKey,SecretKey};
10 use secp256k1::{Secp256k1,Message,Signature};
11 use secp256k1;
12
13 use crypto::digest::Digest;
14
15 use ln::msgs;
16 use ln::msgs::DecodeError;
17 use ln::channelmonitor::ChannelMonitor;
18 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder};
19 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
20 use ln::chan_utils;
21 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
22 use chain::transaction::OutPoint;
23 use chain::keysinterface::{ChannelKeys, KeysInterface};
24 use util::{transaction_utils,rng};
25 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
26 use util::sha2::Sha256;
27 use util::logger::Logger;
28 use util::errors::APIError;
29 use util::config::{UserConfig,ChannelConfig};
30
31 use std;
32 use std::default::Default;
33 use std::{cmp,mem};
34 use std::time::Instant;
35 use std::sync::{Arc};
36
37 #[cfg(test)]
38 pub struct ChannelValueStat {
39         pub value_to_self_msat: u64,
40         pub channel_value_msat: u64,
41         pub channel_reserve_msat: u64,
42         pub pending_outbound_htlcs_amount_msat: u64,
43         pub pending_inbound_htlcs_amount_msat: u64,
44         pub holding_cell_outbound_amount_msat: u64,
45         pub their_max_htlc_value_in_flight_msat: u64, // outgoing
46 }
47
48 enum InboundHTLCRemovalReason {
49         FailRelay(msgs::OnionErrorPacket),
50         FailMalformed(([u8; 32], u16)),
51         Fulfill([u8; 32]),
52 }
53
54 enum InboundHTLCState {
55         /// Added by remote, to be included in next local commitment tx.
56         RemoteAnnounced(PendingHTLCStatus),
57         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
58         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
59         /// accept this HTLC. Implies AwaitingRemoteRevoke.
60         /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
61         /// a remote revoke_and_ack on a previous state before we can do so.
62         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
63         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
64         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
65         /// accept this HTLC. Implies AwaitingRemoteRevoke.
66         /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
67         /// revoke_and_ack.
68         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
69         Committed,
70         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
71         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
72         /// we'll drop it.
73         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
74         /// commitment transaction without it as otherwise we'll have to force-close the channel to
75         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
76         /// anyway). That said, ChannelMonitor does this for us (see
77         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
78         /// local state before then, once we're sure that the next commitment_signed and
79         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
80         LocalRemoved(InboundHTLCRemovalReason),
81 }
82
83 struct InboundHTLCOutput {
84         htlc_id: u64,
85         amount_msat: u64,
86         cltv_expiry: u32,
87         payment_hash: [u8; 32],
88         state: InboundHTLCState,
89 }
90
91 enum OutboundHTLCState {
92         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
93         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
94         /// we will promote to Committed (note that they may not accept it until the next time we
95         /// revoke, but we dont really care about that:
96         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
97         ///    money back (though we wont), and,
98         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
99         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
100         ///    doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
101         ///    we'll never get out of sync).
102         /// Note that we Box the OnionPacket as its rather large and we don't want to blow up
103         /// OutboundHTLCOutput's size just for a temporary bit
104         LocalAnnounced(Box<msgs::OnionPacket>),
105         Committed,
106         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
107         /// the change (though they'll need to revoke before we fail the payment).
108         RemoteRemoved,
109         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
110         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
111         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
112         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
113         /// remote revoke_and_ack on a previous state before we can do so.
114         AwaitingRemoteRevokeToRemove,
115         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
116         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
117         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
118         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
119         /// revoke_and_ack to drop completely.
120         AwaitingRemovedRemoteRevoke,
121 }
122
123 struct OutboundHTLCOutput {
124         htlc_id: u64,
125         amount_msat: u64,
126         cltv_expiry: u32,
127         payment_hash: [u8; 32],
128         state: OutboundHTLCState,
129         source: HTLCSource,
130         /// If we're in a removed state, set if they failed, otherwise None
131         fail_reason: Option<HTLCFailReason>,
132 }
133
134 macro_rules! get_htlc_in_commitment {
135         ($htlc: expr, $offered: expr) => {
136                 HTLCOutputInCommitment {
137                         offered: $offered,
138                         amount_msat: $htlc.amount_msat,
139                         cltv_expiry: $htlc.cltv_expiry,
140                         payment_hash: $htlc.payment_hash,
141                         transaction_output_index: 0
142                 }
143         }
144 }
145
146 /// See AwaitingRemoteRevoke ChannelState for more info
147 enum HTLCUpdateAwaitingACK {
148         AddHTLC {
149                 // always outbound
150                 amount_msat: u64,
151                 cltv_expiry: u32,
152                 payment_hash: [u8; 32],
153                 source: HTLCSource,
154                 onion_routing_packet: msgs::OnionPacket,
155                 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
156         },
157         ClaimHTLC {
158                 payment_preimage: [u8; 32],
159                 htlc_id: u64,
160         },
161         FailHTLC {
162                 htlc_id: u64,
163                 err_packet: msgs::OnionErrorPacket,
164         },
165 }
166
167 /// There are a few "states" and then a number of flags which can be applied:
168 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
169 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
170 /// move on to ChannelFunded.
171 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
172 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
173 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
174 enum ChannelState {
175         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
176         OurInitSent = (1 << 0),
177         /// Implies we have received their open_channel/accept_channel message
178         TheirInitSent = (1 << 1),
179         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
180         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
181         /// upon receipt of funding_created, so simply skip this state.
182         FundingCreated = 4,
183         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
184         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
185         /// and our counterparty consider the funding transaction confirmed.
186         FundingSent = 8,
187         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
188         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
189         TheirFundingLocked = (1 << 4),
190         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
191         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
192         OurFundingLocked = (1 << 5),
193         ChannelFunded = 64,
194         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
195         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
196         /// dance.
197         PeerDisconnected = (1 << 7),
198         /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
199         /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
200         /// messages until they've managed to do so.
201         MonitorUpdateFailed = (1 << 8),
202         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
203         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
204         /// messages as then we will be unable to determine which HTLCs they included in their
205         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
206         /// later.
207         /// Flag is set on ChannelFunded.
208         AwaitingRemoteRevoke = (1 << 9),
209         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
210         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
211         /// to respond with our own shutdown message when possible.
212         RemoteShutdownSent = (1 << 10),
213         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
214         /// point, we may not add any new HTLCs to the channel.
215         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
216         /// us their shutdown.
217         LocalShutdownSent = (1 << 11),
218         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
219         /// to drop us, but we store this anyway.
220         ShutdownComplete = 4096,
221 }
222 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
223 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
224
225 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
226
227 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
228 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
229 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
230 // inbound channel.
231 pub(super) struct Channel {
232         config: ChannelConfig,
233
234         user_id: u64,
235
236         channel_id: [u8; 32],
237         channel_state: u32,
238         channel_outbound: bool,
239         secp_ctx: Secp256k1<secp256k1::All>,
240         channel_value_satoshis: u64,
241
242         local_keys: ChannelKeys,
243         shutdown_pubkey: PublicKey,
244
245         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
246         // generation start at 0 and count up...this simplifies some parts of implementation at the
247         // cost of others, but should really just be changed.
248
249         cur_local_commitment_transaction_number: u64,
250         cur_remote_commitment_transaction_number: u64,
251         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
252         /// Upon receipt of a channel_reestablish we have to figure out whether to send a
253         /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
254         /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
255         /// remote revoke when we received the latest commitment update from the remote we have to make
256         /// sure that commitment update gets resent first.
257         received_commitment_while_awaiting_raa: bool,
258         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
259         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
260         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
261
262         monitor_pending_revoke_and_ack: bool,
263         monitor_pending_commitment_signed: bool,
264         monitor_pending_order: Option<RAACommitmentOrder>,
265         monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
266         monitor_pending_failures: Vec<(HTLCSource, [u8; 32], HTLCFailReason)>,
267
268         // pending_update_fee is filled when sending and receiving update_fee
269         // For outbound channel, feerate_per_kw is updated with the value from
270         // pending_update_fee when revoke_and_ack is received
271         //
272         // For inbound channel, feerate_per_kw is updated when it receives
273         // commitment_signed and revoke_and_ack is generated
274         // The pending value is kept when another pair of update_fee and commitment_signed
275         // is received during AwaitingRemoteRevoke and relieved when the expected
276         // revoke_and_ack is received and new commitment_signed is generated to be
277         // sent to the funder. Otherwise, the pending value is removed when receiving
278         // commitment_signed.
279         pending_update_fee: Option<u64>,
280         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
281         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
282         // is received. holding_cell_update_fee is updated when there are additional
283         // update_fee() during ChannelState::AwaitingRemoteRevoke.
284         holding_cell_update_fee: Option<u64>,
285         next_local_htlc_id: u64,
286         next_remote_htlc_id: u64,
287         channel_update_count: u32,
288         feerate_per_kw: u64,
289
290         #[cfg(debug_assertions)]
291         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
292         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
293         #[cfg(debug_assertions)]
294         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
295         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
296
297         #[cfg(test)]
298         // Used in ChannelManager's tests to send a revoked transaction
299         pub last_local_commitment_txn: Vec<Transaction>,
300         #[cfg(not(test))]
301         last_local_commitment_txn: Vec<Transaction>,
302
303         last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
304
305         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
306         /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
307         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
308         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
309         funding_tx_confirmed_in: Option<Sha256dHash>,
310         short_channel_id: Option<u64>,
311         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
312         /// ChannelManager deserialization (hence pub(super))
313         pub(super) last_block_connected: Sha256dHash,
314         funding_tx_confirmations: u64,
315
316         their_dust_limit_satoshis: u64,
317         our_dust_limit_satoshis: u64,
318         their_max_htlc_value_in_flight_msat: u64,
319         //get_our_max_htlc_value_in_flight_msat(): u64,
320         /// minimum channel reserve for **self** to maintain - set by them.
321         their_channel_reserve_satoshis: u64,
322         //get_our_channel_reserve_satoshis(): u64,
323         their_htlc_minimum_msat: u64,
324         our_htlc_minimum_msat: u64,
325         their_to_self_delay: u16,
326         //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
327         their_max_accepted_htlcs: u16,
328         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
329         minimum_depth: u32,
330
331         their_funding_pubkey: Option<PublicKey>,
332         their_revocation_basepoint: Option<PublicKey>,
333         their_payment_basepoint: Option<PublicKey>,
334         their_delayed_payment_basepoint: Option<PublicKey>,
335         their_htlc_basepoint: Option<PublicKey>,
336         their_cur_commitment_point: Option<PublicKey>,
337
338         their_prev_commitment_point: Option<PublicKey>,
339         their_node_id: PublicKey,
340
341         their_shutdown_scriptpubkey: Option<Script>,
342
343         channel_monitor: ChannelMonitor,
344
345         logger: Arc<Logger>,
346 }
347
348 const OUR_MAX_HTLCS: u16 = 5; //TODO
349 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
350 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
351 /// really allow for this, so instead we're stuck closing it out at that point.
352 const UNCONF_THRESHOLD: u32 = 6;
353 /// The amount of time we require our counterparty wait to claim their money (ie time between when
354 /// we, or our watchtower, must check for them having broadcast a theft transaction).
355 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
356 /// The amount of time we're willing to wait to claim money back to us
357 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
358 /// Exposing these two constants for use in test in ChannelMonitor
359 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
360 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
361 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
362 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?)
363 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
364 /// it's 2^24.
365 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
366
367 /// Used to return a simple Error back to ChannelManager. Will get converted to a
368 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
369 /// channel_id in ChannelManager.
370 #[derive(Debug)]
371 pub(super) enum ChannelError {
372         Ignore(&'static str),
373         Close(&'static str),
374 }
375
376 macro_rules! secp_check {
377         ($res: expr, $err: expr) => {
378                 match $res {
379                         Ok(thing) => thing,
380                         Err(_) => return Err(ChannelError::Close($err)),
381                 }
382         };
383 }
384
385 impl Channel {
386         // Convert constants + channel value to limits:
387         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
388                 channel_value_satoshis * 1000 / 10 //TODO
389         }
390
391         /// Returns a minimum channel reserve value **they** need to maintain
392         ///
393         /// Guaranteed to return a value no larger than channel_value_satoshis
394         fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
395                 let (q, _) = channel_value_satoshis.overflowing_div(100);
396                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
397         }
398
399         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
400                 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
401         }
402
403         fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
404                 1000 // TODO
405         }
406
407         fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
408                 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
409                 // be at least 6.
410                 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
411                 CONF_TARGET
412         }
413
414         // Constructors:
415         pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
416                 let chan_keys = keys_provider.get_channel_keys(false);
417
418                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
419                         return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
420                 }
421
422                 if push_msat > channel_value_satoshis * 1000 {
423                         return Err(APIError::APIMisuseError{err: "push value > channel value"});
424                 }
425
426
427                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
428                 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
429                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
430                 }
431
432                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
433
434                 let secp_ctx = Secp256k1::new();
435                 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
436                                                           &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
437                                                           keys_provider.get_destination_script(), logger.clone());
438
439                 Ok(Channel {
440                         user_id: user_id,
441                         config: config.channel_options.clone(),
442
443                         channel_id: rng::rand_u832(),
444                         channel_state: ChannelState::OurInitSent as u32,
445                         channel_outbound: true,
446                         secp_ctx: secp_ctx,
447                         channel_value_satoshis: channel_value_satoshis,
448
449                         local_keys: chan_keys,
450                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
451                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
452                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
453                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
454                         received_commitment_while_awaiting_raa: false,
455
456                         pending_inbound_htlcs: Vec::new(),
457                         pending_outbound_htlcs: Vec::new(),
458                         holding_cell_htlc_updates: Vec::new(),
459                         pending_update_fee: None,
460                         holding_cell_update_fee: None,
461                         next_local_htlc_id: 0,
462                         next_remote_htlc_id: 0,
463                         channel_update_count: 1,
464
465                         monitor_pending_revoke_and_ack: false,
466                         monitor_pending_commitment_signed: false,
467                         monitor_pending_order: None,
468                         monitor_pending_forwards: Vec::new(),
469                         monitor_pending_failures: Vec::new(),
470
471                         #[cfg(debug_assertions)]
472                         max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
473                         #[cfg(debug_assertions)]
474                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
475
476                         last_local_commitment_txn: Vec::new(),
477
478                         last_sent_closing_fee: None,
479
480                         funding_tx_confirmed_in: None,
481                         short_channel_id: None,
482                         last_block_connected: Default::default(),
483                         funding_tx_confirmations: 0,
484
485                         feerate_per_kw: feerate,
486                         their_dust_limit_satoshis: 0,
487                         our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
488                         their_max_htlc_value_in_flight_msat: 0,
489                         their_channel_reserve_satoshis: 0,
490                         their_htlc_minimum_msat: 0,
491                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
492                         their_to_self_delay: 0,
493                         their_max_accepted_htlcs: 0,
494                         minimum_depth: 0, // Filled in in accept_channel
495
496                         their_funding_pubkey: None,
497                         their_revocation_basepoint: None,
498                         their_payment_basepoint: None,
499                         their_delayed_payment_basepoint: None,
500                         their_htlc_basepoint: None,
501                         their_cur_commitment_point: None,
502
503                         their_prev_commitment_point: None,
504                         their_node_id: their_node_id,
505
506                         their_shutdown_scriptpubkey: None,
507
508                         channel_monitor: channel_monitor,
509
510                         logger,
511                 })
512         }
513
514         fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
515                 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
516                         return Err(ChannelError::Close("Peer's feerate much too low"));
517                 }
518                 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
519                         return Err(ChannelError::Close("Peer's feerate much too high"));
520                 }
521                 Ok(())
522         }
523
524         /// Creates a new channel from a remote sides' request for one.
525         /// Assumes chain_hash has already been checked and corresponds with what we expect!
526         pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
527                 let chan_keys = keys_provider.get_channel_keys(true);
528                 let mut local_config = (*config).channel_options.clone();
529
530                 // Check sanity of message fields:
531                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
532                         return Err(ChannelError::Close("funding value > 2^24"));
533                 }
534                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
535                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
536                 }
537                 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
538                         return Err(ChannelError::Close("push_msat larger than funding value"));
539                 }
540                 if msg.dust_limit_satoshis > msg.funding_satoshis {
541                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
542                 }
543                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
544                         return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
545                 }
546                 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
547                         return Err(ChannelError::Close("Miminum htlc value is full channel value"));
548                 }
549                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
550
551                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
552                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
553                 }
554                 if msg.max_accepted_htlcs < 1 {
555                         return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
556                 }
557                 if msg.max_accepted_htlcs > 483 {
558                         return Err(ChannelError::Close("max_accpted_htlcs > 483"));
559                 }
560
561                 // Now check against optional parameters as set by config...
562                 if msg.funding_satoshis < config.channel_limits.min_funding_satoshis {
563                         return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
564                 }
565                 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
566                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
567                 }
568                 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
569                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
570                 }
571                 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
572                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
573                 }
574                 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
575                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
576                 }
577                 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
578                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
579                 }
580                 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
581                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
582                 }
583
584                 // Convert things into internal flags and prep our state:
585
586                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
587                 if config.channel_limits.force_announced_channel_preference {
588                         if local_config.announced_channel != their_announce {
589                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
590                         }
591                 }
592                 // we either accept their preference or the preferences match
593                 local_config.announced_channel = their_announce;
594
595                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
596
597                 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
598                 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
599                 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
600                         return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
601                 }
602                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
603                         return Err(ChannelError::Close("channel_reserve_satoshis too small"));
604                 }
605                 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
606                         return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
607                 }
608
609                 // check if the funder's amount for the initial commitment tx is sufficient
610                 // for full fee payment
611                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
612                 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
613                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
614                 }
615
616                 let to_local_msat = msg.push_msat;
617                 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
618                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
619                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
620                 }
621
622                 let secp_ctx = Secp256k1::new();
623                 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
624                                                               &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
625                                                               keys_provider.get_destination_script(), logger.clone());
626                 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
627                 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
628
629                 let mut chan = Channel {
630                         user_id: user_id,
631                         config: local_config,
632
633                         channel_id: msg.temporary_channel_id,
634                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
635                         channel_outbound: false,
636                         secp_ctx: secp_ctx,
637
638                         local_keys: chan_keys,
639                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
640                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
641                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
642                         value_to_self_msat: msg.push_msat,
643                         received_commitment_while_awaiting_raa: false,
644
645                         pending_inbound_htlcs: Vec::new(),
646                         pending_outbound_htlcs: Vec::new(),
647                         holding_cell_htlc_updates: Vec::new(),
648                         pending_update_fee: None,
649                         holding_cell_update_fee: None,
650                         next_local_htlc_id: 0,
651                         next_remote_htlc_id: 0,
652                         channel_update_count: 1,
653
654                         monitor_pending_revoke_and_ack: false,
655                         monitor_pending_commitment_signed: false,
656                         monitor_pending_order: None,
657                         monitor_pending_forwards: Vec::new(),
658                         monitor_pending_failures: Vec::new(),
659
660                         #[cfg(debug_assertions)]
661                         max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
662                         #[cfg(debug_assertions)]
663                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
664
665                         last_local_commitment_txn: Vec::new(),
666
667                         last_sent_closing_fee: None,
668
669                         funding_tx_confirmed_in: None,
670                         short_channel_id: None,
671                         last_block_connected: Default::default(),
672                         funding_tx_confirmations: 0,
673
674                         feerate_per_kw: msg.feerate_per_kw as u64,
675                         channel_value_satoshis: msg.funding_satoshis,
676                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
677                         our_dust_limit_satoshis: our_dust_limit_satoshis,
678                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
679                         their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
680                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
681                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
682                         their_to_self_delay: msg.to_self_delay,
683                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
684                         minimum_depth: Channel::derive_minimum_depth(msg.funding_satoshis*1000, msg.push_msat),
685
686                         their_funding_pubkey: Some(msg.funding_pubkey),
687                         their_revocation_basepoint: Some(msg.revocation_basepoint),
688                         their_payment_basepoint: Some(msg.payment_basepoint),
689                         their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
690                         their_htlc_basepoint: Some(msg.htlc_basepoint),
691                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
692
693                         their_prev_commitment_point: None,
694                         their_node_id: their_node_id,
695
696                         their_shutdown_scriptpubkey: None,
697
698                         channel_monitor: channel_monitor,
699
700                         logger,
701                 };
702
703                 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
704                 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
705
706                 Ok(chan)
707         }
708
709         // Utilities to derive keys:
710
711         fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
712                 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
713                 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
714         }
715
716         // Utilities to build transactions:
717
718         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
719                 let mut sha = Sha256::new();
720                 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
721
722                 if self.channel_outbound {
723                         sha.input(&our_payment_basepoint.serialize());
724                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
725                 } else {
726                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
727                         sha.input(&our_payment_basepoint.serialize());
728                 }
729                 let mut res = [0; 32];
730                 sha.result(&mut res);
731
732                 ((res[26] as u64) << 5*8) |
733                 ((res[27] as u64) << 4*8) |
734                 ((res[28] as u64) << 3*8) |
735                 ((res[29] as u64) << 2*8) |
736                 ((res[30] as u64) << 1*8) |
737                 ((res[31] as u64) << 0*8)
738         }
739
740         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
741         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
742         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
743         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
744         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
745         /// an HTLC to a).
746         /// @local is used only to convert relevant internal structures which refer to remote vs local
747         /// to decide value of outputs and direction of HTLCs.
748         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
749         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
750         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
751         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
752         /// which peer generated this transaction and "to whom" this transaction flows.
753         #[inline]
754         fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>, Vec<([u8; 32], HTLCSource, Option<u32>)>) {
755                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
756
757                 let txins = {
758                         let mut ins: Vec<TxIn> = Vec::new();
759                         ins.push(TxIn {
760                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
761                                 script_sig: Script::new(),
762                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
763                                 witness: Vec::new(),
764                         });
765                         ins
766                 };
767
768                 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
769                 let mut unincluded_htlc_sources: Vec<([u8; 32], HTLCSource, Option<u32>)> = Vec::new();
770
771                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
772                 let mut remote_htlc_total_msat = 0;
773                 let mut local_htlc_total_msat = 0;
774                 let mut value_to_self_msat_offset = 0;
775
776                 macro_rules! add_htlc_output {
777                         ($htlc: expr, $outbound: expr, $source: expr) => {
778                                 if $outbound == local { // "offered HTLC output"
779                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
780                                                 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
781                                                 txouts.push((TxOut {
782                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
783                                                         value: $htlc.amount_msat / 1000
784                                                 }, Some((htlc_in_tx, $source))));
785                                         } else {
786                                                 if let Some(source) = $source {
787                                                         unincluded_htlc_sources.push(($htlc.payment_hash, source, None));
788                                                 }
789                                         }
790                                 } else {
791                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
792                                                 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
793                                                 txouts.push((TxOut { // "received HTLC output"
794                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
795                                                         value: $htlc.amount_msat / 1000
796                                                 }, Some((htlc_in_tx, $source))));
797                                         } else {
798                                                 if let Some(source) = $source {
799                                                         unincluded_htlc_sources.push(($htlc.payment_hash, source, None));
800                                                 }
801                                         }
802                                 }
803                         }
804                 }
805
806                 for ref htlc in self.pending_inbound_htlcs.iter() {
807                         let include = match htlc.state {
808                                 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
809                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
810                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
811                                 InboundHTLCState::Committed => true,
812                                 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
813                         };
814
815                         if include {
816                                 add_htlc_output!(htlc, false, None);
817                                 remote_htlc_total_msat += htlc.amount_msat;
818                         } else {
819                                 match &htlc.state {
820                                         &InboundHTLCState::LocalRemoved(ref reason) => {
821                                                 if generated_by_local {
822                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
823                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
824                                                         }
825                                                 }
826                                         },
827                                         _ => {},
828                                 }
829                         }
830                 }
831
832                 for ref htlc in self.pending_outbound_htlcs.iter() {
833                         let include = match htlc.state {
834                                 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
835                                 OutboundHTLCState::Committed => true,
836                                 OutboundHTLCState::RemoteRemoved => generated_by_local,
837                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
838                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
839                         };
840
841                         if include {
842                                 add_htlc_output!(htlc, true, Some(htlc.source.clone()));
843                                 local_htlc_total_msat += htlc.amount_msat;
844                         } else {
845                                 match htlc.state {
846                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
847                                                 if htlc.fail_reason.is_none() {
848                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
849                                                 }
850                                         },
851                                         OutboundHTLCState::RemoteRemoved => {
852                                                 if !generated_by_local && htlc.fail_reason.is_none() {
853                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
854                                                 }
855                                         },
856                                         _ => {},
857                                 }
858                         }
859                 }
860
861
862                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
863                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset;
864
865                 #[cfg(debug_assertions)]
866                 {
867                         // Make sure that the to_self/to_remote is always either past the appropriate
868                         // channel_reserve *or* it is making progress towards it.
869                         // TODO: This should happen after fee calculation, but we don't handle that correctly
870                         // yet!
871                         let mut max_commitment_tx_output = if generated_by_local {
872                                 self.max_commitment_tx_output_local.lock().unwrap()
873                         } else {
874                                 self.max_commitment_tx_output_remote.lock().unwrap()
875                         };
876                         debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
877                         max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
878                         debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
879                         max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
880                 }
881
882                 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
883                 let (value_to_self, value_to_remote) = if self.channel_outbound {
884                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
885                 } else {
886                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
887                 };
888
889                 let value_to_a = if local { value_to_self } else { value_to_remote };
890                 let value_to_b = if local { value_to_remote } else { value_to_self };
891
892                 if value_to_a >= (dust_limit_satoshis as i64) {
893                         txouts.push((TxOut {
894                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
895                                                                                        if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
896                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
897                                 value: value_to_a as u64
898                         }, None));
899                 }
900
901                 if value_to_b >= (dust_limit_satoshis as i64) {
902                         txouts.push((TxOut {
903                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
904                                                              .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
905                                                              .into_script(),
906                                 value: value_to_b as u64
907                         }, None));
908                 }
909
910                 transaction_utils::sort_outputs(&mut txouts);
911
912                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
913                 let mut htlcs_included: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
914                 let mut htlc_sources: Vec<([u8; 32], HTLCSource, Option<u32>)> = Vec::with_capacity(txouts.len() + unincluded_htlc_sources.len());
915                 for (idx, out) in txouts.drain(..).enumerate() {
916                         outputs.push(out.0);
917                         if let Some((mut htlc, source_option)) = out.1 {
918                                 htlc.transaction_output_index = idx as u32;
919                                 if let Some(source) = source_option {
920                                         htlc_sources.push((htlc.payment_hash, source, Some(idx as u32)));
921                                 }
922                                 htlcs_included.push(htlc);
923                         }
924                 }
925                 htlc_sources.append(&mut unincluded_htlc_sources);
926
927                 (Transaction {
928                         version: 2,
929                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
930                         input: txins,
931                         output: outputs,
932                 }, htlcs_included, htlc_sources)
933         }
934
935         #[inline]
936         fn get_closing_scriptpubkey(&self) -> Script {
937                 let our_channel_close_key_hash = Hash160::from_data(&self.shutdown_pubkey.serialize());
938                 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
939         }
940
941         #[inline]
942         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
943                 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
944         }
945
946         #[inline]
947         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
948                 let txins = {
949                         let mut ins: Vec<TxIn> = Vec::new();
950                         ins.push(TxIn {
951                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
952                                 script_sig: Script::new(),
953                                 sequence: 0xffffffff,
954                                 witness: Vec::new(),
955                         });
956                         ins
957                 };
958
959                 assert!(self.pending_inbound_htlcs.is_empty());
960                 assert!(self.pending_outbound_htlcs.is_empty());
961                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
962
963                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
964                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
965                 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
966
967                 if value_to_self < 0 {
968                         assert!(self.channel_outbound);
969                         total_fee_satoshis += (-value_to_self) as u64;
970                 } else if value_to_remote < 0 {
971                         assert!(!self.channel_outbound);
972                         total_fee_satoshis += (-value_to_remote) as u64;
973                 }
974
975                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
976                         txouts.push((TxOut {
977                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
978                                 value: value_to_remote as u64
979                         }, ()));
980                 }
981
982                 if value_to_self as u64 > self.our_dust_limit_satoshis {
983                         txouts.push((TxOut {
984                                 script_pubkey: self.get_closing_scriptpubkey(),
985                                 value: value_to_self as u64
986                         }, ()));
987                 }
988
989                 transaction_utils::sort_outputs(&mut txouts);
990
991                 let mut outputs: Vec<TxOut> = Vec::new();
992                 for out in txouts.drain(..) {
993                         outputs.push(out.0);
994                 }
995
996                 (Transaction {
997                         version: 2,
998                         lock_time: 0,
999                         input: txins,
1000                         output: outputs,
1001                 }, total_fee_satoshis)
1002         }
1003
1004         #[inline]
1005         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1006         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1007         /// our counterparty!)
1008         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1009         /// TODO Some magic rust shit to compile-time check this?
1010         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1011                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1012                 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1013                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1014
1015                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), "Local tx keys generation got bogus keys"))
1016         }
1017
1018         #[inline]
1019         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1020         /// will sign and send to our counterparty.
1021         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1022         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1023                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1024                 //may see payments to it!
1025                 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1026                 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1027                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1028
1029                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1030         }
1031
1032         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1033         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1034         /// Panics if called before accept_channel/new_from_req
1035         pub fn get_funding_redeemscript(&self) -> Script {
1036                 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1037                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1038                 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1039                 if our_funding_key[..] < their_funding_key[..] {
1040                         builder.push_slice(&our_funding_key)
1041                                 .push_slice(&their_funding_key)
1042                 } else {
1043                         builder.push_slice(&their_funding_key)
1044                                 .push_slice(&our_funding_key)
1045                 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1046         }
1047
1048         fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1049                 if tx.input.len() != 1 {
1050                         panic!("Tried to sign commitment transaction that had input count != 1!");
1051                 }
1052                 if tx.input[0].witness.len() != 0 {
1053                         panic!("Tried to re-sign commitment transaction");
1054                 }
1055
1056                 let funding_redeemscript = self.get_funding_redeemscript();
1057
1058                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1059                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1060
1061                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1062
1063                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1064                 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1065                 if our_funding_key[..] < their_funding_key[..] {
1066                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1067                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1068                 } else {
1069                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1070                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1071                 }
1072                 tx.input[0].witness[1].push(SigHashType::All as u8);
1073                 tx.input[0].witness[2].push(SigHashType::All as u8);
1074
1075                 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1076
1077                 our_sig
1078         }
1079
1080         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1081         /// @local is used only to convert relevant internal structures which refer to remote vs local
1082         /// to decide value of outputs and direction of HTLCs.
1083         fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1084                 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1085         }
1086
1087         fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), ChannelError> {
1088                 if tx.input.len() != 1 {
1089                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1090                 }
1091
1092                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1093
1094                 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
1095                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1096                 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1097                 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1098         }
1099
1100         /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1101         /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1102         fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, ChannelError> {
1103                 if tx.input.len() != 1 {
1104                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1105                 }
1106                 if tx.input[0].witness.len() != 0 {
1107                         panic!("Tried to re-sign HTLC transaction");
1108                 }
1109
1110                 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1111
1112                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1113
1114                 if local_tx { // b, then a
1115                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1116                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1117                 } else {
1118                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1119                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1120                 }
1121                 tx.input[0].witness[1].push(SigHashType::All as u8);
1122                 tx.input[0].witness[2].push(SigHashType::All as u8);
1123
1124                 if htlc.offered {
1125                         tx.input[0].witness.push(Vec::new());
1126                 } else {
1127                         tx.input[0].witness.push(preimage.unwrap().to_vec());
1128                 }
1129
1130                 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1131
1132                 Ok(our_sig)
1133         }
1134
1135         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1136         /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1137         /// Ok(_) if debug assertions are turned on and preconditions are met.
1138         fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), ChannelError> {
1139                 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1140                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1141                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1142                 // either.
1143                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1144                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1145                 }
1146                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1147
1148                 let mut sha = Sha256::new();
1149                 sha.input(&payment_preimage_arg);
1150                 let mut payment_hash_calc = [0; 32];
1151                 sha.result(&mut payment_hash_calc);
1152
1153                 let mut pending_idx = std::usize::MAX;
1154                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1155                         if htlc.htlc_id == htlc_id_arg {
1156                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1157                                 if let InboundHTLCState::Committed = htlc.state {
1158                                 } else {
1159                                         debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1160                                         // Don't return in release mode here so that we can update channel_monitor
1161                                 }
1162                                 pending_idx = idx;
1163                                 break;
1164                         }
1165                 }
1166                 if pending_idx == std::usize::MAX {
1167                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1168                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1169                 }
1170
1171                 // Now update local state:
1172                 //
1173                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1174                 // can claim it even if the channel hits the chain before we see their next commitment.
1175                 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1176
1177                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1178                         for pending_update in self.holding_cell_htlc_updates.iter() {
1179                                 match pending_update {
1180                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1181                                                 if htlc_id_arg == htlc_id {
1182                                                         debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1183                                                         return Ok((None, None));
1184                                                 }
1185                                         },
1186                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1187                                                 if htlc_id_arg == htlc_id {
1188                                                         debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1189                                                         // Return the new channel monitor in a last-ditch effort to hit the
1190                                                         // chain and claim the funds
1191                                                         return Ok((None, Some(self.channel_monitor.clone())));
1192                                                 }
1193                                         },
1194                                         _ => {}
1195                                 }
1196                         }
1197                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1198                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1199                         });
1200                         return Ok((None, Some(self.channel_monitor.clone())));
1201                 }
1202
1203                 {
1204                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1205                         if let InboundHTLCState::Committed = htlc.state {
1206                         } else {
1207                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1208                                 return Ok((None, Some(self.channel_monitor.clone())));
1209                         }
1210                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1211                 }
1212
1213                 Ok((Some(msgs::UpdateFulfillHTLC {
1214                         channel_id: self.channel_id(),
1215                         htlc_id: htlc_id_arg,
1216                         payment_preimage: payment_preimage_arg,
1217                 }), Some(self.channel_monitor.clone())))
1218         }
1219
1220         pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: [u8; 32]) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), ChannelError> {
1221                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1222                         (Some(update_fulfill_htlc), _) => {
1223                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1224                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1225                         },
1226                         (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1227                         (None, None) => Ok((None, None))
1228                 }
1229         }
1230
1231         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1232         /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1233         /// Ok(_) if debug assertions are turned on and preconditions are met.
1234         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1235                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1236                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1237                 }
1238                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1239
1240                 let mut pending_idx = std::usize::MAX;
1241                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1242                         if htlc.htlc_id == htlc_id_arg {
1243                                 if let InboundHTLCState::Committed = htlc.state {
1244                                 } else {
1245                                         debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1246                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1247                                 }
1248                                 pending_idx = idx;
1249                         }
1250                 }
1251                 if pending_idx == std::usize::MAX {
1252                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1253                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1254                 }
1255
1256                 // Now update local state:
1257                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1258                         for pending_update in self.holding_cell_htlc_updates.iter() {
1259                                 match pending_update {
1260                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1261                                                 if htlc_id_arg == htlc_id {
1262                                                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1263                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1264                                                 }
1265                                         },
1266                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1267                                                 if htlc_id_arg == htlc_id {
1268                                                         debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1269                                                         return Ok(None);
1270                                                 }
1271                                         },
1272                                         _ => {}
1273                                 }
1274                         }
1275                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1276                                 htlc_id: htlc_id_arg,
1277                                 err_packet,
1278                         });
1279                         return Ok(None);
1280                 }
1281
1282                 {
1283                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1284                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1285                 }
1286
1287                 Ok(Some(msgs::UpdateFailHTLC {
1288                         channel_id: self.channel_id(),
1289                         htlc_id: htlc_id_arg,
1290                         reason: err_packet
1291                 }))
1292         }
1293
1294         pub fn get_update_fail_htlc_and_commit(&mut self, htlc_id: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
1295                 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1296                         Some(update_fail_htlc) => {
1297                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1298                                 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1299                         },
1300                         None => Ok(None)
1301                 }
1302         }
1303
1304         // Message handlers:
1305
1306         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig) -> Result<(), ChannelError> {
1307                 // Check sanity of message fields:
1308                 if !self.channel_outbound {
1309                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1310                 }
1311                 if self.channel_state != ChannelState::OurInitSent as u32 {
1312                         return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1313                 }
1314                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1315                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1316                 }
1317                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1318                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1319                 }
1320                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1321                         return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1322                 }
1323                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1324                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1325                 }
1326                 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1327                         return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1328                 }
1329                 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1330                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1331                 }
1332                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1333                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1334                 }
1335                 if msg.max_accepted_htlcs < 1 {
1336                         return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1337                 }
1338                 if msg.max_accepted_htlcs > 483 {
1339                         return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1340                 }
1341
1342                 // Now check against optional parameters as set by config...
1343                 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
1344                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1345                 }
1346                 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
1347                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1348                 }
1349                 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
1350                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1351                 }
1352                 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
1353                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1354                 }
1355                 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
1356                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1357                 }
1358                 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
1359                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1360                 }
1361                 if msg.minimum_depth > config.channel_limits.max_minimum_depth {
1362                         return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1363                 }
1364
1365                 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1366
1367                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1368                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1369                 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1370                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1371                 self.their_to_self_delay = msg.to_self_delay;
1372                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1373                 self.minimum_depth = msg.minimum_depth;
1374                 self.their_funding_pubkey = Some(msg.funding_pubkey);
1375                 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1376                 self.their_payment_basepoint = Some(msg.payment_basepoint);
1377                 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1378                 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1379                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1380
1381                 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1382                 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1383                 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1384
1385                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1386
1387                 Ok(())
1388         }
1389
1390         fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), ChannelError> {
1391                 let funding_script = self.get_funding_redeemscript();
1392
1393                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1394                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1395                 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1396
1397                 // They sign the "local" commitment transaction...
1398                 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer");
1399
1400                 // ...and we sign it, allowing us to broadcast the tx if we wish
1401                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1402
1403                 let remote_keys = self.build_remote_transaction_keys()?;
1404                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1405                 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1406
1407                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1408                 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1409         }
1410
1411         pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), ChannelError> {
1412                 if self.channel_outbound {
1413                         return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1414                 }
1415                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1416                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1417                         // remember the channel, so its safe to just send an error_message here and drop the
1418                         // channel.
1419                         return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1420                 }
1421                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1422                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1423                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1424                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1425                 }
1426
1427                 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1428                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1429                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1430
1431                 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1432                         Ok(res) => res,
1433                         Err(e) => {
1434                                 self.channel_monitor.unset_funding_info();
1435                                 return Err(e);
1436                         }
1437                 };
1438
1439                 // Now that we're past error-generating stuff, update our local state:
1440
1441                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1442                 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1443                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new(), Vec::new());
1444                 self.channel_state = ChannelState::FundingSent as u32;
1445                 self.channel_id = funding_txo.to_channel_id();
1446                 self.cur_remote_commitment_transaction_number -= 1;
1447                 self.cur_local_commitment_transaction_number -= 1;
1448
1449                 Ok((msgs::FundingSigned {
1450                         channel_id: self.channel_id,
1451                         signature: our_signature
1452                 }, self.channel_monitor.clone()))
1453         }
1454
1455         /// Handles a funding_signed message from the remote end.
1456         /// If this call is successful, broadcast the funding transaction (and not before!)
1457         pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, ChannelError> {
1458                 if !self.channel_outbound {
1459                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1460                 }
1461                 if self.channel_state != ChannelState::FundingCreated as u32 {
1462                         return Err(ChannelError::Close("Received funding_signed in strange state!"));
1463                 }
1464                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1465                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1466                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1467                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1468                 }
1469
1470                 let funding_script = self.get_funding_redeemscript();
1471
1472                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1473                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1474                 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1475
1476                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1477                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer");
1478
1479                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1480                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new(), Vec::new());
1481                 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1482                 self.channel_state = ChannelState::FundingSent as u32;
1483                 self.cur_local_commitment_transaction_number -= 1;
1484
1485                 Ok(self.channel_monitor.clone())
1486         }
1487
1488         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1489                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1490                         return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1491                 }
1492
1493                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1494
1495                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1496                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1497                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1498                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1499                         self.channel_update_count += 1;
1500                 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1501                                 // Note that funding_signed/funding_created will have decremented both by 1!
1502                                 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1503                                 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1504                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1505                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1506                         }
1507                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1508                         return Ok(());
1509                 } else {
1510                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1511                 }
1512
1513                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1514                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1515                 Ok(())
1516         }
1517
1518         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1519         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1520                 let mut htlc_inbound_value_msat = 0;
1521                 for ref htlc in self.pending_inbound_htlcs.iter() {
1522                         htlc_inbound_value_msat += htlc.amount_msat;
1523                 }
1524                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1525         }
1526
1527         /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1528         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1529                 let mut htlc_outbound_value_msat = 0;
1530                 for ref htlc in self.pending_outbound_htlcs.iter() {
1531                         htlc_outbound_value_msat += htlc.amount_msat;
1532                 }
1533
1534                 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1535         }
1536
1537         pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1538                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1539                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1540                 }
1541                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1542                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1543                 }
1544                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1545                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1546                 }
1547                 if msg.amount_msat < self.our_htlc_minimum_msat {
1548                         return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1549                 }
1550
1551                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1552                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1553                         return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1554                 }
1555                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1556                 // Check our_max_htlc_value_in_flight_msat
1557                 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1558                         return Err(ChannelError::Close("Remote HTLC add would put them over their max HTLC value in flight"));
1559                 }
1560                 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1561                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1562                 // something if we punish them for broadcasting an old state).
1563                 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 {
1564                         return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1565                 }
1566                 if self.next_remote_htlc_id != msg.htlc_id {
1567                         return Err(ChannelError::Close("Remote skipped HTLC ID"));
1568                 }
1569                 if msg.cltv_expiry >= 500000000 {
1570                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1571                 }
1572
1573                 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1574
1575                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1576                         if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1577                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1578                         }
1579                 }
1580
1581                 // Now update local state:
1582                 self.next_remote_htlc_id += 1;
1583                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1584                         htlc_id: msg.htlc_id,
1585                         amount_msat: msg.amount_msat,
1586                         payment_hash: msg.payment_hash,
1587                         cltv_expiry: msg.cltv_expiry,
1588                         state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1589                 });
1590
1591                 Ok(())
1592         }
1593
1594         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1595         #[inline]
1596         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1597                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1598                         if htlc.htlc_id == htlc_id {
1599                                 match check_preimage {
1600                                         None => {},
1601                                         Some(payment_hash) =>
1602                                                 if payment_hash != htlc.payment_hash {
1603                                                         return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1604                                                 }
1605                                 };
1606                                 match htlc.state {
1607                                         OutboundHTLCState::LocalAnnounced(_) =>
1608                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1609                                         OutboundHTLCState::Committed => {
1610                                                 htlc.state = OutboundHTLCState::RemoteRemoved;
1611                                                 htlc.fail_reason = fail_reason;
1612                                         },
1613                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1614                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1615                                 }
1616                                 return Ok(&htlc.source);
1617                         }
1618                 }
1619                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1620         }
1621
1622         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1623                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1624                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1625                 }
1626                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1627                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1628                 }
1629
1630                 let mut sha = Sha256::new();
1631                 sha.input(&msg.payment_preimage);
1632                 let mut payment_hash = [0; 32];
1633                 sha.result(&mut payment_hash);
1634
1635                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1636         }
1637
1638         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1639                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1640                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1641                 }
1642                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1643                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1644                 }
1645
1646                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1647                 Ok(())
1648         }
1649
1650         pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1651                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1652                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1653                 }
1654                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1655                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1656                 }
1657
1658                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1659                 Ok(())
1660         }
1661
1662         pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1663                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1664                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state"));
1665                 }
1666                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1667                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish"));
1668                 }
1669                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1670                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds"));
1671                 }
1672
1673                 let funding_script = self.get_funding_redeemscript();
1674
1675                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1676
1677                 let mut update_fee = false;
1678                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1679                         update_fee = true;
1680                         self.pending_update_fee.unwrap()
1681                 } else {
1682                         self.feerate_per_kw
1683                 };
1684
1685                 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1686                 let local_commitment_txid = local_commitment_tx.0.txid();
1687                 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1688                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
1689
1690                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1691                 if update_fee {
1692                         let num_htlcs = local_commitment_tx.1.len();
1693                         let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1694
1695                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1696                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee"));
1697                         }
1698                 }
1699
1700                 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1701                         return Err(ChannelError::Close("Got wrong number of HTLC signatures from remote"));
1702                 }
1703
1704                 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1705                 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1706                 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1707
1708                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1709                 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1710                         let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
1711                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1712                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1713                         secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
1714                         let htlc_sig = if htlc.offered {
1715                                 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1716                                 new_local_commitment_txn.push(htlc_tx);
1717                                 htlc_sig
1718                         } else {
1719                                 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1720                         };
1721                         htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1722                 }
1723
1724                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1725                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1726
1727                 // Update state now that we've passed all the can-fail calls...
1728                 let mut need_our_commitment = false;
1729                 if !self.channel_outbound {
1730                         if let Some(fee_update) = self.pending_update_fee {
1731                                 self.feerate_per_kw = fee_update;
1732                                 // We later use the presence of pending_update_fee to indicate we should generate a
1733                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1734                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1735                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1736                                         need_our_commitment = true;
1737                                         self.pending_update_fee = None;
1738                                 }
1739                         }
1740                 }
1741
1742                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1743                         // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1744                         // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1745                         self.monitor_pending_order = None;
1746                 }
1747
1748                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs, local_commitment_tx.2);
1749
1750                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1751                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1752                                 Some(forward_info.clone())
1753                         } else { None };
1754                         if let Some(forward_info) = new_forward {
1755                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1756                                 need_our_commitment = true;
1757                         }
1758                 }
1759                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1760                         if let OutboundHTLCState::RemoteRemoved = htlc.state {
1761                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1762                                 need_our_commitment = true;
1763                         }
1764                 }
1765
1766                 self.cur_local_commitment_transaction_number -= 1;
1767                 self.last_local_commitment_txn = new_local_commitment_txn;
1768                 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1769
1770                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1771                         self.monitor_pending_revoke_and_ack = true;
1772                         self.monitor_pending_commitment_signed |= need_our_commitment;
1773                         return Err(ChannelError::Ignore("Previous monitor update failure prevented generation of RAA"));
1774                 }
1775
1776                 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1777                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1778                         // we'll send one right away when we get the revoke_and_ack when we
1779                         // free_holding_cell_htlcs().
1780                         let (msg, monitor) = self.send_commitment_no_status_check()?;
1781                         (Some(msg), monitor, None)
1782                 } else if !need_our_commitment {
1783                         (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1784                 } else { (None, self.channel_monitor.clone(), None) };
1785
1786                 Ok((msgs::RevokeAndACK {
1787                         channel_id: self.channel_id,
1788                         per_commitment_secret: per_commitment_secret,
1789                         next_per_commitment_point: next_per_commitment_point,
1790                 }, our_commitment_signed, closing_signed, monitor_update))
1791         }
1792
1793         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1794         /// fulfilling or failing the last pending HTLC)
1795         fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, ChannelError> {
1796                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1797                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1798                         let mut htlc_updates = Vec::new();
1799                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1800                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1801                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1802                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1803                         let mut err = None;
1804                         for htlc_update in htlc_updates.drain(..) {
1805                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
1806                                 // fee races with adding too many outputs which push our total payments just over
1807                                 // the limit. In case its less rare than I anticipate, we may want to revisit
1808                                 // handling this case better and maybe fufilling some of the HTLCs while attempting
1809                                 // to rebalance channels.
1810                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1811                                         self.holding_cell_htlc_updates.push(htlc_update);
1812                                 } else {
1813                                         match &htlc_update {
1814                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1815                                                         match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1816                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1817                                                                 Err(e) => {
1818                                                                         err = Some(e);
1819                                                                 }
1820                                                         }
1821                                                 },
1822                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1823                                                         match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1824                                                                 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1825                                                                 Err(e) => {
1826                                                                         if let ChannelError::Ignore(_) = e {}
1827                                                                         else {
1828                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1829                                                                         }
1830                                                                 }
1831                                                         }
1832                                                 },
1833                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1834                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1835                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1836                                                                 Err(e) => {
1837                                                                         if let ChannelError::Ignore(_) = e {}
1838                                                                         else {
1839                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1840                                                                         }
1841                                                                 }
1842                                                         }
1843                                                 },
1844                                         }
1845                                         if err.is_some() {
1846                                                 self.holding_cell_htlc_updates.push(htlc_update);
1847                                         }
1848                                 }
1849                         }
1850                         //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1851                         //fail it back the route, if its a temporary issue we can ignore it...
1852                         match err {
1853                                 None => {
1854                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1855                                                 // This should never actually happen and indicates we got some Errs back
1856                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1857                                                 // case there is some strange way to hit duplicate HTLC removes.
1858                                                 return Ok(None);
1859                                         }
1860                                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1861                                                         self.pending_update_fee = self.holding_cell_update_fee.take();
1862                                                         Some(msgs::UpdateFee {
1863                                                                 channel_id: self.channel_id,
1864                                                                 feerate_per_kw: feerate as u32,
1865                                                         })
1866                                                 } else {
1867                                                         None
1868                                                 };
1869                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1870                                         Ok(Some((msgs::CommitmentUpdate {
1871                                                 update_add_htlcs,
1872                                                 update_fulfill_htlcs,
1873                                                 update_fail_htlcs,
1874                                                 update_fail_malformed_htlcs: Vec::new(),
1875                                                 update_fee: update_fee,
1876                                                 commitment_signed,
1877                                         }, monitor_update)))
1878                                 },
1879                                 Some(e) => Err(e)
1880                         }
1881                 } else {
1882                         Ok(None)
1883                 }
1884         }
1885
1886         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1887         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1888         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1889         /// generating an appropriate error *after* the channel state has been updated based on the
1890         /// revoke_and_ack message.
1891         pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1892                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1893                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
1894                 }
1895                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1896                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
1897                 }
1898                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1899                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
1900                 }
1901
1902                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1903                         if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&self.secp_ctx, &msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
1904                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
1905                         }
1906                 }
1907                 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
1908                         .map_err(|e| ChannelError::Close(e.0))?;
1909
1910                 // Update state now that we've passed all the can-fail calls...
1911                 // (note that we may still fail to generate the new commitment_signed message, but that's
1912                 // OK, we step the channel here and *then* if the new generation fails we can fail the
1913                 // channel based on that, but stepping stuff here should be safe either way.
1914                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1915                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1916                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1917                 self.cur_remote_commitment_transaction_number -= 1;
1918                 self.received_commitment_while_awaiting_raa = false;
1919                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1920                         // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1921                         // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1922                         self.monitor_pending_order = None;
1923                 }
1924
1925                 let mut to_forward_infos = Vec::new();
1926                 let mut revoked_htlcs = Vec::new();
1927                 let mut update_fail_htlcs = Vec::new();
1928                 let mut update_fail_malformed_htlcs = Vec::new();
1929                 let mut require_commitment = false;
1930                 let mut value_to_self_msat_diff: i64 = 0;
1931                 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1932                 self.pending_inbound_htlcs.retain(|htlc| {
1933                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1934                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1935                                         value_to_self_msat_diff += htlc.amount_msat as i64;
1936                                 }
1937                                 false
1938                         } else { true }
1939                 });
1940                 self.pending_outbound_htlcs.retain(|htlc| {
1941                         if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1942                                 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1943                                         revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1944                                 } else {
1945                                         // They fulfilled, so we sent them money
1946                                         value_to_self_msat_diff -= htlc.amount_msat as i64;
1947                                 }
1948                                 false
1949                         } else { true }
1950                 });
1951                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1952                         let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1953                                 true
1954                         } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1955                                 true
1956                         } else { false };
1957                         if swap {
1958                                 let mut state = InboundHTLCState::Committed;
1959                                 mem::swap(&mut state, &mut htlc.state);
1960
1961                                 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1962                                         htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1963                                         require_commitment = true;
1964                                 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1965                                         match forward_info {
1966                                                 PendingHTLCStatus::Fail(fail_msg) => {
1967                                                         require_commitment = true;
1968                                                         match fail_msg {
1969                                                                 HTLCFailureMsg::Relay(msg) => {
1970                                                                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1971                                                                         update_fail_htlcs.push(msg)
1972                                                                 },
1973                                                                 HTLCFailureMsg::Malformed(msg) => {
1974                                                                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
1975                                                                         update_fail_malformed_htlcs.push(msg)
1976                                                                 },
1977                                                         }
1978                                                 },
1979                                                 PendingHTLCStatus::Forward(forward_info) => {
1980                                                         to_forward_infos.push((forward_info, htlc.htlc_id));
1981                                                         htlc.state = InboundHTLCState::Committed;
1982                                                 }
1983                                         }
1984                                 }
1985                         }
1986                 }
1987                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1988                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
1989                                 htlc.state = OutboundHTLCState::Committed;
1990                         } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
1991                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1992                                 require_commitment = true;
1993                         }
1994                 }
1995                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1996
1997                 if self.channel_outbound {
1998                         if let Some(feerate) = self.pending_update_fee.take() {
1999                                 self.feerate_per_kw = feerate;
2000                         }
2001                 } else {
2002                         if let Some(feerate) = self.pending_update_fee {
2003                                 // Because a node cannot send two commitment_signed's in a row without getting a
2004                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2005                                 // it should use to create keys with) and because a node can't send a
2006                                 // commitment_signed without changes, checking if the feerate is equal to the
2007                                 // pending feerate update is sufficient to detect require_commitment.
2008                                 if feerate == self.feerate_per_kw {
2009                                         require_commitment = true;
2010                                         self.pending_update_fee = None;
2011                                 }
2012                         }
2013                 }
2014
2015                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2016                         // We can't actually generate a new commitment transaction (incl by freeing holding
2017                         // cells) while we can't update the monitor, so we just return what we have.
2018                         if require_commitment {
2019                                 self.monitor_pending_commitment_signed = true;
2020                         }
2021                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2022                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2023                         return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2024                 }
2025
2026                 match self.free_holding_cell_htlcs()? {
2027                         Some(mut commitment_update) => {
2028                                 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2029                                 for fail_msg in update_fail_htlcs.drain(..) {
2030                                         commitment_update.0.update_fail_htlcs.push(fail_msg);
2031                                 }
2032                                 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2033                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2034                                         commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2035                                 }
2036                                 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2037                         },
2038                         None => {
2039                                 if require_commitment {
2040                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2041                                         Ok((Some(msgs::CommitmentUpdate {
2042                                                 update_add_htlcs: Vec::new(),
2043                                                 update_fulfill_htlcs: Vec::new(),
2044                                                 update_fail_htlcs,
2045                                                 update_fail_malformed_htlcs,
2046                                                 update_fee: None,
2047                                                 commitment_signed
2048                                         }), to_forward_infos, revoked_htlcs, None, monitor_update))
2049                                 } else {
2050                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2051                                 }
2052                         }
2053                 }
2054
2055         }
2056
2057         /// Adds a pending update to this channel. See the doc for send_htlc for
2058         /// further details on the optionness of the return value.
2059         /// You MUST call send_commitment prior to any other calls on this Channel
2060         fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2061                 if !self.channel_outbound {
2062                         panic!("Cannot send fee from inbound channel");
2063                 }
2064                 if !self.is_usable() {
2065                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2066                 }
2067                 if !self.is_live() {
2068                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2069                 }
2070
2071                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2072                         self.holding_cell_update_fee = Some(feerate_per_kw);
2073                         return None;
2074                 }
2075
2076                 debug_assert!(self.pending_update_fee.is_none());
2077                 self.pending_update_fee = Some(feerate_per_kw);
2078
2079                 Some(msgs::UpdateFee {
2080                         channel_id: self.channel_id,
2081                         feerate_per_kw: feerate_per_kw as u32,
2082                 })
2083         }
2084
2085         pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
2086                 match self.send_update_fee(feerate_per_kw) {
2087                         Some(update_fee) => {
2088                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2089                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2090                         },
2091                         None => Ok(None)
2092                 }
2093         }
2094
2095         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2096         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2097         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2098         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2099         /// No further message handling calls may be made until a channel_reestablish dance has
2100         /// completed.
2101         pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
2102                 let mut outbound_drops = Vec::new();
2103
2104                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2105                 if self.channel_state < ChannelState::FundingSent as u32 {
2106                         self.channel_state = ChannelState::ShutdownComplete as u32;
2107                         return outbound_drops;
2108                 }
2109                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2110                 // will be retransmitted.
2111                 self.last_sent_closing_fee = None;
2112
2113                 let mut inbound_drop_count = 0;
2114                 self.pending_inbound_htlcs.retain(|htlc| {
2115                         match htlc.state {
2116                                 InboundHTLCState::RemoteAnnounced(_) => {
2117                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2118                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2119                                         // this HTLC accordingly
2120                                         inbound_drop_count += 1;
2121                                         false
2122                                 },
2123                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2124                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2125                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2126                                         // in response to it yet, so don't touch it.
2127                                         true
2128                                 },
2129                                 InboundHTLCState::Committed => true,
2130                                 InboundHTLCState::LocalRemoved(_) => {
2131                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2132                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2133                                         // (that we missed). Keep this around for now and if they tell us they missed
2134                                         // the commitment_signed we can re-transmit the update then.
2135                                         true
2136                                 },
2137                         }
2138                 });
2139                 self.next_remote_htlc_id -= inbound_drop_count;
2140
2141                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2142                         if let OutboundHTLCState::RemoteRemoved = htlc.state {
2143                                 // They sent us an update to remove this but haven't yet sent the corresponding
2144                                 // commitment_signed, we need to move it back to Committed and they can re-send
2145                                 // the update upon reconnection.
2146                                 htlc.state = OutboundHTLCState::Committed;
2147                         }
2148                 }
2149
2150                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2151                         match htlc_update {
2152                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2153                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2154                                         false
2155                                 },
2156                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2157                         }
2158                 });
2159                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2160                 log_debug!(self, "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()));
2161                 outbound_drops
2162         }
2163
2164         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2165         /// updates are partially paused.
2166         /// This must be called immediately after the call which generated the ChannelMonitor update
2167         /// which failed, with the order argument set to the type of call it represented (ie a
2168         /// commitment update or a revoke_and_ack generation). The messages which were generated from
2169         /// that original call must *not* have been sent to the remote end, and must instead have been
2170         /// dropped. They will be regenerated when monitor_updating_restored is called.
2171         pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, raa_first_dropped_cs: bool) {
2172                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2173                 match order {
2174                         RAACommitmentOrder::CommitmentFirst => {
2175                                 self.monitor_pending_revoke_and_ack = false;
2176                                 self.monitor_pending_commitment_signed = true;
2177                         },
2178                         RAACommitmentOrder::RevokeAndACKFirst => {
2179                                 self.monitor_pending_revoke_and_ack = true;
2180                                 self.monitor_pending_commitment_signed = raa_first_dropped_cs;
2181                         },
2182                 }
2183                 assert!(self.monitor_pending_forwards.is_empty());
2184                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2185                 assert!(self.monitor_pending_failures.is_empty());
2186                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2187                 self.monitor_pending_order = Some(order);
2188                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2189         }
2190
2191         /// Indicates that the latest ChannelMonitor update has been committed by the client
2192         /// successfully and we should restore normal operation. Returns messages which should be sent
2193         /// to the remote side.
2194         pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>) {
2195                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2196                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2197
2198                 let mut forwards = Vec::new();
2199                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2200                 let mut failures = Vec::new();
2201                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2202
2203                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2204                         // Leave monitor_pending_order so we can order our channel_reestablish responses
2205                         self.monitor_pending_revoke_and_ack = false;
2206                         self.monitor_pending_commitment_signed = false;
2207                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2208                 }
2209
2210                 let raa = if self.monitor_pending_revoke_and_ack {
2211                         Some(self.get_last_revoke_and_ack())
2212                 } else { None };
2213                 let commitment_update = if self.monitor_pending_commitment_signed {
2214                         Some(self.get_last_commitment_update())
2215                 } else { None };
2216
2217                 self.monitor_pending_revoke_and_ack = false;
2218                 self.monitor_pending_commitment_signed = false;
2219                 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2220         }
2221
2222         pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2223                 if self.channel_outbound {
2224                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2225                 }
2226                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2227                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2228                 }
2229                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2230                 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2231                 self.channel_update_count += 1;
2232                 Ok(())
2233         }
2234
2235         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2236                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2237                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2238                 msgs::RevokeAndACK {
2239                         channel_id: self.channel_id,
2240                         per_commitment_secret,
2241                         next_per_commitment_point,
2242                 }
2243         }
2244
2245         fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2246                 let mut update_add_htlcs = Vec::new();
2247                 let mut update_fulfill_htlcs = Vec::new();
2248                 let mut update_fail_htlcs = Vec::new();
2249                 let mut update_fail_malformed_htlcs = Vec::new();
2250
2251                 for htlc in self.pending_outbound_htlcs.iter() {
2252                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2253                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2254                                         channel_id: self.channel_id(),
2255                                         htlc_id: htlc.htlc_id,
2256                                         amount_msat: htlc.amount_msat,
2257                                         payment_hash: htlc.payment_hash,
2258                                         cltv_expiry: htlc.cltv_expiry,
2259                                         onion_routing_packet: (**onion_packet).clone(),
2260                                 });
2261                         }
2262                 }
2263
2264                 for htlc in self.pending_inbound_htlcs.iter() {
2265                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2266                                 match reason {
2267                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2268                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2269                                                         channel_id: self.channel_id(),
2270                                                         htlc_id: htlc.htlc_id,
2271                                                         reason: err_packet.clone()
2272                                                 });
2273                                         },
2274                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2275                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2276                                                         channel_id: self.channel_id(),
2277                                                         htlc_id: htlc.htlc_id,
2278                                                         sha256_of_onion: sha256_of_onion.clone(),
2279                                                         failure_code: failure_code.clone(),
2280                                                 });
2281                                         },
2282                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2283                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2284                                                         channel_id: self.channel_id(),
2285                                                         htlc_id: htlc.htlc_id,
2286                                                         payment_preimage: payment_preimage.clone(),
2287                                                 });
2288                                         },
2289                                 }
2290                         }
2291                 }
2292
2293                 msgs::CommitmentUpdate {
2294                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2295                         update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2296                         commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2297                 }
2298         }
2299
2300         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2301         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2302         pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2303                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2304                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2305                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2306                         // just close here instead of trying to recover.
2307                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2308                 }
2309
2310                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2311                         msg.next_local_commitment_number == 0 {
2312                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2313                 }
2314
2315                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2316                 // remaining cases either succeed or ErrorMessage-fail).
2317                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2318
2319                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2320                         Some(msgs::Shutdown {
2321                                 channel_id: self.channel_id,
2322                                 scriptpubkey: self.get_closing_scriptpubkey(),
2323                         })
2324                 } else { None };
2325
2326                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2327                         if self.channel_state & ChannelState::OurFundingLocked as u32 == 0 {
2328                                 if msg.next_remote_commitment_number != 0 {
2329                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2330                                 }
2331                                 // Short circuit the whole handler as there is nothing we can resend them
2332                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2333                         }
2334
2335                         // We have OurFundingLocked set!
2336                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2337                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2338                         return Ok((Some(msgs::FundingLocked {
2339                                 channel_id: self.channel_id(),
2340                                 next_per_commitment_point: next_per_commitment_point,
2341                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2342                 }
2343
2344                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2345                         // Remote isn't waiting on any RevokeAndACK from us!
2346                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2347                         None
2348                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2349                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2350                                 self.monitor_pending_revoke_and_ack = true;
2351                                 None
2352                         } else {
2353                                 Some(self.get_last_revoke_and_ack())
2354                         }
2355                 } else {
2356                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2357                 };
2358
2359                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2360                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2361                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2362                 // the corresponding revoke_and_ack back yet.
2363                 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2364
2365                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2366                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2367                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2368                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2369                         Some(msgs::FundingLocked {
2370                                 channel_id: self.channel_id(),
2371                                 next_per_commitment_point: next_per_commitment_point,
2372                         })
2373                 } else { None };
2374
2375                 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2376                                 RAACommitmentOrder::CommitmentFirst
2377                         } else {
2378                                 RAACommitmentOrder::RevokeAndACKFirst
2379                         });
2380
2381                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2382                         if required_revoke.is_some() {
2383                                 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2384                         } else {
2385                                 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2386                         }
2387
2388                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2389                                         self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2390                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2391                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2392                                 // have received some updates while we were disconnected. Free the holding cell
2393                                 // now!
2394                                 match self.free_holding_cell_htlcs() {
2395                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2396                                         Err(ChannelError::Ignore(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2397                                         Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order, shutdown_msg)),
2398                                         Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg)),
2399                                 }
2400                         } else {
2401                                 return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg));
2402                         }
2403                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2404                         if required_revoke.is_some() {
2405                                 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2406                         } else {
2407                                 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2408                         }
2409
2410                         // If monitor_pending_order is set, it must be CommitmentSigned if we have no RAA
2411                         debug_assert!(self.monitor_pending_order != Some(RAACommitmentOrder::RevokeAndACKFirst) || required_revoke.is_some());
2412
2413                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2414                                 self.monitor_pending_commitment_signed = true;
2415                                 return Ok((resend_funding_locked, None, None, None, order, shutdown_msg));
2416                         }
2417
2418                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order, shutdown_msg));
2419                 } else {
2420                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2421                 }
2422         }
2423
2424         fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2425                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2426                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2427                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2428                         return None;
2429                 }
2430
2431                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2432                 if self.feerate_per_kw > proposed_feerate {
2433                         proposed_feerate = self.feerate_per_kw;
2434                 }
2435                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2436                 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2437
2438                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2439                 let funding_redeemscript = self.get_funding_redeemscript();
2440                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2441
2442                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2443                 Some(msgs::ClosingSigned {
2444                         channel_id: self.channel_id,
2445                         fee_satoshis: total_fee_satoshis,
2446                         signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2447                 })
2448         }
2449
2450         pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), ChannelError> {
2451                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2452                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2453                 }
2454                 if self.channel_state < ChannelState::FundingSent as u32 {
2455                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2456                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2457                         // can do that via error message without getting a connection fail anyway...
2458                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2459                 }
2460                 for htlc in self.pending_inbound_htlcs.iter() {
2461                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2462                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2463                         }
2464                 }
2465                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2466
2467                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2468                 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2469                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2470                         return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2471                 }
2472
2473                 //Check shutdown_scriptpubkey form as BOLT says we must
2474                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2475                         return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2476                 }
2477
2478                 if self.their_shutdown_scriptpubkey.is_some() {
2479                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2480                                 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2481                         }
2482                 } else {
2483                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2484                 }
2485
2486                 // From here on out, we may not fail!
2487
2488                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2489                 self.channel_update_count += 1;
2490
2491                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2492                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2493                 // cell HTLCs and return them to fail the payment.
2494                 self.holding_cell_update_fee = None;
2495                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2496                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2497                         match htlc_update {
2498                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2499                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2500                                         false
2501                                 },
2502                                 _ => true
2503                         }
2504                 });
2505                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2506                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2507                 // any further commitment updates after we set LocalShutdownSent.
2508
2509                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2510                         None
2511                 } else {
2512                         Some(msgs::Shutdown {
2513                                 channel_id: self.channel_id,
2514                                 scriptpubkey: self.get_closing_scriptpubkey(),
2515                         })
2516                 };
2517
2518                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2519                 self.channel_update_count += 1;
2520                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2521         }
2522
2523         pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError> {
2524                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2525                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2526                 }
2527                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2528                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2529                 }
2530                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2531                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2532                 }
2533                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2534                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2535                 }
2536
2537                 let funding_redeemscript = self.get_funding_redeemscript();
2538                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2539                 if used_total_fee != msg.fee_satoshis {
2540                         return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2541                 }
2542                 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2543
2544                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2545                         Ok(_) => {},
2546                         Err(_e) => {
2547                                 // The remote end may have decided to revoke their output due to inconsistent dust
2548                                 // limits, so check for that case by re-checking the signature here.
2549                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2550                                 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2551                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer");
2552                         },
2553                 };
2554
2555                 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2556                         if last_fee == msg.fee_satoshis {
2557                                 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2558                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2559                                 self.channel_update_count += 1;
2560                                 return Ok((None, Some(closing_tx)));
2561                         }
2562                 }
2563
2564                 macro_rules! propose_new_feerate {
2565                         ($new_feerate: expr) => {
2566                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2567                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2568                                 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2569                                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2570                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2571                                 return Ok((Some(msgs::ClosingSigned {
2572                                         channel_id: self.channel_id,
2573                                         fee_satoshis: used_total_fee,
2574                                         signature: our_sig,
2575                                 }), None))
2576                         }
2577                 }
2578
2579                 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2580                 if self.channel_outbound {
2581                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2582                         if proposed_sat_per_kw > our_max_feerate {
2583                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2584                                         if our_max_feerate <= last_feerate {
2585                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2586                                         }
2587                                 }
2588                                 propose_new_feerate!(our_max_feerate);
2589                         }
2590                 } else {
2591                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2592                         if proposed_sat_per_kw < our_min_feerate {
2593                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2594                                         if our_min_feerate >= last_feerate {
2595                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2596                                         }
2597                                 }
2598                                 propose_new_feerate!(our_min_feerate);
2599                         }
2600                 }
2601
2602                 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2603                 self.channel_state = ChannelState::ShutdownComplete as u32;
2604                 self.channel_update_count += 1;
2605
2606                 Ok((Some(msgs::ClosingSigned {
2607                         channel_id: self.channel_id,
2608                         fee_satoshis: msg.fee_satoshis,
2609                         signature: our_sig,
2610                 }), Some(closing_tx)))
2611         }
2612
2613         // Public utilities:
2614
2615         pub fn channel_id(&self) -> [u8; 32] {
2616                 self.channel_id
2617         }
2618
2619         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2620         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2621         pub fn get_user_id(&self) -> u64 {
2622                 self.user_id
2623         }
2624
2625         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2626         pub fn channel_monitor(&self) -> ChannelMonitor {
2627                 if self.channel_state < ChannelState::FundingCreated as u32 {
2628                         panic!("Can't get a channel monitor until funding has been created");
2629                 }
2630                 self.channel_monitor.clone()
2631         }
2632
2633         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2634         /// is_usable() returns true).
2635         /// Allowed in any state (including after shutdown)
2636         pub fn get_short_channel_id(&self) -> Option<u64> {
2637                 self.short_channel_id
2638         }
2639
2640         /// Returns the funding_txo we either got from our peer, or were given by
2641         /// get_outbound_funding_created.
2642         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2643                 self.channel_monitor.get_funding_txo()
2644         }
2645
2646         /// Allowed in any state (including after shutdown)
2647         pub fn get_their_node_id(&self) -> PublicKey {
2648                 self.their_node_id
2649         }
2650
2651         /// Allowed in any state (including after shutdown)
2652         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2653                 self.our_htlc_minimum_msat
2654         }
2655
2656         /// Allowed in any state (including after shutdown)
2657         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2658                 self.our_htlc_minimum_msat
2659         }
2660
2661         pub fn get_value_satoshis(&self) -> u64 {
2662                 self.channel_value_satoshis
2663         }
2664
2665         pub fn get_fee_proportional_millionths(&self) -> u32 {
2666                 self.config.fee_proportional_millionths
2667         }
2668
2669         #[cfg(test)]
2670         pub fn get_feerate(&self) -> u64 {
2671                 self.feerate_per_kw
2672         }
2673
2674         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2675                 self.cur_local_commitment_transaction_number + 1
2676         }
2677
2678         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2679                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2680         }
2681
2682         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2683                 self.cur_remote_commitment_transaction_number + 2
2684         }
2685
2686         //TODO: Testing purpose only, should be changed in another way after #81
2687         #[cfg(test)]
2688         pub fn get_local_keys(&self) -> &ChannelKeys {
2689                 &self.local_keys
2690         }
2691
2692         #[cfg(test)]
2693         pub fn get_value_stat(&self) -> ChannelValueStat {
2694                 ChannelValueStat {
2695                         value_to_self_msat: self.value_to_self_msat,
2696                         channel_value_msat: self.channel_value_satoshis * 1000,
2697                         channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2698                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2699                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2700                         holding_cell_outbound_amount_msat: {
2701                                 let mut res = 0;
2702                                 for h in self.holding_cell_htlc_updates.iter() {
2703                                         match h {
2704                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2705                                                         res += amount_msat;
2706                                                 }
2707                                                 _ => {}
2708                                         }
2709                                 }
2710                                 res
2711                         },
2712                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2713                 }
2714         }
2715
2716         /// Allowed in any state (including after shutdown)
2717         pub fn get_channel_update_count(&self) -> u32 {
2718                 self.channel_update_count
2719         }
2720
2721         pub fn should_announce(&self) -> bool {
2722                 self.config.announced_channel
2723         }
2724
2725         pub fn is_outbound(&self) -> bool {
2726                 self.channel_outbound
2727         }
2728
2729         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2730         /// Allowed in any state (including after shutdown)
2731         pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2732                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2733                 // output value back into a transaction with the regular channel output:
2734
2735                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2736                 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2737
2738                 if self.channel_outbound {
2739                         // + the marginal fee increase cost to us in the commitment transaction:
2740                         res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2741                 }
2742
2743                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2744                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2745
2746                 res as u32
2747         }
2748
2749         /// Returns true if we've ever received a message from the remote end for this Channel
2750         pub fn have_received_message(&self) -> bool {
2751                 self.channel_state > (ChannelState::OurInitSent as u32)
2752         }
2753
2754         /// Returns true if this channel is fully established and not known to be closing.
2755         /// Allowed in any state (including after shutdown)
2756         pub fn is_usable(&self) -> bool {
2757                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2758                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2759         }
2760
2761         /// Returns true if this channel is currently available for use. This is a superset of
2762         /// is_usable() and considers things like the channel being temporarily disabled.
2763         /// Allowed in any state (including after shutdown)
2764         pub fn is_live(&self) -> bool {
2765                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2766         }
2767
2768         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2769         /// Allowed in any state (including after shutdown)
2770         pub fn is_awaiting_monitor_update(&self) -> bool {
2771                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2772         }
2773
2774         /// Returns true if funding_created was sent/received.
2775         pub fn is_funding_initiated(&self) -> bool {
2776                 self.channel_state >= ChannelState::FundingCreated as u32
2777         }
2778
2779         /// Returns true if this channel is fully shut down. True here implies that no further actions
2780         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2781         /// will be handled appropriately by the chain monitor.
2782         pub fn is_shutdown(&self) -> bool {
2783                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
2784                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2785                         true
2786                 } else { false }
2787         }
2788
2789         /// Called by channelmanager based on chain blocks being connected.
2790         /// Note that we only need to use this to detect funding_signed, anything else is handled by
2791         /// the channel_monitor.
2792         /// In case of Err, the channel may have been closed, at which point the standard requirements
2793         /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2794         /// Only returns an ErrorAction of DisconnectPeer, if Err.
2795         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
2796                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2797                 if header.bitcoin_hash() != self.last_block_connected {
2798                         self.last_block_connected = header.bitcoin_hash();
2799                         self.channel_monitor.last_block_hash = self.last_block_connected;
2800                         if self.funding_tx_confirmations > 0 {
2801                                 self.funding_tx_confirmations += 1;
2802                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2803                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2804                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
2805                                                 true
2806                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2807                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2808                                                 self.channel_update_count += 1;
2809                                                 true
2810                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2811                                                 // We got a reorg but not enough to trigger a force close, just update
2812                                                 // funding_tx_confirmed_in and return.
2813                                                 false
2814                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2815                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2816                                         } else {
2817                                                 // We got a reorg but not enough to trigger a force close, just update
2818                                                 // funding_tx_confirmed_in and return.
2819                                                 false
2820                                         };
2821                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2822
2823                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2824                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2825                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2826                                         //a protocol oversight, but I assume I'm just missing something.
2827                                         if need_commitment_update {
2828                                                 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2829                                                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2830                                                 return Ok(Some(msgs::FundingLocked {
2831                                                         channel_id: self.channel_id,
2832                                                         next_per_commitment_point: next_per_commitment_point,
2833                                                 }));
2834                                         }
2835                                 }
2836                         }
2837                 }
2838                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2839                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2840                                 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2841                                         let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2842                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2843                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
2844                                                 if self.channel_outbound {
2845                                                         // If we generated the funding transaction and it doesn't match what it
2846                                                         // should, the client is really broken and we should just panic and
2847                                                         // tell them off. That said, because hash collisions happen with high
2848                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
2849                                                         // channel and move on.
2850                                                         #[cfg(not(feature = "fuzztarget"))]
2851                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2852                                                 }
2853                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2854                                                 self.channel_update_count += 1;
2855                                                 return Err(msgs::ErrorMessage {
2856                                                         channel_id: self.channel_id(),
2857                                                         data: "funding tx had wrong script/value".to_owned()
2858                                                 });
2859                                         } else {
2860                                                 if self.channel_outbound {
2861                                                         for input in tx.input.iter() {
2862                                                                 if input.witness.is_empty() {
2863                                                                         // We generated a malleable funding transaction, implying we've
2864                                                                         // just exposed ourselves to funds loss to our counterparty.
2865                                                                         #[cfg(not(feature = "fuzztarget"))]
2866                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2867                                                                 }
2868                                                         }
2869                                                 }
2870                                                 self.funding_tx_confirmations = 1;
2871                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
2872                                                                              ((*index_in_block as u64) << (2*8)) |
2873                                                                              ((txo_idx as u64)         << (0*8)));
2874                                         }
2875                                 }
2876                         }
2877                 }
2878                 Ok(None)
2879         }
2880
2881         /// Called by channelmanager based on chain blocks being disconnected.
2882         /// Returns true if we need to close the channel now due to funding transaction
2883         /// unconfirmation/reorg.
2884         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2885                 if self.funding_tx_confirmations > 0 {
2886                         self.funding_tx_confirmations -= 1;
2887                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2888                                 return true;
2889                         }
2890                 }
2891                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2892                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2893                 }
2894                 self.last_block_connected = header.bitcoin_hash();
2895                 self.channel_monitor.last_block_hash = self.last_block_connected;
2896                 false
2897         }
2898
2899         // Methods to get unprompted messages to send to the remote end (or where we already returned
2900         // something in the handler for the message that prompted this message):
2901
2902         pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2903                 if !self.channel_outbound {
2904                         panic!("Tried to open a channel for an inbound channel?");
2905                 }
2906                 if self.channel_state != ChannelState::OurInitSent as u32 {
2907                         panic!("Cannot generate an open_channel after we've moved forward");
2908                 }
2909
2910                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2911                         panic!("Tried to send an open_channel for a channel that has already advanced");
2912                 }
2913
2914                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2915
2916                 msgs::OpenChannel {
2917                         chain_hash: chain_hash,
2918                         temporary_channel_id: self.channel_id,
2919                         funding_satoshis: self.channel_value_satoshis,
2920                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2921                         dust_limit_satoshis: self.our_dust_limit_satoshis,
2922                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2923                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2924                         htlc_minimum_msat: self.our_htlc_minimum_msat,
2925                         feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2926                         to_self_delay: BREAKDOWN_TIMEOUT,
2927                         max_accepted_htlcs: OUR_MAX_HTLCS,
2928                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2929                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2930                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2931                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2932                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2933                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2934                         channel_flags: if self.config.announced_channel {1} else {0},
2935                         shutdown_scriptpubkey: None,
2936                 }
2937         }
2938
2939         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2940                 if self.channel_outbound {
2941                         panic!("Tried to send accept_channel for an outbound channel?");
2942                 }
2943                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2944                         panic!("Tried to send accept_channel after channel had moved forward");
2945                 }
2946                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2947                         panic!("Tried to send an accept_channel for a channel that has already advanced");
2948                 }
2949
2950                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2951
2952                 msgs::AcceptChannel {
2953                         temporary_channel_id: self.channel_id,
2954                         dust_limit_satoshis: self.our_dust_limit_satoshis,
2955                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2956                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2957                         htlc_minimum_msat: self.our_htlc_minimum_msat,
2958                         minimum_depth: self.minimum_depth,
2959                         to_self_delay: BREAKDOWN_TIMEOUT,
2960                         max_accepted_htlcs: OUR_MAX_HTLCS,
2961                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2962                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2963                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2964                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2965                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2966                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2967                         shutdown_scriptpubkey: None,
2968                 }
2969         }
2970
2971         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
2972         fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
2973                 let funding_script = self.get_funding_redeemscript();
2974
2975                 let remote_keys = self.build_remote_transaction_keys()?;
2976                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
2977                 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
2978
2979                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2980                 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2981         }
2982
2983         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2984         /// a funding_created message for the remote peer.
2985         /// Panics if called at some time other than immediately after initial handshake, if called twice,
2986         /// or if called on an inbound channel.
2987         /// Note that channel_id changes during this call!
2988         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2989         /// If an Err is returned, it is a ChannelError::Close.
2990         pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), ChannelError> {
2991                 if !self.channel_outbound {
2992                         panic!("Tried to create outbound funding_created message on an inbound channel!");
2993                 }
2994                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2995                         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)");
2996                 }
2997                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2998                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2999                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3000                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3001                 }
3002
3003                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
3004                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
3005
3006                 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3007                         Ok(res) => res,
3008                         Err(e) => {
3009                                 log_error!(self, "Got bad signatures: {:?}!", e);
3010                                 self.channel_monitor.unset_funding_info();
3011                                 return Err(e);
3012                         }
3013                 };
3014
3015                 let temporary_channel_id = self.channel_id;
3016
3017                 // Now that we're past error-generating stuff, update our local state:
3018                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3019                 self.channel_state = ChannelState::FundingCreated as u32;
3020                 self.channel_id = funding_txo.to_channel_id();
3021                 self.cur_remote_commitment_transaction_number -= 1;
3022
3023                 Ok((msgs::FundingCreated {
3024                         temporary_channel_id: temporary_channel_id,
3025                         funding_txid: funding_txo.txid,
3026                         funding_output_index: funding_txo.index,
3027                         signature: our_signature
3028                 }, self.channel_monitor.clone()))
3029         }
3030
3031         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3032         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3033         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3034         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3035         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3036         /// closing).
3037         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3038         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3039         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3040                 if !self.config.announced_channel {
3041                         return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3042                 }
3043                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3044                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3045                 }
3046                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3047                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3048                 }
3049
3050                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3051                 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3052
3053                 let msg = msgs::UnsignedChannelAnnouncement {
3054                         features: msgs::GlobalFeatures::new(),
3055                         chain_hash: chain_hash,
3056                         short_channel_id: self.get_short_channel_id().unwrap(),
3057                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3058                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3059                         bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3060                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3061                         excess_data: Vec::new(),
3062                 };
3063
3064                 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
3065                 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3066
3067                 Ok((msg, sig))
3068         }
3069
3070         /// May panic if called on a channel that wasn't immediately-previously
3071         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3072         pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3073                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3074                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3075                 msgs::ChannelReestablish {
3076                         channel_id: self.channel_id(),
3077                         // The protocol has two different commitment number concepts - the "commitment
3078                         // transaction number", which starts from 0 and counts up, and the "revocation key
3079                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3080                         // commitment transaction numbers by the index which will be used to reveal the
3081                         // revocation key for that commitment transaction, which means we have to convert them
3082                         // to protocol-level commitment numbers here...
3083
3084                         // next_local_commitment_number is the next commitment_signed number we expect to
3085                         // receive (indicating if they need to resend one that we missed).
3086                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3087                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3088                         // receive, however we track it by the next commitment number for a remote transaction
3089                         // (which is one further, as they always revoke previous commitment transaction, not
3090                         // the one we send) so we have to decrement by 1. Note that if
3091                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3092                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3093                         // overflow here.
3094                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3095                         data_loss_protect: None,
3096                 }
3097         }
3098
3099
3100         // Send stuff to our remote peers:
3101
3102         /// Adds a pending outbound HTLC to this channel, note that you probably want
3103         /// send_htlc_and_commit instead cause you'll want both messages at once.
3104         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3105         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3106         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3107         /// You MUST call send_commitment prior to any other calls on this Channel
3108         pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
3109                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3110                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3111                 }
3112
3113                 if amount_msat > self.channel_value_satoshis * 1000 {
3114                         return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3115                 }
3116                 if amount_msat < self.their_htlc_minimum_msat {
3117                         return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3118                 }
3119
3120                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3121                         // Note that this should never really happen, if we're !is_live() on receipt of an
3122                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3123                         // the user to send directly into a !is_live() channel. However, if we
3124                         // disconnected during the time the previous hop was doing the commitment dance we may
3125                         // end up getting here after the forwarding delay. In any case, returning an
3126                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3127                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3128                 }
3129
3130                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3131                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3132                         return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3133                 }
3134                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3135                 // Check their_max_htlc_value_in_flight_msat
3136                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3137                         return Err(ChannelError::Ignore("Cannot send value that would put us over our max HTLC value in flight"));
3138                 }
3139
3140                 let mut holding_cell_outbound_amount_msat = 0;
3141                 for holding_htlc in self.holding_cell_htlc_updates.iter() {
3142                         match holding_htlc {
3143                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
3144                                         holding_cell_outbound_amount_msat += *amount_msat;
3145                                 }
3146                                 _ => {}
3147                         }
3148                 }
3149
3150                 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3151                 // reserve for them to have something to claim if we misbehave)
3152                 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
3153                         return Err(ChannelError::Ignore("Cannot send value that would put us over our reserve value"));
3154                 }
3155
3156                 //TODO: Check cltv_expiry? Do this in channel manager?
3157
3158                 // Now update local state:
3159                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3160                         //TODO: Check the limits *including* other pending holding cell HTLCs!
3161                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3162                                 amount_msat: amount_msat,
3163                                 payment_hash: payment_hash,
3164                                 cltv_expiry: cltv_expiry,
3165                                 source,
3166                                 onion_routing_packet: onion_routing_packet,
3167                                 time_created: Instant::now(),
3168                         });
3169                         return Ok(None);
3170                 }
3171
3172                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3173                         htlc_id: self.next_local_htlc_id,
3174                         amount_msat: amount_msat,
3175                         payment_hash: payment_hash.clone(),
3176                         cltv_expiry: cltv_expiry,
3177                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3178                         source,
3179                         fail_reason: None,
3180                 });
3181
3182                 let res = msgs::UpdateAddHTLC {
3183                         channel_id: self.channel_id,
3184                         htlc_id: self.next_local_htlc_id,
3185                         amount_msat: amount_msat,
3186                         payment_hash: payment_hash,
3187                         cltv_expiry: cltv_expiry,
3188                         onion_routing_packet: onion_routing_packet,
3189                 };
3190                 self.next_local_htlc_id += 1;
3191
3192                 Ok(Some(res))
3193         }
3194
3195         /// Creates a signed commitment transaction to send to the remote peer.
3196         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3197         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3198         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3199         pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3200                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3201                         panic!("Cannot create commitment tx until channel is fully established");
3202                 }
3203                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3204                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3205                 }
3206                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3207                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3208                 }
3209                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3210                         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");
3211                 }
3212                 let mut have_updates = self.pending_update_fee.is_some();
3213                 for htlc in self.pending_outbound_htlcs.iter() {
3214                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3215                                 have_updates = true;
3216                         }
3217                         if have_updates { break; }
3218                 }
3219                 if !have_updates {
3220                         panic!("Cannot create commitment tx until we have some updates to send");
3221                 }
3222                 self.send_commitment_no_status_check()
3223         }
3224         /// Only fails in case of bad keys
3225         fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3226                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3227                 // fail to generate this, we still are at least at a position where upgrading their status
3228                 // is acceptable.
3229                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3230                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3231                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3232                         } else { None };
3233                         if let Some(state) = new_state {
3234                                 htlc.state = state;
3235                         }
3236                 }
3237                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3238                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
3239                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
3240                         }
3241                 }
3242
3243                 match self.send_commitment_no_state_update() {
3244                         Ok((res, remote_commitment_tx)) => {
3245                                 // Update state now that we've passed all the can-fail calls...
3246                                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, remote_commitment_tx.2, self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3247                                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3248                                 Ok((res, self.channel_monitor.clone()))
3249                         },
3250                         Err(e) => Err(e),
3251                 }
3252         }
3253
3254         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3255         /// when we shouldn't change HTLC/channel state.
3256         fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>, Vec<([u8; 32], HTLCSource, Option<u32>)>)), ChannelError> {
3257                 let funding_script = self.get_funding_redeemscript();
3258
3259                 let mut feerate_per_kw = self.feerate_per_kw;
3260                 if let Some(feerate) = self.pending_update_fee {
3261                         if self.channel_outbound {
3262                                 feerate_per_kw = feerate;
3263                         }
3264                 }
3265
3266                 let remote_keys = self.build_remote_transaction_keys()?;
3267                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3268                 let remote_commitment_txid = remote_commitment_tx.0.txid();
3269                 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
3270                 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3271
3272                 let mut htlc_sigs = Vec::new();
3273
3274                 for ref htlc in remote_commitment_tx.1.iter() {
3275                         let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3276                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3277                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3278                         let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
3279                         htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3280                 }
3281
3282                 Ok((msgs::CommitmentSigned {
3283                         channel_id: self.channel_id,
3284                         signature: our_sig,
3285                         htlc_signatures: htlc_sigs,
3286                 }, remote_commitment_tx))
3287         }
3288
3289         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3290         /// to send to the remote peer in one go.
3291         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3292         /// more info.
3293         pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
3294                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3295                         Some(update_add_htlc) => {
3296                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3297                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3298                         },
3299                         None => Ok(None)
3300                 }
3301         }
3302
3303         /// Begins the shutdown process, getting a message for the remote peer and returning all
3304         /// holding cell HTLCs for payment failure.
3305         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
3306                 for htlc in self.pending_outbound_htlcs.iter() {
3307                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3308                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3309                         }
3310                 }
3311                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3312                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3313                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3314                         }
3315                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3316                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3317                         }
3318                 }
3319                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3320                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3321                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3322                 }
3323
3324                 let our_closing_script = self.get_closing_scriptpubkey();
3325
3326                 // From here on out, we may not fail!
3327                 if self.channel_state < ChannelState::FundingSent as u32 {
3328                         self.channel_state = ChannelState::ShutdownComplete as u32;
3329                 } else {
3330                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3331                 }
3332                 self.channel_update_count += 1;
3333
3334                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3335                 // our shutdown until we've committed all of the pending changes.
3336                 self.holding_cell_update_fee = None;
3337                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3338                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3339                         match htlc_update {
3340                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3341                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3342                                         false
3343                                 },
3344                                 _ => true
3345                         }
3346                 });
3347
3348                 Ok((msgs::Shutdown {
3349                         channel_id: self.channel_id,
3350                         scriptpubkey: our_closing_script,
3351                 }, dropped_outbound_htlcs))
3352         }
3353
3354         /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3355         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3356         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3357         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3358         /// immediately (others we will have to allow to time out).
3359         pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
3360                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3361
3362                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3363                 // return them to fail the payment.
3364                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3365                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3366                         match htlc_update {
3367                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3368                                         dropped_outbound_htlcs.push((source, payment_hash));
3369                                 },
3370                                 _ => {}
3371                         }
3372                 }
3373
3374                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3375                         //TODO: Do something with the remaining HTLCs
3376                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3377                         //which correspond)
3378                 }
3379
3380                 self.channel_state = ChannelState::ShutdownComplete as u32;
3381                 self.channel_update_count += 1;
3382                 let mut res = Vec::new();
3383                 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3384                 (res, dropped_outbound_htlcs)
3385         }
3386 }
3387
3388 const SERIALIZATION_VERSION: u8 = 1;
3389 const MIN_SERIALIZATION_VERSION: u8 = 1;
3390
3391 impl Writeable for InboundHTLCRemovalReason {
3392         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3393                 match self {
3394                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3395                                 0u8.write(writer)?;
3396                                 error_packet.write(writer)?;
3397                         },
3398                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3399                                 1u8.write(writer)?;
3400                                 onion_hash.write(writer)?;
3401                                 err_code.write(writer)?;
3402                         },
3403                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3404                                 2u8.write(writer)?;
3405                                 payment_preimage.write(writer)?;
3406                         },
3407                 }
3408                 Ok(())
3409         }
3410 }
3411
3412 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3413         fn read(reader: &mut R) -> Result<Self, DecodeError> {
3414                 Ok(match <u8 as Readable<R>>::read(reader)? {
3415                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3416                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3417                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3418                         _ => return Err(DecodeError::InvalidValue),
3419                 })
3420         }
3421 }
3422
3423 impl Writeable for Channel {
3424         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3425                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3426                 // called but include holding cell updates (and obviously we don't modify self).
3427
3428                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3429                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3430
3431                 self.user_id.write(writer)?;
3432                 self.config.write(writer)?;
3433
3434                 self.channel_id.write(writer)?;
3435                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3436                 self.channel_outbound.write(writer)?;
3437                 self.channel_value_satoshis.write(writer)?;
3438
3439                 self.local_keys.write(writer)?;
3440                 self.shutdown_pubkey.write(writer)?;
3441
3442                 self.cur_local_commitment_transaction_number.write(writer)?;
3443                 self.cur_remote_commitment_transaction_number.write(writer)?;
3444                 self.value_to_self_msat.write(writer)?;
3445
3446                 self.received_commitment_while_awaiting_raa.write(writer)?;
3447
3448                 let mut dropped_inbound_htlcs = 0;
3449                 for htlc in self.pending_inbound_htlcs.iter() {
3450                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3451                                 dropped_inbound_htlcs += 1;
3452                         }
3453                 }
3454                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3455                 for htlc in self.pending_inbound_htlcs.iter() {
3456                         htlc.htlc_id.write(writer)?;
3457                         htlc.amount_msat.write(writer)?;
3458                         htlc.cltv_expiry.write(writer)?;
3459                         htlc.payment_hash.write(writer)?;
3460                         match &htlc.state {
3461                                 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3462                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3463                                         1u8.write(writer)?;
3464                                         htlc_state.write(writer)?;
3465                                 },
3466                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3467                                         2u8.write(writer)?;
3468                                         htlc_state.write(writer)?;
3469                                 },
3470                                 &InboundHTLCState::Committed => {
3471                                         3u8.write(writer)?;
3472                                 },
3473                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3474                                         4u8.write(writer)?;
3475                                         removal_reason.write(writer)?;
3476                                 },
3477                         }
3478                 }
3479
3480                 macro_rules! write_option {
3481                         ($thing: expr) => {
3482                                 match &$thing {
3483                                         &None => 0u8.write(writer)?,
3484                                         &Some(ref v) => {
3485                                                 1u8.write(writer)?;
3486                                                 v.write(writer)?;
3487                                         },
3488                                 }
3489                         }
3490                 }
3491
3492                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3493                 for htlc in self.pending_outbound_htlcs.iter() {
3494                         htlc.htlc_id.write(writer)?;
3495                         htlc.amount_msat.write(writer)?;
3496                         htlc.cltv_expiry.write(writer)?;
3497                         htlc.payment_hash.write(writer)?;
3498                         htlc.source.write(writer)?;
3499                         write_option!(htlc.fail_reason);
3500                         match &htlc.state {
3501                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3502                                         0u8.write(writer)?;
3503                                         onion_packet.write(writer)?;
3504                                 },
3505                                 &OutboundHTLCState::Committed => {
3506                                         1u8.write(writer)?;
3507                                 },
3508                                 &OutboundHTLCState::RemoteRemoved => {
3509                                         2u8.write(writer)?;
3510                                 },
3511                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove => {
3512                                         3u8.write(writer)?;
3513                                 },
3514                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
3515                                         4u8.write(writer)?;
3516                                 },
3517                         }
3518                 }
3519
3520                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3521                 for update in self.holding_cell_htlc_updates.iter() {
3522                         match update {
3523                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, time_created: _ } => {
3524                                         0u8.write(writer)?;
3525                                         amount_msat.write(writer)?;
3526                                         cltv_expiry.write(writer)?;
3527                                         payment_hash.write(writer)?;
3528                                         source.write(writer)?;
3529                                         onion_routing_packet.write(writer)?;
3530                                         // time_created is not serialized - we re-init the timeout upon deserialization
3531                                 },
3532                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3533                                         1u8.write(writer)?;
3534                                         payment_preimage.write(writer)?;
3535                                         htlc_id.write(writer)?;
3536                                 },
3537                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3538                                         2u8.write(writer)?;
3539                                         htlc_id.write(writer)?;
3540                                         err_packet.write(writer)?;
3541                                 }
3542                         }
3543                 }
3544
3545                 self.monitor_pending_revoke_and_ack.write(writer)?;
3546                 self.monitor_pending_commitment_signed.write(writer)?;
3547                 match self.monitor_pending_order {
3548                         None => 0u8.write(writer)?,
3549                         Some(RAACommitmentOrder::CommitmentFirst) => 1u8.write(writer)?,
3550                         Some(RAACommitmentOrder::RevokeAndACKFirst) => 2u8.write(writer)?,
3551                 }
3552
3553                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3554                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3555                         pending_forward.write(writer)?;
3556                         htlc_id.write(writer)?;
3557                 }
3558
3559                 (self.monitor_pending_failures.len() as u64).write(writer)?;
3560                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3561                         htlc_source.write(writer)?;
3562                         payment_hash.write(writer)?;
3563                         fail_reason.write(writer)?;
3564                 }
3565
3566                 write_option!(self.pending_update_fee);
3567                 write_option!(self.holding_cell_update_fee);
3568
3569                 self.next_local_htlc_id.write(writer)?;
3570                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3571                 self.channel_update_count.write(writer)?;
3572                 self.feerate_per_kw.write(writer)?;
3573
3574                 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3575                 for tx in self.last_local_commitment_txn.iter() {
3576                         if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3577                                 match e {
3578                                         encode::Error::Io(e) => return Err(e),
3579                                         _ => panic!("last_local_commitment_txn must have been well-formed!"),
3580                                 }
3581                         }
3582                 }
3583
3584                 match self.last_sent_closing_fee {
3585                         Some((feerate, fee)) => {
3586                                 1u8.write(writer)?;
3587                                 feerate.write(writer)?;
3588                                 fee.write(writer)?;
3589                         },
3590                         None => 0u8.write(writer)?,
3591                 }
3592
3593                 write_option!(self.funding_tx_confirmed_in);
3594                 write_option!(self.short_channel_id);
3595
3596                 self.last_block_connected.write(writer)?;
3597                 self.funding_tx_confirmations.write(writer)?;
3598
3599                 self.their_dust_limit_satoshis.write(writer)?;
3600                 self.our_dust_limit_satoshis.write(writer)?;
3601                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3602                 self.their_channel_reserve_satoshis.write(writer)?;
3603                 self.their_htlc_minimum_msat.write(writer)?;
3604                 self.our_htlc_minimum_msat.write(writer)?;
3605                 self.their_to_self_delay.write(writer)?;
3606                 self.their_max_accepted_htlcs.write(writer)?;
3607                 self.minimum_depth.write(writer)?;
3608
3609                 write_option!(self.their_funding_pubkey);
3610                 write_option!(self.their_revocation_basepoint);
3611                 write_option!(self.their_payment_basepoint);
3612                 write_option!(self.their_delayed_payment_basepoint);
3613                 write_option!(self.their_htlc_basepoint);
3614                 write_option!(self.their_cur_commitment_point);
3615
3616                 write_option!(self.their_prev_commitment_point);
3617                 self.their_node_id.write(writer)?;
3618
3619                 write_option!(self.their_shutdown_scriptpubkey);
3620
3621                 self.channel_monitor.write_for_disk(writer)?;
3622                 Ok(())
3623         }
3624 }
3625
3626 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3627         fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3628                 let _ver: u8 = Readable::read(reader)?;
3629                 let min_ver: u8 = Readable::read(reader)?;
3630                 if min_ver > SERIALIZATION_VERSION {
3631                         return Err(DecodeError::UnknownVersion);
3632                 }
3633
3634                 let user_id = Readable::read(reader)?;
3635                 let config: ChannelConfig = Readable::read(reader)?;
3636
3637                 let channel_id = Readable::read(reader)?;
3638                 let channel_state = Readable::read(reader)?;
3639                 let channel_outbound = Readable::read(reader)?;
3640                 let channel_value_satoshis = Readable::read(reader)?;
3641
3642                 let local_keys = Readable::read(reader)?;
3643                 let shutdown_pubkey = Readable::read(reader)?;
3644
3645                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3646                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3647                 let value_to_self_msat = Readable::read(reader)?;
3648
3649                 let received_commitment_while_awaiting_raa = Readable::read(reader)?;
3650
3651                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3652                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3653                 for _ in 0..pending_inbound_htlc_count {
3654                         pending_inbound_htlcs.push(InboundHTLCOutput {
3655                                 htlc_id: Readable::read(reader)?,
3656                                 amount_msat: Readable::read(reader)?,
3657                                 cltv_expiry: Readable::read(reader)?,
3658                                 payment_hash: Readable::read(reader)?,
3659                                 state: match <u8 as Readable<R>>::read(reader)? {
3660                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3661                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3662                                         3 => InboundHTLCState::Committed,
3663                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3664                                         _ => return Err(DecodeError::InvalidValue),
3665                                 },
3666                         });
3667                 }
3668
3669                 macro_rules! read_option { () => {
3670                         match <u8 as Readable<R>>::read(reader)? {
3671                                 0 => None,
3672                                 1 => Some(Readable::read(reader)?),
3673                                 _ => return Err(DecodeError::InvalidValue),
3674                         }
3675                 } }
3676
3677                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3678                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3679                 for _ in 0..pending_outbound_htlc_count {
3680                         pending_outbound_htlcs.push(OutboundHTLCOutput {
3681                                 htlc_id: Readable::read(reader)?,
3682                                 amount_msat: Readable::read(reader)?,
3683                                 cltv_expiry: Readable::read(reader)?,
3684                                 payment_hash: Readable::read(reader)?,
3685                                 source: Readable::read(reader)?,
3686                                 fail_reason: read_option!(),
3687                                 state: match <u8 as Readable<R>>::read(reader)? {
3688                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3689                                         1 => OutboundHTLCState::Committed,
3690                                         2 => OutboundHTLCState::RemoteRemoved,
3691                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove,
3692                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke,
3693                                         _ => return Err(DecodeError::InvalidValue),
3694                                 },
3695                         });
3696                 }
3697
3698                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3699                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3700                 for _ in 0..holding_cell_htlc_update_count {
3701                         holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3702                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
3703                                         amount_msat: Readable::read(reader)?,
3704                                         cltv_expiry: Readable::read(reader)?,
3705                                         payment_hash: Readable::read(reader)?,
3706                                         source: Readable::read(reader)?,
3707                                         onion_routing_packet: Readable::read(reader)?,
3708                                         time_created: Instant::now(),
3709                                 },
3710                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3711                                         payment_preimage: Readable::read(reader)?,
3712                                         htlc_id: Readable::read(reader)?,
3713                                 },
3714                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
3715                                         htlc_id: Readable::read(reader)?,
3716                                         err_packet: Readable::read(reader)?,
3717                                 },
3718                                 _ => return Err(DecodeError::InvalidValue),
3719                         });
3720                 }
3721
3722                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3723                 let monitor_pending_commitment_signed = Readable::read(reader)?;
3724
3725                 let monitor_pending_order = match <u8 as Readable<R>>::read(reader)? {
3726                         0 => None,
3727                         1 => Some(RAACommitmentOrder::CommitmentFirst),
3728                         2 => Some(RAACommitmentOrder::RevokeAndACKFirst),
3729                         _ => return Err(DecodeError::InvalidValue),
3730                 };
3731
3732                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3733                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3734                 for _ in 0..monitor_pending_forwards_count {
3735                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3736                 }
3737
3738                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3739                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3740                 for _ in 0..monitor_pending_failures_count {
3741                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3742                 }
3743
3744                 let pending_update_fee = read_option!();
3745                 let holding_cell_update_fee = read_option!();
3746
3747                 let next_local_htlc_id = Readable::read(reader)?;
3748                 let next_remote_htlc_id = Readable::read(reader)?;
3749                 let channel_update_count = Readable::read(reader)?;
3750                 let feerate_per_kw = Readable::read(reader)?;
3751
3752                 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3753                 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3754                 for _ in 0..last_local_commitment_txn_count {
3755                         last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3756                                 Ok(tx) => tx,
3757                                 Err(_) => return Err(DecodeError::InvalidValue),
3758                         });
3759                 }
3760
3761                 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3762                         0 => None,
3763                         1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3764                         _ => return Err(DecodeError::InvalidValue),
3765                 };
3766
3767                 let funding_tx_confirmed_in = read_option!();
3768                 let short_channel_id = read_option!();
3769
3770                 let last_block_connected = Readable::read(reader)?;
3771                 let funding_tx_confirmations = Readable::read(reader)?;
3772
3773                 let their_dust_limit_satoshis = Readable::read(reader)?;
3774                 let our_dust_limit_satoshis = Readable::read(reader)?;
3775                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3776                 let their_channel_reserve_satoshis = Readable::read(reader)?;
3777                 let their_htlc_minimum_msat = Readable::read(reader)?;
3778                 let our_htlc_minimum_msat = Readable::read(reader)?;
3779                 let their_to_self_delay = Readable::read(reader)?;
3780                 let their_max_accepted_htlcs = Readable::read(reader)?;
3781                 let minimum_depth = Readable::read(reader)?;
3782
3783                 let their_funding_pubkey = read_option!();
3784                 let their_revocation_basepoint = read_option!();
3785                 let their_payment_basepoint = read_option!();
3786                 let their_delayed_payment_basepoint = read_option!();
3787                 let their_htlc_basepoint = read_option!();
3788                 let their_cur_commitment_point = read_option!();
3789
3790                 let their_prev_commitment_point = read_option!();
3791                 let their_node_id = Readable::read(reader)?;
3792
3793                 let their_shutdown_scriptpubkey = read_option!();
3794                 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3795                 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3796                 // doing full block connection operations on the internal CHannelMonitor copies
3797                 if monitor_last_block != last_block_connected {
3798                         return Err(DecodeError::InvalidValue);
3799                 }
3800
3801                 Ok(Channel {
3802                         user_id,
3803
3804                         config,
3805                         channel_id,
3806                         channel_state,
3807                         channel_outbound,
3808                         secp_ctx: Secp256k1::new(),
3809                         channel_value_satoshis,
3810
3811                         local_keys,
3812                         shutdown_pubkey,
3813
3814                         cur_local_commitment_transaction_number,
3815                         cur_remote_commitment_transaction_number,
3816                         value_to_self_msat,
3817
3818                         received_commitment_while_awaiting_raa,
3819                         pending_inbound_htlcs,
3820                         pending_outbound_htlcs,
3821                         holding_cell_htlc_updates,
3822
3823                         monitor_pending_revoke_and_ack,
3824                         monitor_pending_commitment_signed,
3825                         monitor_pending_order,
3826                         monitor_pending_forwards,
3827                         monitor_pending_failures,
3828
3829                         pending_update_fee,
3830                         holding_cell_update_fee,
3831                         next_local_htlc_id,
3832                         next_remote_htlc_id,
3833                         channel_update_count,
3834                         feerate_per_kw,
3835
3836                         #[cfg(debug_assertions)]
3837                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3838                         #[cfg(debug_assertions)]
3839                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3840
3841                         last_local_commitment_txn,
3842
3843                         last_sent_closing_fee,
3844
3845                         funding_tx_confirmed_in,
3846                         short_channel_id,
3847                         last_block_connected,
3848                         funding_tx_confirmations,
3849
3850                         their_dust_limit_satoshis,
3851                         our_dust_limit_satoshis,
3852                         their_max_htlc_value_in_flight_msat,
3853                         their_channel_reserve_satoshis,
3854                         their_htlc_minimum_msat,
3855                         our_htlc_minimum_msat,
3856                         their_to_self_delay,
3857                         their_max_accepted_htlcs,
3858                         minimum_depth,
3859
3860                         their_funding_pubkey,
3861                         their_revocation_basepoint,
3862                         their_payment_basepoint,
3863                         their_delayed_payment_basepoint,
3864                         their_htlc_basepoint,
3865                         their_cur_commitment_point,
3866
3867                         their_prev_commitment_point,
3868                         their_node_id,
3869
3870                         their_shutdown_scriptpubkey,
3871
3872                         channel_monitor,
3873
3874                         logger,
3875                 })
3876         }
3877 }
3878
3879 #[cfg(test)]
3880 mod tests {
3881         use bitcoin::util::hash::{Sha256dHash, Hash160};
3882         use bitcoin::util::bip143;
3883         use bitcoin::consensus::encode::serialize;
3884         use bitcoin::blockdata::script::{Script, Builder};
3885         use bitcoin::blockdata::transaction::Transaction;
3886         use bitcoin::blockdata::opcodes;
3887         use hex;
3888         use ln::channelmanager::HTLCSource;
3889         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3890         use ln::channel::MAX_FUNDING_SATOSHIS;
3891         use ln::chan_utils;
3892         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3893         use chain::keysinterface::KeysInterface;
3894         use chain::transaction::OutPoint;
3895         use util::config::UserConfig;
3896         use util::test_utils;
3897         use util::logger::Logger;
3898         use secp256k1::{Secp256k1,Message,Signature};
3899         use secp256k1::key::{SecretKey,PublicKey};
3900         use crypto::sha2::Sha256;
3901         use crypto::digest::Digest;
3902         use std::sync::Arc;
3903
3904         struct TestFeeEstimator {
3905                 fee_est: u64
3906         }
3907         impl FeeEstimator for TestFeeEstimator {
3908                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3909                         self.fee_est
3910                 }
3911         }
3912
3913         #[test]
3914         fn test_max_funding_satoshis() {
3915                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3916                         "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3917         }
3918
3919         struct Keys {
3920                 chan_keys: ChannelKeys,
3921         }
3922         impl KeysInterface for Keys {
3923                 fn get_node_secret(&self) -> SecretKey { panic!(); }
3924                 fn get_destination_script(&self) -> Script {
3925                         let secp_ctx = Secp256k1::signing_only();
3926                         let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3927                         let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
3928                         Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
3929                 }
3930
3931                 fn get_shutdown_pubkey(&self) -> PublicKey {
3932                         let secp_ctx = Secp256k1::signing_only();
3933                         let channel_close_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3934                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
3935                 }
3936
3937                 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
3938                 fn get_session_key(&self) -> SecretKey { panic!(); }
3939         }
3940
3941         #[test]
3942         fn outbound_commitment_test() {
3943                 // Test vectors from BOLT 3 Appendix C:
3944                 let feeest = TestFeeEstimator{fee_est: 15000};
3945                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3946                 let secp_ctx = Secp256k1::new();
3947
3948                 let chan_keys = ChannelKeys {
3949                         funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3950                         payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3951                         delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3952                         htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3953
3954                         // These aren't set in the test vectors:
3955                         revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3956                         commitment_seed: [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],
3957                 };
3958                 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3959                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3960                 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
3961
3962                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
3963                 let mut config = UserConfig::new();
3964                 config.channel_options.announced_channel = false;
3965                 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
3966                 chan.their_to_self_delay = 144;
3967                 chan.our_dust_limit_satoshis = 546;
3968
3969                 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
3970                 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
3971
3972                 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3973                 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
3974                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3975
3976                 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
3977                 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
3978                                 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
3979
3980                 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3981                 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
3982                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3983
3984                 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
3985
3986                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
3987                 // derived from a commitment_seed, so instead we copy it here and call
3988                 // build_commitment_transaction.
3989                 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
3990                 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3991                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3992                 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
3993                 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
3994
3995                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
3996
3997                 macro_rules! test_commitment {
3998                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
3999                                 unsigned_tx = {
4000                                         let res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4001                                         (res.0, res.1)
4002                                 };
4003                                 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4004                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &chan.get_funding_redeemscript(), chan.channel_value_satoshis)[..]).unwrap();
4005                                 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
4006
4007                                 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
4008
4009                                 assert_eq!(serialize(&unsigned_tx.0)[..],
4010                                                 hex::decode($tx_hex).unwrap()[..]);
4011                         };
4012                 }
4013
4014                 macro_rules! test_htlc_output {
4015                         ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4016                                 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4017
4018                                 let ref htlc = unsigned_tx.1[$htlc_idx];
4019                                 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4020                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4021                                 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4022                                 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4023
4024                                 let mut preimage: Option<[u8; 32]> = None;
4025                                 if !htlc.offered {
4026                                         for i in 0..5 {
4027                                                 let mut sha = Sha256::new();
4028                                                 sha.input(&[i; 32]);
4029
4030                                                 let mut out = [0; 32];
4031                                                 sha.result(&mut out);
4032
4033                                                 if out == htlc.payment_hash {
4034                                                         preimage = Some([i; 32]);
4035                                                 }
4036                                         }
4037
4038                                         assert!(preimage.is_some());
4039                                 }
4040
4041                                 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
4042                                 assert_eq!(serialize(&htlc_tx)[..],
4043                                                 hex::decode($tx_hex).unwrap()[..]);
4044                         };
4045                 }
4046
4047                 {
4048                         // simple commitment tx with no HTLCs
4049                         chan.value_to_self_msat = 7000000000;
4050
4051                         test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4052                                          "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4053                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4054                 }
4055
4056                 chan.pending_inbound_htlcs.push({
4057                         let mut out = InboundHTLCOutput{
4058                                 htlc_id: 0,
4059                                 amount_msat: 1000000,
4060                                 cltv_expiry: 500,
4061                                 payment_hash: [0; 32],
4062                                 state: InboundHTLCState::Committed,
4063                         };
4064                         let mut sha = Sha256::new();
4065                         sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4066                         sha.result(&mut out.payment_hash);
4067                         out
4068                 });
4069                 chan.pending_inbound_htlcs.push({
4070                         let mut out = InboundHTLCOutput{
4071                                 htlc_id: 1,
4072                                 amount_msat: 2000000,
4073                                 cltv_expiry: 501,
4074                                 payment_hash: [0; 32],
4075                                 state: InboundHTLCState::Committed,
4076                         };
4077                         let mut sha = Sha256::new();
4078                         sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4079                         sha.result(&mut out.payment_hash);
4080                         out
4081                 });
4082                 chan.pending_outbound_htlcs.push({
4083                         let mut out = OutboundHTLCOutput{
4084                                 htlc_id: 2,
4085                                 amount_msat: 2000000,
4086                                 cltv_expiry: 502,
4087                                 payment_hash: [0; 32],
4088                                 state: OutboundHTLCState::Committed,
4089                                 source: HTLCSource::dummy(),
4090                                 fail_reason: None,
4091                         };
4092                         let mut sha = Sha256::new();
4093                         sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
4094                         sha.result(&mut out.payment_hash);
4095                         out
4096                 });
4097                 chan.pending_outbound_htlcs.push({
4098                         let mut out = OutboundHTLCOutput{
4099                                 htlc_id: 3,
4100                                 amount_msat: 3000000,
4101                                 cltv_expiry: 503,
4102                                 payment_hash: [0; 32],
4103                                 state: OutboundHTLCState::Committed,
4104                                 source: HTLCSource::dummy(),
4105                                 fail_reason: None,
4106                         };
4107                         let mut sha = Sha256::new();
4108                         sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
4109                         sha.result(&mut out.payment_hash);
4110                         out
4111                 });
4112                 chan.pending_inbound_htlcs.push({
4113                         let mut out = InboundHTLCOutput{
4114                                 htlc_id: 4,
4115                                 amount_msat: 4000000,
4116                                 cltv_expiry: 504,
4117                                 payment_hash: [0; 32],
4118                                 state: InboundHTLCState::Committed,
4119                         };
4120                         let mut sha = Sha256::new();
4121                         sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
4122                         sha.result(&mut out.payment_hash);
4123                         out
4124                 });
4125
4126                 {
4127                         // commitment tx with all five HTLCs untrimmed (minimum feerate)
4128                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4129                         chan.feerate_per_kw = 0;
4130
4131                         test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4132                                          "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4133                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4134
4135                         assert_eq!(unsigned_tx.1.len(), 5);
4136
4137                         test_htlc_output!(0,
4138                                           "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4139                                           "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4140                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4141
4142                         test_htlc_output!(1,
4143                                           "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4144                                           "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4145                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4146
4147                         test_htlc_output!(2,
4148                                           "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4149                                           "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4150                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4151
4152                         test_htlc_output!(3,
4153                                           "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4154                                           "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4155                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4156
4157                         test_htlc_output!(4,
4158                                           "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4159                                           "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4160                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4161                 }
4162
4163                 {
4164                         // commitment tx with seven outputs untrimmed (maximum feerate)
4165                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4166                         chan.feerate_per_kw = 647;
4167
4168                         test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4169                                          "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4170                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4171
4172                         assert_eq!(unsigned_tx.1.len(), 5);
4173
4174                         test_htlc_output!(0,
4175                                           "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4176                                           "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4177                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4178
4179                         test_htlc_output!(1,
4180                                           "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4181                                           "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4182                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4183
4184                         test_htlc_output!(2,
4185                                           "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4186                                           "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4187                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4188
4189                         test_htlc_output!(3,
4190                                           "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4191                                           "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4192                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4193
4194                         test_htlc_output!(4,
4195                                           "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4196                                           "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4197                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4198                 }
4199
4200                 {
4201                         // commitment tx with six outputs untrimmed (minimum feerate)
4202                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4203                         chan.feerate_per_kw = 648;
4204
4205                         test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4206                                          "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4207                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4208
4209                         assert_eq!(unsigned_tx.1.len(), 4);
4210
4211                         test_htlc_output!(0,
4212                                           "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4213                                           "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4214                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4215
4216                         test_htlc_output!(1,
4217                                           "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4218                                           "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4219                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4220
4221                         test_htlc_output!(2,
4222                                           "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4223                                           "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4224                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4225
4226                         test_htlc_output!(3,
4227                                           "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4228                                           "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4229                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4230                 }
4231
4232                 {
4233                         // commitment tx with six outputs untrimmed (maximum feerate)
4234                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4235                         chan.feerate_per_kw = 2069;
4236
4237                         test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4238                                          "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4239                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4240
4241                         assert_eq!(unsigned_tx.1.len(), 4);
4242
4243                         test_htlc_output!(0,
4244                                           "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4245                                           "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4246                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4247
4248                         test_htlc_output!(1,
4249                                           "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4250                                           "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4251                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4252
4253                         test_htlc_output!(2,
4254                                           "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4255                                           "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4256                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4257
4258                         test_htlc_output!(3,
4259                                           "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4260                                           "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4261                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4262                 }
4263
4264                 {
4265                         // commitment tx with five outputs untrimmed (minimum feerate)
4266                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4267                         chan.feerate_per_kw = 2070;
4268
4269                         test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4270                                          "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4271                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4272
4273                         assert_eq!(unsigned_tx.1.len(), 3);
4274
4275                         test_htlc_output!(0,
4276                                           "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4277                                           "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4278                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4279
4280                         test_htlc_output!(1,
4281                                           "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4282                                           "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4283                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4284
4285                         test_htlc_output!(2,
4286                                           "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4287                                           "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4288                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4289                 }
4290
4291                 {
4292                         // commitment tx with five outputs untrimmed (maximum feerate)
4293                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4294                         chan.feerate_per_kw = 2194;
4295
4296                         test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4297                                          "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4298                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4299
4300                         assert_eq!(unsigned_tx.1.len(), 3);
4301
4302                         test_htlc_output!(0,
4303                                           "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4304                                           "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4305                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4306
4307                         test_htlc_output!(1,
4308                                           "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4309                                           "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4310                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4311
4312                         test_htlc_output!(2,
4313                                           "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4314                                           "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4315                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4316                 }
4317
4318                 {
4319                         // commitment tx with four outputs untrimmed (minimum feerate)
4320                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4321                         chan.feerate_per_kw = 2195;
4322
4323                         test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4324                                          "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4325                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4326
4327                         assert_eq!(unsigned_tx.1.len(), 2);
4328
4329                         test_htlc_output!(0,
4330                                           "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4331                                           "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4332                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4333
4334                         test_htlc_output!(1,
4335                                           "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4336                                           "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4337                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4338                 }
4339
4340                 {
4341                         // commitment tx with four outputs untrimmed (maximum feerate)
4342                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4343                         chan.feerate_per_kw = 3702;
4344
4345                         test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4346                                          "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4347                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4348
4349                         assert_eq!(unsigned_tx.1.len(), 2);
4350
4351                         test_htlc_output!(0,
4352                                           "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4353                                           "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4354                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4355
4356                         test_htlc_output!(1,
4357                                           "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4358                                           "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4359                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4360                 }
4361
4362                 {
4363                         // commitment tx with three outputs untrimmed (minimum feerate)
4364                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4365                         chan.feerate_per_kw = 3703;
4366
4367                         test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4368                                          "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4369                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4370
4371                         assert_eq!(unsigned_tx.1.len(), 1);
4372
4373                         test_htlc_output!(0,
4374                                           "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4375                                           "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4376                                           "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4377                 }
4378
4379                 {
4380                         // commitment tx with three outputs untrimmed (maximum feerate)
4381                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4382                         chan.feerate_per_kw = 4914;
4383
4384                         test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4385                                          "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4386                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4387
4388                         assert_eq!(unsigned_tx.1.len(), 1);
4389
4390                         test_htlc_output!(0,
4391                                           "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4392                                           "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4393                                           "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4394                 }
4395
4396                 {
4397                         // commitment tx with two outputs untrimmed (minimum feerate)
4398                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4399                         chan.feerate_per_kw = 4915;
4400
4401                         test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4402                                          "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4403                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4404
4405                         assert_eq!(unsigned_tx.1.len(), 0);
4406                 }
4407
4408                 {
4409                         // commitment tx with two outputs untrimmed (maximum feerate)
4410                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4411                         chan.feerate_per_kw = 9651180;
4412
4413                         test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4414                                          "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4415                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4416
4417                         assert_eq!(unsigned_tx.1.len(), 0);
4418                 }
4419
4420                 {
4421                         // commitment tx with one output untrimmed (minimum feerate)
4422                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4423                         chan.feerate_per_kw = 9651181;
4424
4425                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4426                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4427                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4428
4429                         assert_eq!(unsigned_tx.1.len(), 0);
4430                 }
4431
4432                 {
4433                         // commitment tx with fee greater than funder amount
4434                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4435                         chan.feerate_per_kw = 9651936;
4436
4437                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4438                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4439                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4440
4441                         assert_eq!(unsigned_tx.1.len(), 0);
4442                 }
4443         }
4444
4445         #[test]
4446         fn test_per_commitment_secret_gen() {
4447                 // Test vectors from BOLT 3 Appendix D:
4448
4449                 let mut seed = [0; 32];
4450                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4451                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4452                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4453
4454                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4455                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4456                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4457
4458                 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4459                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4460
4461                 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4462                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4463
4464                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4465                 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4466                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4467         }
4468
4469         #[test]
4470         fn test_key_derivation() {
4471                 // Test vectors from BOLT 3 Appendix E:
4472                 let secp_ctx = Secp256k1::new();
4473
4474                 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4475                 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4476
4477                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4478                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4479
4480                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4481                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4482
4483                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4484                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4485
4486                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4487                                 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4488
4489                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4490                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4491
4492                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4493                                 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
4494         }
4495 }