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