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