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