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