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