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