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