1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::{BitcoinHash, Sha256dHash, Hash160};
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
9 use secp256k1::key::{PublicKey,SecretKey};
10 use secp256k1::{Secp256k1,Message,Signature};
13 use crypto::digest::Digest;
16 use ln::msgs::{DecodeError, ErrorAction, HandleError};
17 use ln::channelmonitor::ChannelMonitor;
18 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder};
19 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
21 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
22 use chain::transaction::OutPoint;
23 use chain::keysinterface::{ChannelKeys, KeysInterface};
24 use util::{transaction_utils,rng};
25 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
26 use util::sha2::Sha256;
27 use util::logger::Logger;
28 use util::errors::APIError;
29 use util::config::{UserConfig,ChannelConfig};
32 use std::default::Default;
34 use std::time::Instant;
38 pub struct ChannelValueStat {
39 pub value_to_self_msat: u64,
40 pub channel_value_msat: u64,
41 pub channel_reserve_msat: u64,
42 pub pending_outbound_htlcs_amount_msat: u64,
43 pub pending_inbound_htlcs_amount_msat: u64,
44 pub holding_cell_outbound_amount_msat: u64,
45 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
48 enum InboundHTLCRemovalReason {
49 FailRelay(msgs::OnionErrorPacket),
50 FailMalformed(([u8; 32], u16)),
54 enum InboundHTLCState {
55 /// Added by remote, to be included in next local commitment tx.
56 RemoteAnnounced(PendingHTLCStatus),
57 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
58 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
59 /// accept this HTLC. Implies AwaitingRemoteRevoke.
60 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
61 /// a remote revoke_and_ack on a previous state before we can do so.
62 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
63 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
64 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
65 /// accept this HTLC. Implies AwaitingRemoteRevoke.
66 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
68 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
70 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
71 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
73 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
74 /// commitment transaction without it as otherwise we'll have to force-close the channel to
75 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
76 /// anyway). That said, ChannelMonitor does this for us (see
77 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
78 /// local state before then, once we're sure that the next commitment_signed and
79 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
80 LocalRemoved(InboundHTLCRemovalReason),
83 struct InboundHTLCOutput {
87 payment_hash: [u8; 32],
88 state: InboundHTLCState,
91 enum OutboundHTLCState {
92 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
93 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
94 /// we will promote to Committed (note that they may not accept it until the next time we
95 /// revoke, but we dont really care about that:
96 /// * they've revoked, so worst case we can announce an old state and get our (option on)
97 /// money back (though we wont), and,
98 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
99 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
100 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
101 /// we'll never get out of sync).
102 /// Note that we Box the OnionPacket as its rather large and we don't want to blow up
103 /// OutboundHTLCOutput's size just for a temporary bit
104 LocalAnnounced(Box<msgs::OnionPacket>),
106 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
107 /// the change (though they'll need to revoke before we fail the payment).
109 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
110 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
111 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
112 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
113 /// remote revoke_and_ack on a previous state before we can do so.
114 AwaitingRemoteRevokeToRemove,
115 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
116 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
117 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
118 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
119 /// revoke_and_ack to drop completely.
120 AwaitingRemovedRemoteRevoke,
123 struct OutboundHTLCOutput {
127 payment_hash: [u8; 32],
128 state: OutboundHTLCState,
130 /// If we're in a removed state, set if they failed, otherwise None
131 fail_reason: Option<HTLCFailReason>,
134 macro_rules! get_htlc_in_commitment {
135 ($htlc: expr, $offered: expr) => {
136 HTLCOutputInCommitment {
138 amount_msat: $htlc.amount_msat,
139 cltv_expiry: $htlc.cltv_expiry,
140 payment_hash: $htlc.payment_hash,
141 transaction_output_index: 0
146 /// See AwaitingRemoteRevoke ChannelState for more info
147 enum HTLCUpdateAwaitingACK {
152 payment_hash: [u8; 32],
154 onion_routing_packet: msgs::OnionPacket,
155 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
158 payment_preimage: [u8; 32],
163 err_packet: msgs::OnionErrorPacket,
167 /// There are a few "states" and then a number of flags which can be applied:
168 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
169 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
170 /// move on to ChannelFunded.
171 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
172 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
173 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
175 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
176 OurInitSent = (1 << 0),
177 /// Implies we have received their open_channel/accept_channel message
178 TheirInitSent = (1 << 1),
179 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
180 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
181 /// upon receipt of funding_created, so simply skip this state.
183 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
184 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
185 /// and our counterparty consider the funding transaction confirmed.
187 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
188 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
189 TheirFundingLocked = (1 << 4),
190 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
191 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
192 OurFundingLocked = (1 << 5),
194 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
195 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
197 PeerDisconnected = (1 << 7),
198 /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
199 /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
200 /// messages until they've managed to do so.
201 MonitorUpdateFailed = (1 << 8),
202 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
203 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
204 /// messages as then we will be unable to determine which HTLCs they included in their
205 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
207 /// Flag is set on ChannelFunded.
208 AwaitingRemoteRevoke = (1 << 9),
209 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
210 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
211 /// to respond with our own shutdown message when possible.
212 RemoteShutdownSent = (1 << 10),
213 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
214 /// point, we may not add any new HTLCs to the channel.
215 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
216 /// us their shutdown.
217 LocalShutdownSent = (1 << 11),
218 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
219 /// to drop us, but we store this anyway.
220 ShutdownComplete = 4096,
222 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
223 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
225 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
227 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
228 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
229 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
231 pub(super) struct Channel {
232 config: ChannelConfig,
236 channel_id: [u8; 32],
238 channel_outbound: bool,
239 secp_ctx: Secp256k1<secp256k1::All>,
240 channel_value_satoshis: u64,
242 local_keys: ChannelKeys,
243 shutdown_pubkey: PublicKey,
245 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
246 // generation start at 0 and count up...this simplifies some parts of implementation at the
247 // cost of others, but should really just be changed.
249 cur_local_commitment_transaction_number: u64,
250 cur_remote_commitment_transaction_number: u64,
251 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
252 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
253 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
254 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
255 /// remote revoke when we received the latest commitment update from the remote we have to make
256 /// sure that commitment update gets resent first.
257 received_commitment_while_awaiting_raa: bool,
258 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
259 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
260 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
262 monitor_pending_revoke_and_ack: bool,
263 monitor_pending_commitment_signed: bool,
264 monitor_pending_order: Option<RAACommitmentOrder>,
265 monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
266 monitor_pending_failures: Vec<(HTLCSource, [u8; 32], HTLCFailReason)>,
268 // pending_update_fee is filled when sending and receiving update_fee
269 // For outbound channel, feerate_per_kw is updated with the value from
270 // pending_update_fee when revoke_and_ack is received
272 // For inbound channel, feerate_per_kw is updated when it receives
273 // commitment_signed and revoke_and_ack is generated
274 // The pending value is kept when another pair of update_fee and commitment_signed
275 // is received during AwaitingRemoteRevoke and relieved when the expected
276 // revoke_and_ack is received and new commitment_signed is generated to be
277 // sent to the funder. Otherwise, the pending value is removed when receiving
278 // commitment_signed.
279 pending_update_fee: Option<u64>,
280 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
281 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
282 // is received. holding_cell_update_fee is updated when there are additional
283 // update_fee() during ChannelState::AwaitingRemoteRevoke.
284 holding_cell_update_fee: Option<u64>,
285 next_local_htlc_id: u64,
286 next_remote_htlc_id: u64,
287 channel_update_count: u32,
290 #[cfg(debug_assertions)]
291 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
292 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
293 #[cfg(debug_assertions)]
294 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
295 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
298 // Used in ChannelManager's tests to send a revoked transaction
299 pub last_local_commitment_txn: Vec<Transaction>,
301 last_local_commitment_txn: Vec<Transaction>,
303 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
305 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
306 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
307 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
308 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
309 funding_tx_confirmed_in: Option<Sha256dHash>,
310 short_channel_id: Option<u64>,
311 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
312 /// ChannelManager deserialization (hence pub(super))
313 pub(super) last_block_connected: Sha256dHash,
314 funding_tx_confirmations: u64,
316 their_dust_limit_satoshis: u64,
317 our_dust_limit_satoshis: u64,
318 their_max_htlc_value_in_flight_msat: u64,
319 //get_our_max_htlc_value_in_flight_msat(): u64,
320 /// minimum channel reserve for **self** to maintain - set by them.
321 their_channel_reserve_satoshis: u64,
322 //get_our_channel_reserve_satoshis(): u64,
323 their_htlc_minimum_msat: u64,
324 our_htlc_minimum_msat: u64,
325 their_to_self_delay: u16,
326 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
327 their_max_accepted_htlcs: u16,
328 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
331 their_funding_pubkey: Option<PublicKey>,
332 their_revocation_basepoint: Option<PublicKey>,
333 their_payment_basepoint: Option<PublicKey>,
334 their_delayed_payment_basepoint: Option<PublicKey>,
335 their_htlc_basepoint: Option<PublicKey>,
336 their_cur_commitment_point: Option<PublicKey>,
338 their_prev_commitment_point: Option<PublicKey>,
339 their_node_id: PublicKey,
341 their_shutdown_scriptpubkey: Option<Script>,
343 channel_monitor: ChannelMonitor,
348 const OUR_MAX_HTLCS: u16 = 5; //TODO
349 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
350 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
351 /// really allow for this, so instead we're stuck closing it out at that point.
352 const UNCONF_THRESHOLD: u32 = 6;
353 /// The amount of time we require our counterparty wait to claim their money (ie time between when
354 /// we, or our watchtower, must check for them having broadcast a theft transaction).
355 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
356 /// The amount of time we're willing to wait to claim money back to us
357 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
358 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
359 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
360 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
361 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?)
362 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
364 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
366 /// Used to return a simple Error back to ChannelManager. Will get converted to a
367 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
368 /// channel_id in ChannelManager.
369 pub(super) enum ChannelError {
370 Ignore(&'static str),
374 macro_rules! secp_call {
375 ( $res: expr, $err: expr, $chan_id: expr ) => {
378 Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
383 macro_rules! secp_derived_key {
384 ( $res: expr, $chan_id: expr ) => {
385 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
389 // Convert constants + channel value to limits:
390 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
391 channel_value_satoshis * 1000 / 10 //TODO
394 /// Returns a minimum channel reserve value **they** need to maintain
396 /// Guaranteed to return a value no larger than channel_value_satoshis
397 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
398 let (q, _) = channel_value_satoshis.overflowing_div(100);
399 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
402 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
403 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
406 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
410 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
411 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
413 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
418 pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
419 let chan_keys = keys_provider.get_channel_keys(false);
421 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
422 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
425 if push_msat > channel_value_satoshis * 1000 {
426 return Err(APIError::APIMisuseError{err: "push value > channel value"});
430 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
431 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
432 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
435 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
437 let secp_ctx = Secp256k1::new();
438 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
439 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
440 keys_provider.get_destination_script(), logger.clone());
444 config: config.channel_options.clone(),
446 channel_id: rng::rand_u832(),
447 channel_state: ChannelState::OurInitSent as u32,
448 channel_outbound: true,
450 channel_value_satoshis: channel_value_satoshis,
452 local_keys: chan_keys,
453 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
454 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
455 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
456 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
457 received_commitment_while_awaiting_raa: false,
459 pending_inbound_htlcs: Vec::new(),
460 pending_outbound_htlcs: Vec::new(),
461 holding_cell_htlc_updates: Vec::new(),
462 pending_update_fee: None,
463 holding_cell_update_fee: None,
464 next_local_htlc_id: 0,
465 next_remote_htlc_id: 0,
466 channel_update_count: 1,
468 monitor_pending_revoke_and_ack: false,
469 monitor_pending_commitment_signed: false,
470 monitor_pending_order: None,
471 monitor_pending_forwards: Vec::new(),
472 monitor_pending_failures: Vec::new(),
474 #[cfg(debug_assertions)]
475 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
476 #[cfg(debug_assertions)]
477 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
479 last_local_commitment_txn: Vec::new(),
481 last_sent_closing_fee: None,
483 funding_tx_confirmed_in: None,
484 short_channel_id: None,
485 last_block_connected: Default::default(),
486 funding_tx_confirmations: 0,
488 feerate_per_kw: feerate,
489 their_dust_limit_satoshis: 0,
490 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
491 their_max_htlc_value_in_flight_msat: 0,
492 their_channel_reserve_satoshis: 0,
493 their_htlc_minimum_msat: 0,
494 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
495 their_to_self_delay: 0,
496 their_max_accepted_htlcs: 0,
497 minimum_depth: 0, // Filled in in accept_channel
499 their_funding_pubkey: None,
500 their_revocation_basepoint: None,
501 their_payment_basepoint: None,
502 their_delayed_payment_basepoint: None,
503 their_htlc_basepoint: None,
504 their_cur_commitment_point: None,
506 their_prev_commitment_point: None,
507 their_node_id: their_node_id,
509 their_shutdown_scriptpubkey: None,
511 channel_monitor: channel_monitor,
517 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
518 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
519 return Err(ChannelError::Close("Peer's feerate much too low"));
521 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
522 return Err(ChannelError::Close("Peer's feerate much too high"));
527 /// Creates a new channel from a remote sides' request for one.
528 /// Assumes chain_hash has already been checked and corresponds with what we expect!
529 pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
530 let chan_keys = keys_provider.get_channel_keys(true);
531 let mut local_config = (*config).channel_options.clone();
533 // Check sanity of message fields:
534 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
535 return Err(ChannelError::Close("funding value > 2^24"));
537 if msg.channel_reserve_satoshis > msg.funding_satoshis {
538 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
540 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
541 return Err(ChannelError::Close("push_msat larger than funding value"));
543 if msg.dust_limit_satoshis > msg.funding_satoshis {
544 return Err(ChannelError::Close("Peer never wants payout outputs?"));
546 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
547 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
549 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
550 return Err(ChannelError::Close("Miminum htlc value is full channel value"));
552 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
554 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
555 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
557 if msg.max_accepted_htlcs < 1 {
558 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
560 if msg.max_accepted_htlcs > 483 {
561 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
564 // Now check against optional parameters as set by config...
565 if msg.funding_satoshis < config.channel_limits.min_funding_satoshis {
566 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
568 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
569 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
571 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
572 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
574 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
575 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
577 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
578 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
580 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
581 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
583 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
584 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
587 // Convert things into internal flags and prep our state:
589 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
590 if config.channel_limits.force_announced_channel_preference {
591 if local_config.announced_channel != their_announce {
592 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
595 // we either accept their preference or the preferences match
596 local_config.announced_channel = their_announce;
598 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
600 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
601 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
602 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
603 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
605 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
606 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
608 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
609 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
612 // check if the funder's amount for the initial commitment tx is sufficient
613 // for full fee payment
614 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
615 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
616 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
619 let to_local_msat = msg.push_msat;
620 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
621 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
622 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
625 let secp_ctx = Secp256k1::new();
626 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
627 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
628 keys_provider.get_destination_script(), logger.clone());
629 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
630 channel_monitor.provide_their_next_revocation_point(Some((INITIAL_COMMITMENT_NUMBER, msg.first_per_commitment_point)));
631 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
633 let mut chan = Channel {
635 config: local_config,
637 channel_id: msg.temporary_channel_id,
638 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
639 channel_outbound: false,
642 local_keys: chan_keys,
643 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
644 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
645 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
646 value_to_self_msat: msg.push_msat,
647 received_commitment_while_awaiting_raa: false,
649 pending_inbound_htlcs: Vec::new(),
650 pending_outbound_htlcs: Vec::new(),
651 holding_cell_htlc_updates: Vec::new(),
652 pending_update_fee: None,
653 holding_cell_update_fee: None,
654 next_local_htlc_id: 0,
655 next_remote_htlc_id: 0,
656 channel_update_count: 1,
658 monitor_pending_revoke_and_ack: false,
659 monitor_pending_commitment_signed: false,
660 monitor_pending_order: None,
661 monitor_pending_forwards: Vec::new(),
662 monitor_pending_failures: Vec::new(),
664 #[cfg(debug_assertions)]
665 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
666 #[cfg(debug_assertions)]
667 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
669 last_local_commitment_txn: Vec::new(),
671 last_sent_closing_fee: None,
673 funding_tx_confirmed_in: None,
674 short_channel_id: None,
675 last_block_connected: Default::default(),
676 funding_tx_confirmations: 0,
678 feerate_per_kw: msg.feerate_per_kw as u64,
679 channel_value_satoshis: msg.funding_satoshis,
680 their_dust_limit_satoshis: msg.dust_limit_satoshis,
681 our_dust_limit_satoshis: our_dust_limit_satoshis,
682 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
683 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
684 their_htlc_minimum_msat: msg.htlc_minimum_msat,
685 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
686 their_to_self_delay: msg.to_self_delay,
687 their_max_accepted_htlcs: msg.max_accepted_htlcs,
688 minimum_depth: Channel::derive_minimum_depth(msg.funding_satoshis*1000, msg.push_msat),
690 their_funding_pubkey: Some(msg.funding_pubkey),
691 their_revocation_basepoint: Some(msg.revocation_basepoint),
692 their_payment_basepoint: Some(msg.payment_basepoint),
693 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
694 their_htlc_basepoint: Some(msg.htlc_basepoint),
695 their_cur_commitment_point: Some(msg.first_per_commitment_point),
697 their_prev_commitment_point: None,
698 their_node_id: their_node_id,
700 their_shutdown_scriptpubkey: None,
702 channel_monitor: channel_monitor,
707 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
708 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
713 // Utilities to derive keys:
715 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
716 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
717 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
720 // Utilities to build transactions:
722 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
723 let mut sha = Sha256::new();
724 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
726 if self.channel_outbound {
727 sha.input(&our_payment_basepoint.serialize());
728 sha.input(&self.their_payment_basepoint.unwrap().serialize());
730 sha.input(&self.their_payment_basepoint.unwrap().serialize());
731 sha.input(&our_payment_basepoint.serialize());
733 let mut res = [0; 32];
734 sha.result(&mut res);
736 ((res[26] as u64) << 5*8) |
737 ((res[27] as u64) << 4*8) |
738 ((res[28] as u64) << 3*8) |
739 ((res[29] as u64) << 2*8) |
740 ((res[30] as u64) << 1*8) |
741 ((res[31] as u64) << 0*8)
744 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
745 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
746 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
747 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
748 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
750 /// @local is used only to convert relevant internal structures which refer to remote vs local
751 /// to decide value of outputs and direction of HTLCs.
752 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
753 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
754 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
755 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
756 /// which peer generated this transaction and "to whom" this transaction flows.
758 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>) {
759 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
762 let mut ins: Vec<TxIn> = Vec::new();
764 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
765 script_sig: Script::new(),
766 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
772 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
774 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
775 let mut remote_htlc_total_msat = 0;
776 let mut local_htlc_total_msat = 0;
777 let mut value_to_self_msat_offset = 0;
779 macro_rules! add_htlc_output {
780 ($htlc: expr, $outbound: expr) => {
781 if $outbound == local { // "offered HTLC output"
782 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
783 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
785 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
786 value: $htlc.amount_msat / 1000
787 }, Some(htlc_in_tx)));
790 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
791 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
792 txouts.push((TxOut { // "received HTLC output"
793 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
794 value: $htlc.amount_msat / 1000
795 }, Some(htlc_in_tx)));
801 for ref htlc in self.pending_inbound_htlcs.iter() {
802 let include = match htlc.state {
803 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
804 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
805 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
806 InboundHTLCState::Committed => true,
807 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
811 add_htlc_output!(htlc, false);
812 remote_htlc_total_msat += htlc.amount_msat;
815 &InboundHTLCState::LocalRemoved(ref reason) => {
816 if generated_by_local {
817 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
818 value_to_self_msat_offset += htlc.amount_msat as i64;
827 for ref htlc in self.pending_outbound_htlcs.iter() {
828 let include = match htlc.state {
829 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
830 OutboundHTLCState::Committed => true,
831 OutboundHTLCState::RemoteRemoved => generated_by_local,
832 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
833 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
837 add_htlc_output!(htlc, true);
838 local_htlc_total_msat += htlc.amount_msat;
841 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
842 if htlc.fail_reason.is_none() {
843 value_to_self_msat_offset -= htlc.amount_msat as i64;
846 OutboundHTLCState::RemoteRemoved => {
847 if !generated_by_local && htlc.fail_reason.is_none() {
848 value_to_self_msat_offset -= htlc.amount_msat as i64;
857 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
858 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;
860 #[cfg(debug_assertions)]
862 // Make sure that the to_self/to_remote is always either past the appropriate
863 // channel_reserve *or* it is making progress towards it.
864 // TODO: This should happen after fee calculation, but we don't handle that correctly
866 let mut max_commitment_tx_output = if generated_by_local {
867 self.max_commitment_tx_output_local.lock().unwrap()
869 self.max_commitment_tx_output_remote.lock().unwrap()
871 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);
872 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
873 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);
874 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
877 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
878 let (value_to_self, value_to_remote) = if self.channel_outbound {
879 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
881 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
884 let value_to_a = if local { value_to_self } else { value_to_remote };
885 let value_to_b = if local { value_to_remote } else { value_to_self };
887 if value_to_a >= (dust_limit_satoshis as i64) {
889 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
890 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
891 &keys.a_delayed_payment_key).to_v0_p2wsh(),
892 value: value_to_a as u64
896 if value_to_b >= (dust_limit_satoshis as i64) {
898 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
899 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
901 value: value_to_b as u64
905 transaction_utils::sort_outputs(&mut txouts);
907 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
908 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
909 for (idx, out) in txouts.drain(..).enumerate() {
911 if let Some(out_htlc) = out.1 {
912 htlcs_used.push(out_htlc);
913 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
919 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
926 fn get_closing_scriptpubkey(&self) -> Script {
927 let our_channel_close_key_hash = Hash160::from_data(&self.shutdown_pubkey.serialize());
928 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
932 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
933 (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)
937 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
939 let mut ins: Vec<TxIn> = Vec::new();
941 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
942 script_sig: Script::new(),
943 sequence: 0xffffffff,
949 assert!(self.pending_inbound_htlcs.is_empty());
950 assert!(self.pending_outbound_htlcs.is_empty());
951 let mut txouts: Vec<(TxOut, ())> = Vec::new();
953 let mut total_fee_satoshis = proposed_total_fee_satoshis;
954 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
955 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 };
957 if value_to_self < 0 {
958 assert!(self.channel_outbound);
959 total_fee_satoshis += (-value_to_self) as u64;
960 } else if value_to_remote < 0 {
961 assert!(!self.channel_outbound);
962 total_fee_satoshis += (-value_to_remote) as u64;
965 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
967 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
968 value: value_to_remote as u64
972 if value_to_self as u64 > self.our_dust_limit_satoshis {
974 script_pubkey: self.get_closing_scriptpubkey(),
975 value: value_to_self as u64
979 transaction_utils::sort_outputs(&mut txouts);
981 let mut outputs: Vec<TxOut> = Vec::new();
982 for out in txouts.drain(..) {
991 }, total_fee_satoshis)
995 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
996 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
997 /// our counterparty!)
998 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
999 /// TODO Some magic rust shit to compile-time check this?
1000 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
1001 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1002 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1003 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1005 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()))
1009 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1010 /// will sign and send to our counterparty.
1011 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
1012 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1013 //may see payments to it!
1014 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1015 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1016 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1018 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), self.channel_id()))
1021 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1022 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1023 /// Panics if called before accept_channel/new_from_req
1024 pub fn get_funding_redeemscript(&self) -> Script {
1025 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1026 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1027 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1028 if our_funding_key[..] < their_funding_key[..] {
1029 builder.push_slice(&our_funding_key)
1030 .push_slice(&their_funding_key)
1032 builder.push_slice(&their_funding_key)
1033 .push_slice(&our_funding_key)
1034 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1037 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1038 if tx.input.len() != 1 {
1039 panic!("Tried to sign commitment transaction that had input count != 1!");
1041 if tx.input[0].witness.len() != 0 {
1042 panic!("Tried to re-sign commitment transaction");
1045 let funding_redeemscript = self.get_funding_redeemscript();
1047 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1048 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1050 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1052 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1053 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1054 if our_funding_key[..] < their_funding_key[..] {
1055 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1056 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1058 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1059 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1061 tx.input[0].witness[1].push(SigHashType::All as u8);
1062 tx.input[0].witness[2].push(SigHashType::All as u8);
1064 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1069 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1070 /// @local is used only to convert relevant internal structures which refer to remote vs local
1071 /// to decide value of outputs and direction of HTLCs.
1072 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1073 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1076 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
1077 if tx.input.len() != 1 {
1078 panic!("Tried to sign HTLC transaction that had input count != 1!");
1081 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1083 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());
1084 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1085 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1086 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1089 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1090 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1091 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1092 if tx.input.len() != 1 {
1093 panic!("Tried to sign HTLC transaction that had input count != 1!");
1095 if tx.input[0].witness.len() != 0 {
1096 panic!("Tried to re-sign HTLC transaction");
1099 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1101 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1103 if local_tx { // b, then a
1104 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1105 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1107 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1108 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1110 tx.input[0].witness[1].push(SigHashType::All as u8);
1111 tx.input[0].witness[2].push(SigHashType::All as u8);
1114 tx.input[0].witness.push(Vec::new());
1116 tx.input[0].witness.push(preimage.unwrap().to_vec());
1119 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1124 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1125 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1126 /// Ok(_) if debug assertions are turned on and preconditions are met.
1127 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1128 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1129 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1130 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1132 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1133 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1135 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1137 let mut sha = Sha256::new();
1138 sha.input(&payment_preimage_arg);
1139 let mut payment_hash_calc = [0; 32];
1140 sha.result(&mut payment_hash_calc);
1142 let mut pending_idx = std::usize::MAX;
1143 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1144 if htlc.htlc_id == htlc_id_arg {
1145 assert_eq!(htlc.payment_hash, payment_hash_calc);
1146 if let InboundHTLCState::Committed = htlc.state {
1148 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1149 // Don't return in release mode here so that we can update channel_monitor
1155 if pending_idx == std::usize::MAX {
1156 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1157 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1160 // Now update local state:
1162 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1163 // can claim it even if the channel hits the chain before we see their next commitment.
1164 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1166 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1167 for pending_update in self.holding_cell_htlc_updates.iter() {
1168 match pending_update {
1169 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1170 if htlc_id_arg == htlc_id {
1171 debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1172 return Ok((None, None));
1175 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1176 if htlc_id_arg == htlc_id {
1177 debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1178 // Return the new channel monitor in a last-ditch effort to hit the
1179 // chain and claim the funds
1180 return Ok((None, Some(self.channel_monitor.clone())));
1186 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1187 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1189 return Ok((None, Some(self.channel_monitor.clone())));
1193 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1194 if let InboundHTLCState::Committed = htlc.state {
1196 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1197 return Ok((None, Some(self.channel_monitor.clone())));
1199 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1202 Ok((Some(msgs::UpdateFulfillHTLC {
1203 channel_id: self.channel_id(),
1204 htlc_id: htlc_id_arg,
1205 payment_preimage: payment_preimage_arg,
1206 }), Some(self.channel_monitor.clone())))
1209 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> {
1210 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1211 (Some(update_fulfill_htlc), _) => {
1212 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1213 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1215 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1216 (None, None) => Ok((None, None))
1220 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1221 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1222 /// Ok(_) if debug assertions are turned on and preconditions are met.
1223 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1224 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1225 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1227 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1229 let mut pending_idx = std::usize::MAX;
1230 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1231 if htlc.htlc_id == htlc_id_arg {
1232 if let InboundHTLCState::Committed = htlc.state {
1234 debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1235 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1240 if pending_idx == std::usize::MAX {
1241 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1242 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1245 // Now update local state:
1246 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1247 for pending_update in self.holding_cell_htlc_updates.iter() {
1248 match pending_update {
1249 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1250 if htlc_id_arg == htlc_id {
1251 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1252 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1255 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1256 if htlc_id_arg == htlc_id {
1257 debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1264 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1265 htlc_id: htlc_id_arg,
1272 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1273 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1276 Ok(Some(msgs::UpdateFailHTLC {
1277 channel_id: self.channel_id(),
1278 htlc_id: htlc_id_arg,
1283 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> {
1284 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1285 Some(update_fail_htlc) => {
1286 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1287 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1293 // Message handlers:
1295 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig) -> Result<(), ChannelError> {
1296 // Check sanity of message fields:
1297 if !self.channel_outbound {
1298 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1300 if self.channel_state != ChannelState::OurInitSent as u32 {
1301 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1303 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1304 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1306 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1307 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1309 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1310 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1312 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1313 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1315 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1316 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1318 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1319 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1321 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1322 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1324 if msg.max_accepted_htlcs < 1 {
1325 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1327 if msg.max_accepted_htlcs > 483 {
1328 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1331 // Now check against optional parameters as set by config...
1332 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
1333 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1335 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
1336 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1338 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
1339 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1341 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
1342 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1344 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
1345 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1347 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
1348 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1350 if msg.minimum_depth > config.channel_limits.max_minimum_depth {
1351 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1354 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1355 self.channel_monitor.provide_their_next_revocation_point(Some((INITIAL_COMMITMENT_NUMBER, msg.first_per_commitment_point)));
1357 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1358 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1359 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1360 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1361 self.their_to_self_delay = msg.to_self_delay;
1362 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1363 self.minimum_depth = msg.minimum_depth;
1364 self.their_funding_pubkey = Some(msg.funding_pubkey);
1365 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1366 self.their_payment_basepoint = Some(msg.payment_basepoint);
1367 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1368 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1369 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1371 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1372 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1373 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1375 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1380 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), HandleError> {
1381 let funding_script = self.get_funding_redeemscript();
1383 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1384 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;
1385 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();
1387 // They sign the "local" commitment transaction...
1388 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1390 // ...and we sign it, allowing us to broadcast the tx if we wish
1391 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1393 let remote_keys = self.build_remote_transaction_keys()?;
1394 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1395 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();
1397 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1398 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1401 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1402 if self.channel_outbound {
1403 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()}})});
1405 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1406 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1407 // remember the channel, so its safe to just send an error_message here and drop the
1409 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()}})});
1411 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1412 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1413 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1414 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1417 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1418 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1419 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1421 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1424 self.channel_monitor.unset_funding_info();
1429 // Now that we're past error-generating stuff, update our local state:
1431 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1432 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1433 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new());
1434 self.channel_state = ChannelState::FundingSent as u32;
1435 self.channel_id = funding_txo.to_channel_id();
1436 self.cur_remote_commitment_transaction_number -= 1;
1437 self.cur_local_commitment_transaction_number -= 1;
1439 Ok((msgs::FundingSigned {
1440 channel_id: self.channel_id,
1441 signature: our_signature
1442 }, self.channel_monitor.clone()))
1445 /// Handles a funding_signed message from the remote end.
1446 /// If this call is successful, broadcast the funding transaction (and not before!)
1447 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1448 if !self.channel_outbound {
1449 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1451 if self.channel_state != ChannelState::FundingCreated as u32 {
1452 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1454 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1455 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1456 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1457 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1460 let funding_script = self.get_funding_redeemscript();
1462 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1463 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;
1464 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();
1466 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1467 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1469 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1470 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1471 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1472 self.channel_state = ChannelState::FundingSent as u32;
1473 self.cur_local_commitment_transaction_number -= 1;
1475 Ok(self.channel_monitor.clone())
1478 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1479 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1480 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1483 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1485 if non_shutdown_state == ChannelState::FundingSent as u32 {
1486 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1487 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1488 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1489 self.channel_update_count += 1;
1490 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1491 // Note that funding_signed/funding_created will have decremented both by 1!
1492 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1493 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1494 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1495 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1497 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1500 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1503 self.channel_monitor.provide_their_next_revocation_point(Some((INITIAL_COMMITMENT_NUMBER - 1 , msg.next_per_commitment_point)));
1504 self.their_prev_commitment_point = self.their_cur_commitment_point;
1505 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1509 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1510 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1511 let mut htlc_inbound_value_msat = 0;
1512 for ref htlc in self.pending_inbound_htlcs.iter() {
1513 htlc_inbound_value_msat += htlc.amount_msat;
1515 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1518 /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1519 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1520 let mut htlc_outbound_value_msat = 0;
1521 for ref htlc in self.pending_outbound_htlcs.iter() {
1522 htlc_outbound_value_msat += htlc.amount_msat;
1525 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1528 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1529 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1530 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1532 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1533 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}})});
1535 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1536 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1538 if msg.amount_msat < self.our_htlc_minimum_msat {
1539 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1542 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1543 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1544 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1546 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1547 // Check our_max_htlc_value_in_flight_msat
1548 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1549 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1551 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1552 // the reserve_satoshis we told them to always have as direct payment so that they lose
1553 // something if we punish them for broadcasting an old state).
1554 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 {
1555 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1557 if self.next_remote_htlc_id != msg.htlc_id {
1558 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1560 if msg.cltv_expiry >= 500000000 {
1561 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1564 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1566 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1567 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1568 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1572 // Now update local state:
1573 self.next_remote_htlc_id += 1;
1574 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1575 htlc_id: msg.htlc_id,
1576 amount_msat: msg.amount_msat,
1577 payment_hash: msg.payment_hash,
1578 cltv_expiry: msg.cltv_expiry,
1579 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1585 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1587 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1588 for htlc in self.pending_outbound_htlcs.iter_mut() {
1589 if htlc.htlc_id == htlc_id {
1590 match check_preimage {
1592 Some(payment_hash) =>
1593 if payment_hash != htlc.payment_hash {
1594 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1598 OutboundHTLCState::LocalAnnounced(_) =>
1599 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1600 OutboundHTLCState::Committed => {
1601 htlc.state = OutboundHTLCState::RemoteRemoved;
1602 htlc.fail_reason = fail_reason;
1604 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1605 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1607 return Ok(&htlc.source);
1610 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1613 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, ChannelError> {
1614 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1615 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1617 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1618 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1621 let mut sha = Sha256::new();
1622 sha.input(&msg.payment_preimage);
1623 let mut payment_hash = [0; 32];
1624 sha.result(&mut payment_hash);
1626 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1629 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1630 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1631 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1633 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1634 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1637 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1640 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1641 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1642 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1644 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1645 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1648 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1651 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), HandleError> {
1652 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1653 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1655 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1656 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}})});
1658 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1659 return Err(HandleError{err: "Peer sent commitment_signed after we'd started exchanging closing_signeds", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent commitment_signed after we'd started exchanging closing_signeds".to_string(), channel_id: msg.channel_id}})});
1662 let funding_script = self.get_funding_redeemscript();
1664 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1666 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1667 self.pending_update_fee.unwrap()
1672 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1673 let local_commitment_txid = local_commitment_tx.0.txid();
1674 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();
1675 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1677 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1678 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1681 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1682 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1683 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1685 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1686 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1687 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
1688 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1689 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1690 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());
1691 let htlc_sig = if htlc.offered {
1692 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1693 new_local_commitment_txn.push(htlc_tx);
1696 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1698 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1701 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1702 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1704 // Update state now that we've passed all the can-fail calls...
1705 let mut need_our_commitment = false;
1706 if !self.channel_outbound {
1707 if let Some(fee_update) = self.pending_update_fee {
1708 self.feerate_per_kw = fee_update;
1709 // We later use the presence of pending_update_fee to indicate we should generate a
1710 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1711 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1712 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1713 need_our_commitment = true;
1714 self.pending_update_fee = None;
1718 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1719 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1720 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1721 self.monitor_pending_order = None;
1724 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1726 for htlc in self.pending_inbound_htlcs.iter_mut() {
1727 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1728 Some(forward_info.clone())
1730 if let Some(forward_info) = new_forward {
1731 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1732 need_our_commitment = true;
1735 for htlc in self.pending_outbound_htlcs.iter_mut() {
1736 if let OutboundHTLCState::RemoteRemoved = htlc.state {
1737 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1738 need_our_commitment = true;
1742 self.cur_local_commitment_transaction_number -= 1;
1743 self.last_local_commitment_txn = new_local_commitment_txn;
1744 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1746 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1747 self.monitor_pending_revoke_and_ack = true;
1748 self.monitor_pending_commitment_signed |= need_our_commitment;
1749 return Err(HandleError{err: "Previous monitor update failure prevented generation of RAA", action: Some(ErrorAction::IgnoreError)});
1752 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1753 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1754 // we'll send one right away when we get the revoke_and_ack when we
1755 // free_holding_cell_htlcs().
1756 let (msg, monitor) = self.send_commitment_no_status_check()?;
1757 (Some(msg), monitor, None)
1758 } else if !need_our_commitment {
1759 (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1760 } else { (None, self.channel_monitor.clone(), None) };
1762 Ok((msgs::RevokeAndACK {
1763 channel_id: self.channel_id,
1764 per_commitment_secret: per_commitment_secret,
1765 next_per_commitment_point: next_per_commitment_point,
1766 }, our_commitment_signed, closing_signed, monitor_update))
1769 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1770 /// fulfilling or failing the last pending HTLC)
1771 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1772 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1773 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1774 let mut htlc_updates = Vec::new();
1775 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1776 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1777 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1778 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1780 for htlc_update in htlc_updates.drain(..) {
1781 // Note that this *can* fail, though it should be due to rather-rare conditions on
1782 // fee races with adding too many outputs which push our total payments just over
1783 // the limit. In case its less rare than I anticipate, we may want to revisit
1784 // handling this case better and maybe fufilling some of the HTLCs while attempting
1785 // to rebalance channels.
1786 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1787 self.holding_cell_htlc_updates.push(htlc_update);
1789 match &htlc_update {
1790 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1791 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1792 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1798 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1799 match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1800 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1802 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1804 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1809 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1810 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1811 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1813 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1815 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1822 self.holding_cell_htlc_updates.push(htlc_update);
1826 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1827 //fail it back the route, if its a temporary issue we can ignore it...
1830 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1831 // This should never actually happen and indicates we got some Errs back
1832 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1833 // case there is some strange way to hit duplicate HTLC removes.
1836 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1837 self.pending_update_fee = self.holding_cell_update_fee.take();
1838 Some(msgs::UpdateFee {
1839 channel_id: self.channel_id,
1840 feerate_per_kw: feerate as u32,
1845 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1846 Ok(Some((msgs::CommitmentUpdate {
1848 update_fulfill_htlcs,
1850 update_fail_malformed_htlcs: Vec::new(),
1851 update_fee: update_fee,
1853 }, monitor_update)))
1862 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1863 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1864 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1865 /// generating an appropriate error *after* the channel state has been updated based on the
1866 /// revoke_and_ack message.
1867 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), HandleError> {
1868 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1869 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1871 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1872 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}})});
1874 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1875 return Err(HandleError{err: "Peer sent revoke_and_ack after we'd started exchanging closing_signeds", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_string(), channel_id: msg.channel_id}})});
1878 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1879 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 {
1880 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1883 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)?;
1884 self.channel_monitor.provide_their_next_revocation_point(Some((self.cur_remote_commitment_transaction_number - 1, msg.next_per_commitment_point)));
1886 // Update state now that we've passed all the can-fail calls...
1887 // (note that we may still fail to generate the new commitment_signed message, but that's
1888 // OK, we step the channel here and *then* if the new generation fails we can fail the
1889 // channel based on that, but stepping stuff here should be safe either way.
1890 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1891 self.their_prev_commitment_point = self.their_cur_commitment_point;
1892 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1893 self.cur_remote_commitment_transaction_number -= 1;
1894 self.received_commitment_while_awaiting_raa = false;
1895 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1896 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1897 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1898 self.monitor_pending_order = None;
1901 let mut to_forward_infos = Vec::new();
1902 let mut revoked_htlcs = Vec::new();
1903 let mut update_fail_htlcs = Vec::new();
1904 let mut update_fail_malformed_htlcs = Vec::new();
1905 let mut require_commitment = false;
1906 let mut value_to_self_msat_diff: i64 = 0;
1907 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1908 self.pending_inbound_htlcs.retain(|htlc| {
1909 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1910 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1911 value_to_self_msat_diff += htlc.amount_msat as i64;
1916 self.pending_outbound_htlcs.retain(|htlc| {
1917 if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1918 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1919 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1921 // They fulfilled, so we sent them money
1922 value_to_self_msat_diff -= htlc.amount_msat as i64;
1927 for htlc in self.pending_inbound_htlcs.iter_mut() {
1928 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1930 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1934 let mut state = InboundHTLCState::Committed;
1935 mem::swap(&mut state, &mut htlc.state);
1937 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1938 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1939 require_commitment = true;
1940 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1941 match forward_info {
1942 PendingHTLCStatus::Fail(fail_msg) => {
1943 require_commitment = true;
1945 HTLCFailureMsg::Relay(msg) => {
1946 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1947 update_fail_htlcs.push(msg)
1949 HTLCFailureMsg::Malformed(msg) => {
1950 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
1951 update_fail_malformed_htlcs.push(msg)
1955 PendingHTLCStatus::Forward(forward_info) => {
1956 to_forward_infos.push((forward_info, htlc.htlc_id));
1957 htlc.state = InboundHTLCState::Committed;
1963 for htlc in self.pending_outbound_htlcs.iter_mut() {
1964 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
1965 htlc.state = OutboundHTLCState::Committed;
1966 } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
1967 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1968 require_commitment = true;
1971 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1973 if self.channel_outbound {
1974 if let Some(feerate) = self.pending_update_fee.take() {
1975 self.feerate_per_kw = feerate;
1978 if let Some(feerate) = self.pending_update_fee {
1979 // Because a node cannot send two commitment_signed's in a row without getting a
1980 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
1981 // it should use to create keys with) and because a node can't send a
1982 // commitment_signed without changes, checking if the feerate is equal to the
1983 // pending feerate update is sufficient to detect require_commitment.
1984 if feerate == self.feerate_per_kw {
1985 require_commitment = true;
1986 self.pending_update_fee = None;
1991 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
1992 // We can't actually generate a new commitment transaction (incl by freeing holding
1993 // cells) while we can't update the monitor, so we just return what we have.
1994 if require_commitment {
1995 self.monitor_pending_commitment_signed = true;
1997 self.monitor_pending_forwards.append(&mut to_forward_infos);
1998 self.monitor_pending_failures.append(&mut revoked_htlcs);
1999 return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2002 match self.free_holding_cell_htlcs()? {
2003 Some(mut commitment_update) => {
2004 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2005 for fail_msg in update_fail_htlcs.drain(..) {
2006 commitment_update.0.update_fail_htlcs.push(fail_msg);
2008 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2009 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2010 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2012 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2015 if require_commitment {
2016 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2017 Ok((Some(msgs::CommitmentUpdate {
2018 update_add_htlcs: Vec::new(),
2019 update_fulfill_htlcs: Vec::new(),
2021 update_fail_malformed_htlcs,
2024 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2026 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2033 /// Adds a pending update to this channel. See the doc for send_htlc for
2034 /// further details on the optionness of the return value.
2035 /// You MUST call send_commitment prior to any other calls on this Channel
2036 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2037 if !self.channel_outbound {
2038 panic!("Cannot send fee from inbound channel");
2040 if !self.is_usable() {
2041 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2043 if !self.is_live() {
2044 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2047 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2048 self.holding_cell_update_fee = Some(feerate_per_kw);
2052 debug_assert!(self.pending_update_fee.is_none());
2053 self.pending_update_fee = Some(feerate_per_kw);
2055 Some(msgs::UpdateFee {
2056 channel_id: self.channel_id,
2057 feerate_per_kw: feerate_per_kw as u32,
2061 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
2062 match self.send_update_fee(feerate_per_kw) {
2063 Some(update_fee) => {
2064 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2065 Ok(Some((update_fee, commitment_signed, monitor_update)))
2071 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2072 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2073 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2074 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2075 /// No further message handling calls may be made until a channel_reestablish dance has
2077 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
2078 let mut outbound_drops = Vec::new();
2080 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2081 if self.channel_state < ChannelState::FundingSent as u32 {
2082 self.channel_state = ChannelState::ShutdownComplete as u32;
2083 return outbound_drops;
2085 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2086 // will be retransmitted.
2087 self.last_sent_closing_fee = None;
2089 let mut inbound_drop_count = 0;
2090 self.pending_inbound_htlcs.retain(|htlc| {
2092 InboundHTLCState::RemoteAnnounced(_) => {
2093 // They sent us an update_add_htlc but we never got the commitment_signed.
2094 // We'll tell them what commitment_signed we're expecting next and they'll drop
2095 // this HTLC accordingly
2096 inbound_drop_count += 1;
2099 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2100 // We received a commitment_signed updating this HTLC and (at least hopefully)
2101 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2102 // in response to it yet, so don't touch it.
2105 InboundHTLCState::Committed => true,
2106 InboundHTLCState::LocalRemoved(_) => {
2107 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2108 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2109 // (that we missed). Keep this around for now and if they tell us they missed
2110 // the commitment_signed we can re-transmit the update then.
2115 self.next_remote_htlc_id -= inbound_drop_count;
2117 for htlc in self.pending_outbound_htlcs.iter_mut() {
2118 if let OutboundHTLCState::RemoteRemoved = htlc.state {
2119 // They sent us an update to remove this but haven't yet sent the corresponding
2120 // commitment_signed, we need to move it back to Committed and they can re-send
2121 // the update upon reconnection.
2122 htlc.state = OutboundHTLCState::Committed;
2126 self.holding_cell_htlc_updates.retain(|htlc_update| {
2128 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2129 outbound_drops.push((source.clone(), payment_hash.clone()));
2132 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2135 self.channel_state |= ChannelState::PeerDisconnected as u32;
2136 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2140 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2141 /// updates are partially paused.
2142 /// This must be called immediately after the call which generated the ChannelMonitor update
2143 /// which failed, with the order argument set to the type of call it represented (ie a
2144 /// commitment update or a revoke_and_ack generation). The messages which were generated from
2145 /// that original call must *not* have been sent to the remote end, and must instead have been
2146 /// dropped. They will be regenerated when monitor_updating_restored is called.
2147 pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder) {
2148 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2150 RAACommitmentOrder::CommitmentFirst => {
2151 self.monitor_pending_revoke_and_ack = false;
2152 self.monitor_pending_commitment_signed = true;
2154 RAACommitmentOrder::RevokeAndACKFirst => {
2155 self.monitor_pending_revoke_and_ack = true;
2156 self.monitor_pending_commitment_signed = false;
2159 self.monitor_pending_order = Some(order);
2160 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2163 /// Indicates that the latest ChannelMonitor update has been committed by the client
2164 /// successfully and we should restore normal operation. Returns messages which should be sent
2165 /// to the remote side.
2166 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>) {
2167 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2168 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2170 let mut forwards = Vec::new();
2171 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2172 let mut failures = Vec::new();
2173 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2175 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2176 // Leave monitor_pending_order so we can order our channel_reestablish responses
2177 self.monitor_pending_revoke_and_ack = false;
2178 self.monitor_pending_commitment_signed = false;
2179 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2182 let raa = if self.monitor_pending_revoke_and_ack {
2183 Some(self.get_last_revoke_and_ack())
2185 let commitment_update = if self.monitor_pending_commitment_signed {
2186 Some(self.get_last_commitment_update())
2189 self.monitor_pending_revoke_and_ack = false;
2190 self.monitor_pending_commitment_signed = false;
2191 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2194 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2195 if self.channel_outbound {
2196 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2198 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2199 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2201 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2203 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2204 self.channel_update_count += 1;
2208 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2209 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2210 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2211 msgs::RevokeAndACK {
2212 channel_id: self.channel_id,
2213 per_commitment_secret,
2214 next_per_commitment_point,
2218 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2219 let mut update_add_htlcs = Vec::new();
2220 let mut update_fulfill_htlcs = Vec::new();
2221 let mut update_fail_htlcs = Vec::new();
2222 let mut update_fail_malformed_htlcs = Vec::new();
2224 for htlc in self.pending_outbound_htlcs.iter() {
2225 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2226 update_add_htlcs.push(msgs::UpdateAddHTLC {
2227 channel_id: self.channel_id(),
2228 htlc_id: htlc.htlc_id,
2229 amount_msat: htlc.amount_msat,
2230 payment_hash: htlc.payment_hash,
2231 cltv_expiry: htlc.cltv_expiry,
2232 onion_routing_packet: (**onion_packet).clone(),
2237 for htlc in self.pending_inbound_htlcs.iter() {
2238 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2240 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2241 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2242 channel_id: self.channel_id(),
2243 htlc_id: htlc.htlc_id,
2244 reason: err_packet.clone()
2247 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2248 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2249 channel_id: self.channel_id(),
2250 htlc_id: htlc.htlc_id,
2251 sha256_of_onion: sha256_of_onion.clone(),
2252 failure_code: failure_code.clone(),
2255 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2256 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2257 channel_id: self.channel_id(),
2258 htlc_id: htlc.htlc_id,
2259 payment_preimage: payment_preimage.clone(),
2266 msgs::CommitmentUpdate {
2267 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2268 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2269 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,
2273 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2274 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2275 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2276 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2277 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2278 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2279 // just close here instead of trying to recover.
2280 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2283 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
2284 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2287 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2288 // remaining cases either succeed or ErrorMessage-fail).
2289 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2291 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2292 Some(msgs::Shutdown {
2293 channel_id: self.channel_id,
2294 scriptpubkey: self.get_closing_scriptpubkey(),
2298 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) == ChannelState::FundingSent as u32 {
2299 // Short circuit the whole handler as there is nothing we can resend them
2300 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2303 if msg.next_local_commitment_number == 0 || msg.next_remote_commitment_number == 0 {
2304 if self.channel_state & (ChannelState::FundingSent as u32) != ChannelState::FundingSent as u32 {
2305 return Err(ChannelError::Close("Peer sent a pre-funding channel_reestablish after we exchanged funding_locked"));
2307 // We have OurFundingLocked set!
2308 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2309 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2310 return Ok((Some(msgs::FundingLocked {
2311 channel_id: self.channel_id(),
2312 next_per_commitment_point: next_per_commitment_point,
2313 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2316 let required_revoke = if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2317 // Remote isn't waiting on any RevokeAndACK from us!
2318 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2320 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2321 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2322 self.monitor_pending_revoke_and_ack = true;
2325 Some(self.get_last_revoke_and_ack())
2328 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2331 // We increment cur_remote_commitment_transaction_number only upon receipt of
2332 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2333 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2334 // the corresponding revoke_and_ack back yet.
2335 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 };
2337 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2338 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2339 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2340 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2341 Some(msgs::FundingLocked {
2342 channel_id: self.channel_id(),
2343 next_per_commitment_point: next_per_commitment_point,
2347 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2348 RAACommitmentOrder::CommitmentFirst
2350 RAACommitmentOrder::RevokeAndACKFirst
2353 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2354 if required_revoke.is_some() {
2355 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2357 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2360 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2361 self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2362 // We're up-to-date and not waiting on a remote revoke (if we are our
2363 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2364 // have received some updates while we were disconnected. Free the holding cell
2366 match self.free_holding_cell_htlcs() {
2368 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
2369 return Err(ChannelError::Close(e.err));
2370 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
2371 return Err(ChannelError::Close(e.err));
2373 panic!("Got non-channel-failing result from free_holding_cell_htlcs");
2376 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order, shutdown_msg)),
2377 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg)),
2380 return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg));
2382 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2383 if required_revoke.is_some() {
2384 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2386 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2389 // If monitor_pending_order is set, it must be CommitmentSigned if we have no RAA
2390 debug_assert!(self.monitor_pending_order != Some(RAACommitmentOrder::RevokeAndACKFirst) || required_revoke.is_some());
2392 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2393 self.monitor_pending_commitment_signed = true;
2394 return Ok((resend_funding_locked, None, None, None, order, shutdown_msg));
2397 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order, shutdown_msg));
2399 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2403 fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2404 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2405 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2406 self.last_sent_closing_fee.is_some() ||
2407 self.cur_remote_commitment_transaction_number != self.cur_local_commitment_transaction_number{
2411 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2412 if self.feerate_per_kw > proposed_feerate {
2413 proposed_feerate = self.feerate_per_kw;
2415 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2416 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2418 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2419 let funding_redeemscript = self.get_funding_redeemscript();
2420 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2422 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2423 Some(msgs::ClosingSigned {
2424 channel_id: self.channel_id,
2425 fee_satoshis: total_fee_satoshis,
2426 signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2430 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), ChannelError> {
2431 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2432 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2434 if self.channel_state < ChannelState::FundingSent as u32 {
2435 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2436 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2437 // can do that via error message without getting a connection fail anyway...
2438 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2440 for htlc in self.pending_inbound_htlcs.iter() {
2441 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2442 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2445 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2447 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2448 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2449 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2450 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2453 //Check shutdown_scriptpubkey form as BOLT says we must
2454 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2455 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2458 if self.their_shutdown_scriptpubkey.is_some() {
2459 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2460 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2463 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2466 // From here on out, we may not fail!
2468 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2469 self.channel_update_count += 1;
2471 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2472 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2473 // cell HTLCs and return them to fail the payment.
2474 self.holding_cell_update_fee = None;
2475 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2476 self.holding_cell_htlc_updates.retain(|htlc_update| {
2478 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2479 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2485 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2486 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2487 // any further commitment updates after we set LocalShutdownSent.
2489 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2492 Some(msgs::Shutdown {
2493 channel_id: self.channel_id,
2494 scriptpubkey: self.get_closing_scriptpubkey(),
2498 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2499 self.channel_update_count += 1;
2500 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2503 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2504 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2505 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2507 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2508 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}})});
2510 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2511 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2513 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2514 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2517 let funding_redeemscript = self.get_funding_redeemscript();
2518 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2519 if used_total_fee != msg.fee_satoshis {
2520 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2522 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2524 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2527 // The remote end may have decided to revoke their output due to inconsistent dust
2528 // limits, so check for that case by re-checking the signature here.
2529 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2530 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2531 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2535 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2536 if last_fee == msg.fee_satoshis {
2537 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2538 self.channel_state = ChannelState::ShutdownComplete as u32;
2539 self.channel_update_count += 1;
2540 return Ok((None, Some(closing_tx)));
2544 macro_rules! propose_new_feerate {
2545 ($new_feerate: expr) => {
2546 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2547 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2548 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2549 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2550 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2551 return Ok((Some(msgs::ClosingSigned {
2552 channel_id: self.channel_id,
2553 fee_satoshis: used_total_fee,
2559 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2560 if self.channel_outbound {
2561 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2562 if proposed_sat_per_kw > our_max_feerate {
2563 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2564 if our_max_feerate <= last_feerate {
2565 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2568 propose_new_feerate!(our_max_feerate);
2571 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2572 if proposed_sat_per_kw < our_min_feerate {
2573 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2574 if our_min_feerate >= last_feerate {
2575 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2578 propose_new_feerate!(our_min_feerate);
2582 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2583 self.channel_state = ChannelState::ShutdownComplete as u32;
2584 self.channel_update_count += 1;
2586 Ok((Some(msgs::ClosingSigned {
2587 channel_id: self.channel_id,
2588 fee_satoshis: msg.fee_satoshis,
2590 }), Some(closing_tx)))
2593 // Public utilities:
2595 pub fn channel_id(&self) -> [u8; 32] {
2599 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2600 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2601 pub fn get_user_id(&self) -> u64 {
2605 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2606 pub fn channel_monitor(&self) -> ChannelMonitor {
2607 if self.channel_state < ChannelState::FundingCreated as u32 {
2608 panic!("Can't get a channel monitor until funding has been created");
2610 self.channel_monitor.clone()
2613 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2614 /// is_usable() returns true).
2615 /// Allowed in any state (including after shutdown)
2616 pub fn get_short_channel_id(&self) -> Option<u64> {
2617 self.short_channel_id
2620 /// Returns the funding_txo we either got from our peer, or were given by
2621 /// get_outbound_funding_created.
2622 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2623 self.channel_monitor.get_funding_txo()
2626 /// Allowed in any state (including after shutdown)
2627 pub fn get_their_node_id(&self) -> PublicKey {
2631 /// Allowed in any state (including after shutdown)
2632 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2633 self.our_htlc_minimum_msat
2636 /// Allowed in any state (including after shutdown)
2637 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2638 self.our_htlc_minimum_msat
2641 pub fn get_value_satoshis(&self) -> u64 {
2642 self.channel_value_satoshis
2645 pub fn get_fee_proportional_millionths(&self) -> u32 {
2646 self.config.fee_proportional_millionths
2650 pub fn get_feerate(&self) -> u64 {
2654 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2655 self.cur_local_commitment_transaction_number + 1
2658 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2659 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2662 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2663 self.cur_remote_commitment_transaction_number + 2
2666 //TODO: Testing purpose only, should be changed in another way after #81
2668 pub fn get_local_keys(&self) -> &ChannelKeys {
2673 pub fn get_value_stat(&self) -> ChannelValueStat {
2675 value_to_self_msat: self.value_to_self_msat,
2676 channel_value_msat: self.channel_value_satoshis * 1000,
2677 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2678 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2679 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2680 holding_cell_outbound_amount_msat: {
2682 for h in self.holding_cell_htlc_updates.iter() {
2684 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2692 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2696 /// Allowed in any state (including after shutdown)
2697 pub fn get_channel_update_count(&self) -> u32 {
2698 self.channel_update_count
2701 pub fn should_announce(&self) -> bool {
2702 self.config.announced_channel
2705 pub fn is_outbound(&self) -> bool {
2706 self.channel_outbound
2709 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2710 /// Allowed in any state (including after shutdown)
2711 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2712 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2713 // output value back into a transaction with the regular channel output:
2715 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2716 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2718 if self.channel_outbound {
2719 // + the marginal fee increase cost to us in the commitment transaction:
2720 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2723 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2724 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2729 /// Returns true if we've ever received a message from the remote end for this Channel
2730 pub fn have_received_message(&self) -> bool {
2731 self.channel_state > (ChannelState::OurInitSent as u32)
2734 /// Returns true if this channel is fully established and not known to be closing.
2735 /// Allowed in any state (including after shutdown)
2736 pub fn is_usable(&self) -> bool {
2737 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2738 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2741 /// Returns true if this channel is currently available for use. This is a superset of
2742 /// is_usable() and considers things like the channel being temporarily disabled.
2743 /// Allowed in any state (including after shutdown)
2744 pub fn is_live(&self) -> bool {
2745 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2748 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2749 /// Allowed in any state (including after shutdown)
2750 pub fn is_awaiting_monitor_update(&self) -> bool {
2751 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2754 /// Returns true if funding_created was sent/received.
2755 pub fn is_funding_initiated(&self) -> bool {
2756 self.channel_state >= ChannelState::FundingCreated as u32
2759 /// Returns true if this channel is fully shut down. True here implies that no further actions
2760 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2761 /// will be handled appropriately by the chain monitor.
2762 pub fn is_shutdown(&self) -> bool {
2763 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2764 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2769 /// Called by channelmanager based on chain blocks being connected.
2770 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2771 /// the channel_monitor.
2772 /// In case of Err, the channel may have been closed, at which point the standard requirements
2773 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2774 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2775 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2776 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2777 if header.bitcoin_hash() != self.last_block_connected {
2778 self.last_block_connected = header.bitcoin_hash();
2779 self.channel_monitor.last_block_hash = self.last_block_connected;
2780 if self.funding_tx_confirmations > 0 {
2781 self.funding_tx_confirmations += 1;
2782 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2783 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2784 self.channel_state |= ChannelState::OurFundingLocked as u32;
2786 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2787 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2788 self.channel_update_count += 1;
2790 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2791 // We got a reorg but not enough to trigger a force close, just update
2792 // funding_tx_confirmed_in and return.
2794 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2795 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2797 // We got a reorg but not enough to trigger a force close, just update
2798 // funding_tx_confirmed_in and return.
2801 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2803 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2804 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2805 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2806 //a protocol oversight, but I assume I'm just missing something.
2807 if need_commitment_update {
2808 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2809 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2810 return Ok(Some(msgs::FundingLocked {
2811 channel_id: self.channel_id,
2812 next_per_commitment_point: next_per_commitment_point,
2818 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2819 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2820 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2821 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2822 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2823 tx.output[txo_idx].value != self.channel_value_satoshis {
2824 if self.channel_outbound {
2825 // If we generated the funding transaction and it doesn't match what it
2826 // should, the client is really broken and we should just panic and
2827 // tell them off. That said, because hash collisions happen with high
2828 // probability in fuzztarget mode, if we're fuzzing we just close the
2829 // channel and move on.
2830 #[cfg(not(feature = "fuzztarget"))]
2831 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2833 self.channel_state = ChannelState::ShutdownComplete as u32;
2834 self.channel_update_count += 1;
2835 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2837 if self.channel_outbound {
2838 for input in tx.input.iter() {
2839 if input.witness.is_empty() {
2840 // We generated a malleable funding transaction, implying we've
2841 // just exposed ourselves to funds loss to our counterparty.
2842 #[cfg(not(feature = "fuzztarget"))]
2843 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2847 self.funding_tx_confirmations = 1;
2848 self.short_channel_id = Some(((height as u64) << (5*8)) |
2849 ((*index_in_block as u64) << (2*8)) |
2850 ((txo_idx as u64) << (0*8)));
2858 /// Called by channelmanager based on chain blocks being disconnected.
2859 /// Returns true if we need to close the channel now due to funding transaction
2860 /// unconfirmation/reorg.
2861 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2862 if self.funding_tx_confirmations > 0 {
2863 self.funding_tx_confirmations -= 1;
2864 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2868 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2869 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2871 self.last_block_connected = header.bitcoin_hash();
2872 self.channel_monitor.last_block_hash = self.last_block_connected;
2876 // Methods to get unprompted messages to send to the remote end (or where we already returned
2877 // something in the handler for the message that prompted this message):
2879 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2880 if !self.channel_outbound {
2881 panic!("Tried to open a channel for an inbound channel?");
2883 if self.channel_state != ChannelState::OurInitSent as u32 {
2884 panic!("Cannot generate an open_channel after we've moved forward");
2887 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2888 panic!("Tried to send an open_channel for a channel that has already advanced");
2891 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2894 chain_hash: chain_hash,
2895 temporary_channel_id: self.channel_id,
2896 funding_satoshis: self.channel_value_satoshis,
2897 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2898 dust_limit_satoshis: self.our_dust_limit_satoshis,
2899 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2900 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2901 htlc_minimum_msat: self.our_htlc_minimum_msat,
2902 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2903 to_self_delay: BREAKDOWN_TIMEOUT,
2904 max_accepted_htlcs: OUR_MAX_HTLCS,
2905 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2906 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2907 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2908 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2909 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2910 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2911 channel_flags: if self.config.announced_channel {1} else {0},
2912 shutdown_scriptpubkey: None,
2916 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2917 if self.channel_outbound {
2918 panic!("Tried to send accept_channel for an outbound channel?");
2920 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2921 panic!("Tried to send accept_channel after channel had moved forward");
2923 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2924 panic!("Tried to send an accept_channel for a channel that has already advanced");
2927 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2929 msgs::AcceptChannel {
2930 temporary_channel_id: self.channel_id,
2931 dust_limit_satoshis: self.our_dust_limit_satoshis,
2932 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2933 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2934 htlc_minimum_msat: self.our_htlc_minimum_msat,
2935 minimum_depth: self.minimum_depth,
2936 to_self_delay: BREAKDOWN_TIMEOUT,
2937 max_accepted_htlcs: OUR_MAX_HTLCS,
2938 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2939 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2940 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2941 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2942 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2943 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2944 shutdown_scriptpubkey: None,
2948 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2949 let funding_script = self.get_funding_redeemscript();
2951 let remote_keys = self.build_remote_transaction_keys()?;
2952 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
2953 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();
2955 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2956 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2959 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2960 /// a funding_created message for the remote peer.
2961 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2962 /// or if called on an inbound channel.
2963 /// Note that channel_id changes during this call!
2964 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2965 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2966 if !self.channel_outbound {
2967 panic!("Tried to create outbound funding_created message on an inbound channel!");
2969 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2970 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)");
2972 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2973 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2974 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2975 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2978 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2979 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2981 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2984 log_error!(self, "Got bad signatures: {}!", e.err);
2985 self.channel_monitor.unset_funding_info();
2990 let temporary_channel_id = self.channel_id;
2992 // Now that we're past error-generating stuff, update our local state:
2993 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2994 self.channel_state = ChannelState::FundingCreated as u32;
2995 self.channel_id = funding_txo.to_channel_id();
2996 self.cur_remote_commitment_transaction_number -= 1;
2998 Ok((msgs::FundingCreated {
2999 temporary_channel_id: temporary_channel_id,
3000 funding_txid: funding_txo.txid,
3001 funding_output_index: funding_txo.index,
3002 signature: our_signature
3003 }, self.channel_monitor.clone()))
3006 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3007 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3008 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3009 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3010 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3012 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3013 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3014 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3015 if !self.config.announced_channel {
3016 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3018 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3019 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3021 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3022 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3025 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3026 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3028 let msg = msgs::UnsignedChannelAnnouncement {
3029 features: msgs::GlobalFeatures::new(),
3030 chain_hash: chain_hash,
3031 short_channel_id: self.get_short_channel_id().unwrap(),
3032 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3033 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3034 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3035 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3036 excess_data: Vec::new(),
3039 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
3040 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3045 /// May panic if called on a channel that wasn't immediately-previously
3046 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3047 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3048 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3049 msgs::ChannelReestablish {
3050 channel_id: self.channel_id(),
3051 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3052 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number -
3053 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) == (ChannelState::FundingSent as u32) { 1 } else { 0 },
3054 data_loss_protect: None,
3059 // Send stuff to our remote peers:
3061 /// Adds a pending outbound HTLC to this channel, note that you probably want
3062 /// send_htlc_and_commit instead cause you'll want both messages at once.
3063 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3064 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3065 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3066 /// You MUST call send_commitment prior to any other calls on this Channel
3067 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> {
3068 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3069 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
3072 if amount_msat > self.channel_value_satoshis * 1000 {
3073 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
3075 if amount_msat < self.their_htlc_minimum_msat {
3076 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
3079 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3080 // Note that this should never really happen, if we're !is_live() on receipt of an
3081 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3082 // the user to send directly into a !is_live() channel. However, if we
3083 // disconnected during the time the previous hop was doing the commitment dance we may
3084 // end up getting here after the forwarding delay. In any case, returning an
3085 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3086 return Err(HandleError{err: "Cannot send an HTLC while disconnected/frozen for channel monitor update", action: Some(ErrorAction::IgnoreError)});
3089 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3090 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3091 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
3093 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3094 // Check their_max_htlc_value_in_flight_msat
3095 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3096 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
3099 let mut holding_cell_outbound_amount_msat = 0;
3100 for holding_htlc in self.holding_cell_htlc_updates.iter() {
3101 match holding_htlc {
3102 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
3103 holding_cell_outbound_amount_msat += *amount_msat;
3109 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3110 // reserve for them to have something to claim if we misbehave)
3111 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
3112 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
3115 //TODO: Check cltv_expiry? Do this in channel manager?
3117 // Now update local state:
3118 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3119 //TODO: Check the limits *including* other pending holding cell HTLCs!
3120 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3121 amount_msat: amount_msat,
3122 payment_hash: payment_hash,
3123 cltv_expiry: cltv_expiry,
3125 onion_routing_packet: onion_routing_packet,
3126 time_created: Instant::now(),
3131 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3132 htlc_id: self.next_local_htlc_id,
3133 amount_msat: amount_msat,
3134 payment_hash: payment_hash.clone(),
3135 cltv_expiry: cltv_expiry,
3136 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3141 let res = msgs::UpdateAddHTLC {
3142 channel_id: self.channel_id,
3143 htlc_id: self.next_local_htlc_id,
3144 amount_msat: amount_msat,
3145 payment_hash: payment_hash,
3146 cltv_expiry: cltv_expiry,
3147 onion_routing_packet: onion_routing_packet,
3149 self.next_local_htlc_id += 1;
3154 /// Creates a signed commitment transaction to send to the remote peer.
3155 /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
3156 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3157 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3158 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3159 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3160 panic!("Cannot create commitment tx until channel is fully established");
3162 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3163 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3165 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3166 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3168 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3169 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");
3171 let mut have_updates = self.pending_update_fee.is_some();
3172 for htlc in self.pending_outbound_htlcs.iter() {
3173 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3174 have_updates = true;
3176 if have_updates { break; }
3179 panic!("Cannot create commitment tx until we have some updates to send");
3181 self.send_commitment_no_status_check()
3183 /// Only fails in case of bad keys
3184 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3185 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3186 // fail to generate this, we still are at least at a position where upgrading their status
3188 for htlc in self.pending_inbound_htlcs.iter_mut() {
3189 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3190 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3192 if let Some(state) = new_state {
3196 for htlc in self.pending_outbound_htlcs.iter_mut() {
3197 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
3198 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
3202 match self.send_commitment_no_state_update() {
3203 Ok((res, remote_commitment_tx)) => {
3204 // Update state now that we've passed all the can-fail calls...
3205 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
3206 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3207 Ok((res, self.channel_monitor.clone()))
3213 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3214 /// when we shouldn't change HTLC/channel state.
3215 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
3216 let funding_script = self.get_funding_redeemscript();
3218 let mut feerate_per_kw = self.feerate_per_kw;
3219 if let Some(feerate) = self.pending_update_fee {
3220 if self.channel_outbound {
3221 feerate_per_kw = feerate;
3225 let remote_keys = self.build_remote_transaction_keys()?;
3226 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3227 let remote_commitment_txid = remote_commitment_tx.0.txid();
3228 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();
3229 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3231 let mut htlc_sigs = Vec::new();
3233 for ref htlc in remote_commitment_tx.1.iter() {
3234 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3235 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3236 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3237 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());
3238 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3241 Ok((msgs::CommitmentSigned {
3242 channel_id: self.channel_id,
3244 htlc_signatures: htlc_sigs,
3245 }, remote_commitment_tx))
3248 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3249 /// to send to the remote peer in one go.
3250 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3252 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> {
3253 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3254 Some(update_add_htlc) => {
3255 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3256 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3262 /// Begins the shutdown process, getting a message for the remote peer and returning all
3263 /// holding cell HTLCs for payment failure.
3264 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
3265 for htlc in self.pending_outbound_htlcs.iter() {
3266 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3267 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3270 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3271 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3272 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3274 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3275 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3278 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3279 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3280 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3283 let our_closing_script = self.get_closing_scriptpubkey();
3285 // From here on out, we may not fail!
3286 if self.channel_state < ChannelState::FundingSent as u32 {
3287 self.channel_state = ChannelState::ShutdownComplete as u32;
3289 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3291 self.channel_update_count += 1;
3293 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3294 // our shutdown until we've committed all of the pending changes.
3295 self.holding_cell_update_fee = None;
3296 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3297 self.holding_cell_htlc_updates.retain(|htlc_update| {
3299 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3300 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3307 Ok((msgs::Shutdown {
3308 channel_id: self.channel_id,
3309 scriptpubkey: our_closing_script,
3310 }, dropped_outbound_htlcs))
3313 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3314 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3315 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3316 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3317 /// immediately (others we will have to allow to time out).
3318 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
3319 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3321 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3322 // return them to fail the payment.
3323 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3324 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3326 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3327 dropped_outbound_htlcs.push((source, payment_hash));
3333 for _htlc in self.pending_outbound_htlcs.drain(..) {
3334 //TODO: Do something with the remaining HTLCs
3335 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3339 self.channel_state = ChannelState::ShutdownComplete as u32;
3340 self.channel_update_count += 1;
3341 let mut res = Vec::new();
3342 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3343 (res, dropped_outbound_htlcs)
3347 const SERIALIZATION_VERSION: u8 = 1;
3348 const MIN_SERIALIZATION_VERSION: u8 = 1;
3350 impl Writeable for InboundHTLCRemovalReason {
3351 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3353 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3355 error_packet.write(writer)?;
3357 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3359 onion_hash.write(writer)?;
3360 err_code.write(writer)?;
3362 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3364 payment_preimage.write(writer)?;
3371 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3372 fn read(reader: &mut R) -> Result<Self, DecodeError> {
3373 Ok(match <u8 as Readable<R>>::read(reader)? {
3374 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3375 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3376 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3377 _ => return Err(DecodeError::InvalidValue),
3382 impl Writeable for Channel {
3383 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3384 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3385 // called but include holding cell updates (and obviously we don't modify self).
3387 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3388 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3390 self.user_id.write(writer)?;
3391 self.config.write(writer)?;
3393 self.channel_id.write(writer)?;
3394 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3395 self.channel_outbound.write(writer)?;
3396 self.channel_value_satoshis.write(writer)?;
3398 self.local_keys.write(writer)?;
3399 self.shutdown_pubkey.write(writer)?;
3401 self.cur_local_commitment_transaction_number.write(writer)?;
3402 self.cur_remote_commitment_transaction_number.write(writer)?;
3403 self.value_to_self_msat.write(writer)?;
3405 self.received_commitment_while_awaiting_raa.write(writer)?;
3407 let mut dropped_inbound_htlcs = 0;
3408 for htlc in self.pending_inbound_htlcs.iter() {
3409 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3410 dropped_inbound_htlcs += 1;
3413 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3414 for htlc in self.pending_inbound_htlcs.iter() {
3415 htlc.htlc_id.write(writer)?;
3416 htlc.amount_msat.write(writer)?;
3417 htlc.cltv_expiry.write(writer)?;
3418 htlc.payment_hash.write(writer)?;
3420 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3421 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3423 htlc_state.write(writer)?;
3425 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3427 htlc_state.write(writer)?;
3429 &InboundHTLCState::Committed => {
3432 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3434 removal_reason.write(writer)?;
3439 macro_rules! write_option {
3442 &None => 0u8.write(writer)?,
3451 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3452 for htlc in self.pending_outbound_htlcs.iter() {
3453 htlc.htlc_id.write(writer)?;
3454 htlc.amount_msat.write(writer)?;
3455 htlc.cltv_expiry.write(writer)?;
3456 htlc.payment_hash.write(writer)?;
3457 htlc.source.write(writer)?;
3458 write_option!(htlc.fail_reason);
3460 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3462 onion_packet.write(writer)?;
3464 &OutboundHTLCState::Committed => {
3467 &OutboundHTLCState::RemoteRemoved => {
3470 &OutboundHTLCState::AwaitingRemoteRevokeToRemove => {
3473 &OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
3479 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3480 for update in self.holding_cell_htlc_updates.iter() {
3482 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, time_created: _ } => {
3484 amount_msat.write(writer)?;
3485 cltv_expiry.write(writer)?;
3486 payment_hash.write(writer)?;
3487 source.write(writer)?;
3488 onion_routing_packet.write(writer)?;
3489 // time_created is not serialized - we re-init the timeout upon deserialization
3491 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3493 payment_preimage.write(writer)?;
3494 htlc_id.write(writer)?;
3496 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3498 htlc_id.write(writer)?;
3499 err_packet.write(writer)?;
3504 self.monitor_pending_revoke_and_ack.write(writer)?;
3505 self.monitor_pending_commitment_signed.write(writer)?;
3506 match self.monitor_pending_order {
3507 None => 0u8.write(writer)?,
3508 Some(RAACommitmentOrder::CommitmentFirst) => 1u8.write(writer)?,
3509 Some(RAACommitmentOrder::RevokeAndACKFirst) => 2u8.write(writer)?,
3512 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3513 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3514 pending_forward.write(writer)?;
3515 htlc_id.write(writer)?;
3518 (self.monitor_pending_failures.len() as u64).write(writer)?;
3519 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3520 htlc_source.write(writer)?;
3521 payment_hash.write(writer)?;
3522 fail_reason.write(writer)?;
3525 write_option!(self.pending_update_fee);
3526 write_option!(self.holding_cell_update_fee);
3528 self.next_local_htlc_id.write(writer)?;
3529 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3530 self.channel_update_count.write(writer)?;
3531 self.feerate_per_kw.write(writer)?;
3533 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3534 for tx in self.last_local_commitment_txn.iter() {
3535 if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3537 encode::Error::Io(e) => return Err(e),
3538 _ => panic!("last_local_commitment_txn must have been well-formed!"),
3543 match self.last_sent_closing_fee {
3544 Some((feerate, fee)) => {
3546 feerate.write(writer)?;
3549 None => 0u8.write(writer)?,
3552 write_option!(self.funding_tx_confirmed_in);
3553 write_option!(self.short_channel_id);
3555 self.last_block_connected.write(writer)?;
3556 self.funding_tx_confirmations.write(writer)?;
3558 self.their_dust_limit_satoshis.write(writer)?;
3559 self.our_dust_limit_satoshis.write(writer)?;
3560 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3561 self.their_channel_reserve_satoshis.write(writer)?;
3562 self.their_htlc_minimum_msat.write(writer)?;
3563 self.our_htlc_minimum_msat.write(writer)?;
3564 self.their_to_self_delay.write(writer)?;
3565 self.their_max_accepted_htlcs.write(writer)?;
3566 self.minimum_depth.write(writer)?;
3568 write_option!(self.their_funding_pubkey);
3569 write_option!(self.their_revocation_basepoint);
3570 write_option!(self.their_payment_basepoint);
3571 write_option!(self.their_delayed_payment_basepoint);
3572 write_option!(self.their_htlc_basepoint);
3573 write_option!(self.their_cur_commitment_point);
3575 write_option!(self.their_prev_commitment_point);
3576 self.their_node_id.write(writer)?;
3578 write_option!(self.their_shutdown_scriptpubkey);
3580 self.channel_monitor.write_for_disk(writer)?;
3585 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3586 fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3587 let _ver: u8 = Readable::read(reader)?;
3588 let min_ver: u8 = Readable::read(reader)?;
3589 if min_ver > SERIALIZATION_VERSION {
3590 return Err(DecodeError::UnknownVersion);
3593 let user_id = Readable::read(reader)?;
3594 let config: ChannelConfig = Readable::read(reader)?;
3596 let channel_id = Readable::read(reader)?;
3597 let channel_state = Readable::read(reader)?;
3598 let channel_outbound = Readable::read(reader)?;
3599 let channel_value_satoshis = Readable::read(reader)?;
3601 let local_keys = Readable::read(reader)?;
3602 let shutdown_pubkey = Readable::read(reader)?;
3604 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3605 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3606 let value_to_self_msat = Readable::read(reader)?;
3608 let received_commitment_while_awaiting_raa = Readable::read(reader)?;
3610 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3611 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3612 for _ in 0..pending_inbound_htlc_count {
3613 pending_inbound_htlcs.push(InboundHTLCOutput {
3614 htlc_id: Readable::read(reader)?,
3615 amount_msat: Readable::read(reader)?,
3616 cltv_expiry: Readable::read(reader)?,
3617 payment_hash: Readable::read(reader)?,
3618 state: match <u8 as Readable<R>>::read(reader)? {
3619 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3620 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3621 3 => InboundHTLCState::Committed,
3622 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3623 _ => return Err(DecodeError::InvalidValue),
3628 macro_rules! read_option { () => {
3629 match <u8 as Readable<R>>::read(reader)? {
3631 1 => Some(Readable::read(reader)?),
3632 _ => return Err(DecodeError::InvalidValue),
3636 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3637 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3638 for _ in 0..pending_outbound_htlc_count {
3639 pending_outbound_htlcs.push(OutboundHTLCOutput {
3640 htlc_id: Readable::read(reader)?,
3641 amount_msat: Readable::read(reader)?,
3642 cltv_expiry: Readable::read(reader)?,
3643 payment_hash: Readable::read(reader)?,
3644 source: Readable::read(reader)?,
3645 fail_reason: read_option!(),
3646 state: match <u8 as Readable<R>>::read(reader)? {
3647 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3648 1 => OutboundHTLCState::Committed,
3649 2 => OutboundHTLCState::RemoteRemoved,
3650 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove,
3651 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke,
3652 _ => return Err(DecodeError::InvalidValue),
3657 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3658 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3659 for _ in 0..holding_cell_htlc_update_count {
3660 holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3661 0 => HTLCUpdateAwaitingACK::AddHTLC {
3662 amount_msat: Readable::read(reader)?,
3663 cltv_expiry: Readable::read(reader)?,
3664 payment_hash: Readable::read(reader)?,
3665 source: Readable::read(reader)?,
3666 onion_routing_packet: Readable::read(reader)?,
3667 time_created: Instant::now(),
3669 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3670 payment_preimage: Readable::read(reader)?,
3671 htlc_id: Readable::read(reader)?,
3673 2 => HTLCUpdateAwaitingACK::FailHTLC {
3674 htlc_id: Readable::read(reader)?,
3675 err_packet: Readable::read(reader)?,
3677 _ => return Err(DecodeError::InvalidValue),
3681 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3682 let monitor_pending_commitment_signed = Readable::read(reader)?;
3684 let monitor_pending_order = match <u8 as Readable<R>>::read(reader)? {
3686 1 => Some(RAACommitmentOrder::CommitmentFirst),
3687 2 => Some(RAACommitmentOrder::RevokeAndACKFirst),
3688 _ => return Err(DecodeError::InvalidValue),
3691 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3692 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3693 for _ in 0..monitor_pending_forwards_count {
3694 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3697 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3698 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3699 for _ in 0..monitor_pending_failures_count {
3700 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3703 let pending_update_fee = read_option!();
3704 let holding_cell_update_fee = read_option!();
3706 let next_local_htlc_id = Readable::read(reader)?;
3707 let next_remote_htlc_id = Readable::read(reader)?;
3708 let channel_update_count = Readable::read(reader)?;
3709 let feerate_per_kw = Readable::read(reader)?;
3711 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3712 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3713 for _ in 0..last_local_commitment_txn_count {
3714 last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3716 Err(_) => return Err(DecodeError::InvalidValue),
3720 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3722 1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3723 _ => return Err(DecodeError::InvalidValue),
3726 let funding_tx_confirmed_in = read_option!();
3727 let short_channel_id = read_option!();
3729 let last_block_connected = Readable::read(reader)?;
3730 let funding_tx_confirmations = Readable::read(reader)?;
3732 let their_dust_limit_satoshis = Readable::read(reader)?;
3733 let our_dust_limit_satoshis = Readable::read(reader)?;
3734 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3735 let their_channel_reserve_satoshis = Readable::read(reader)?;
3736 let their_htlc_minimum_msat = Readable::read(reader)?;
3737 let our_htlc_minimum_msat = Readable::read(reader)?;
3738 let their_to_self_delay = Readable::read(reader)?;
3739 let their_max_accepted_htlcs = Readable::read(reader)?;
3740 let minimum_depth = Readable::read(reader)?;
3742 let their_funding_pubkey = read_option!();
3743 let their_revocation_basepoint = read_option!();
3744 let their_payment_basepoint = read_option!();
3745 let their_delayed_payment_basepoint = read_option!();
3746 let their_htlc_basepoint = read_option!();
3747 let their_cur_commitment_point = read_option!();
3749 let their_prev_commitment_point = read_option!();
3750 let their_node_id = Readable::read(reader)?;
3752 let their_shutdown_scriptpubkey = read_option!();
3753 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3754 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3755 // doing full block connection operations on the internal CHannelMonitor copies
3756 if monitor_last_block != last_block_connected {
3757 return Err(DecodeError::InvalidValue);
3767 secp_ctx: Secp256k1::new(),
3768 channel_value_satoshis,
3773 cur_local_commitment_transaction_number,
3774 cur_remote_commitment_transaction_number,
3777 received_commitment_while_awaiting_raa,
3778 pending_inbound_htlcs,
3779 pending_outbound_htlcs,
3780 holding_cell_htlc_updates,
3782 monitor_pending_revoke_and_ack,
3783 monitor_pending_commitment_signed,
3784 monitor_pending_order,
3785 monitor_pending_forwards,
3786 monitor_pending_failures,
3789 holding_cell_update_fee,
3791 next_remote_htlc_id,
3792 channel_update_count,
3795 #[cfg(debug_assertions)]
3796 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3797 #[cfg(debug_assertions)]
3798 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3800 last_local_commitment_txn,
3802 last_sent_closing_fee,
3804 funding_tx_confirmed_in,
3806 last_block_connected,
3807 funding_tx_confirmations,
3809 their_dust_limit_satoshis,
3810 our_dust_limit_satoshis,
3811 their_max_htlc_value_in_flight_msat,
3812 their_channel_reserve_satoshis,
3813 their_htlc_minimum_msat,
3814 our_htlc_minimum_msat,
3815 their_to_self_delay,
3816 their_max_accepted_htlcs,
3819 their_funding_pubkey,
3820 their_revocation_basepoint,
3821 their_payment_basepoint,
3822 their_delayed_payment_basepoint,
3823 their_htlc_basepoint,
3824 their_cur_commitment_point,
3826 their_prev_commitment_point,
3829 their_shutdown_scriptpubkey,
3840 use bitcoin::util::hash::{Sha256dHash, Hash160};
3841 use bitcoin::util::bip143;
3842 use bitcoin::consensus::encode::serialize;
3843 use bitcoin::blockdata::script::{Script, Builder};
3844 use bitcoin::blockdata::transaction::Transaction;
3845 use bitcoin::blockdata::opcodes;
3847 use ln::channelmanager::HTLCSource;
3848 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3849 use ln::channel::MAX_FUNDING_SATOSHIS;
3851 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3852 use chain::keysinterface::KeysInterface;
3853 use chain::transaction::OutPoint;
3854 use util::config::UserConfig;
3855 use util::test_utils;
3856 use util::logger::Logger;
3857 use secp256k1::{Secp256k1,Message,Signature};
3858 use secp256k1::key::{SecretKey,PublicKey};
3859 use crypto::sha2::Sha256;
3860 use crypto::digest::Digest;
3863 struct TestFeeEstimator {
3866 impl FeeEstimator for TestFeeEstimator {
3867 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3873 fn test_max_funding_satoshis() {
3874 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3875 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3879 chan_keys: ChannelKeys,
3881 impl KeysInterface for Keys {
3882 fn get_node_secret(&self) -> SecretKey { panic!(); }
3883 fn get_destination_script(&self) -> Script {
3884 let secp_ctx = Secp256k1::signing_only();
3885 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3886 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
3887 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
3890 fn get_shutdown_pubkey(&self) -> PublicKey {
3891 let secp_ctx = Secp256k1::signing_only();
3892 let channel_close_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3893 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
3896 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
3900 fn outbound_commitment_test() {
3901 // Test vectors from BOLT 3 Appendix C:
3902 let feeest = TestFeeEstimator{fee_est: 15000};
3903 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3904 let secp_ctx = Secp256k1::new();
3906 let chan_keys = ChannelKeys {
3907 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3908 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3909 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3910 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3912 // These aren't set in the test vectors:
3913 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3914 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],
3916 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3917 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3918 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
3920 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
3921 let mut config = UserConfig::new();
3922 config.channel_options.announced_channel = false;
3923 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
3924 chan.their_to_self_delay = 144;
3925 chan.our_dust_limit_satoshis = 546;
3927 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
3928 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
3930 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3931 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
3932 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3934 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
3935 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
3936 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
3938 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3939 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
3940 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3942 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
3944 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
3945 // derived from a commitment_seed, so instead we copy it here and call
3946 // build_commitment_transaction.
3947 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
3948 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3949 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3950 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
3951 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();
3953 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
3955 macro_rules! test_commitment {
3956 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
3957 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
3958 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3959 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();
3960 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
3962 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
3964 assert_eq!(serialize(&unsigned_tx.0)[..],
3965 hex::decode($tx_hex).unwrap()[..]);
3969 macro_rules! test_htlc_output {
3970 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
3971 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3973 let ref htlc = unsigned_tx.1[$htlc_idx];
3974 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
3975 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
3976 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3977 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
3979 let mut preimage: Option<[u8; 32]> = None;
3982 let mut sha = Sha256::new();
3983 sha.input(&[i; 32]);
3985 let mut out = [0; 32];
3986 sha.result(&mut out);
3988 if out == htlc.payment_hash {
3989 preimage = Some([i; 32]);
3993 assert!(preimage.is_some());
3996 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
3997 assert_eq!(serialize(&htlc_tx)[..],
3998 hex::decode($tx_hex).unwrap()[..]);
4003 // simple commitment tx with no HTLCs
4004 chan.value_to_self_msat = 7000000000;
4006 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4007 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4008 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4011 chan.pending_inbound_htlcs.push({
4012 let mut out = InboundHTLCOutput{
4014 amount_msat: 1000000,
4016 payment_hash: [0; 32],
4017 state: InboundHTLCState::Committed,
4019 let mut sha = Sha256::new();
4020 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4021 sha.result(&mut out.payment_hash);
4024 chan.pending_inbound_htlcs.push({
4025 let mut out = InboundHTLCOutput{
4027 amount_msat: 2000000,
4029 payment_hash: [0; 32],
4030 state: InboundHTLCState::Committed,
4032 let mut sha = Sha256::new();
4033 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4034 sha.result(&mut out.payment_hash);
4037 chan.pending_outbound_htlcs.push({
4038 let mut out = OutboundHTLCOutput{
4040 amount_msat: 2000000,
4042 payment_hash: [0; 32],
4043 state: OutboundHTLCState::Committed,
4044 source: HTLCSource::dummy(),
4047 let mut sha = Sha256::new();
4048 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
4049 sha.result(&mut out.payment_hash);
4052 chan.pending_outbound_htlcs.push({
4053 let mut out = OutboundHTLCOutput{
4055 amount_msat: 3000000,
4057 payment_hash: [0; 32],
4058 state: OutboundHTLCState::Committed,
4059 source: HTLCSource::dummy(),
4062 let mut sha = Sha256::new();
4063 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
4064 sha.result(&mut out.payment_hash);
4067 chan.pending_inbound_htlcs.push({
4068 let mut out = InboundHTLCOutput{
4070 amount_msat: 4000000,
4072 payment_hash: [0; 32],
4073 state: InboundHTLCState::Committed,
4075 let mut sha = Sha256::new();
4076 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
4077 sha.result(&mut out.payment_hash);
4082 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4083 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4084 chan.feerate_per_kw = 0;
4086 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4087 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4088 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4090 assert_eq!(unsigned_tx.1.len(), 5);
4092 test_htlc_output!(0,
4093 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4094 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4095 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4097 test_htlc_output!(1,
4098 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4099 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4100 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4102 test_htlc_output!(2,
4103 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4104 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4105 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4107 test_htlc_output!(3,
4108 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4109 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4110 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4112 test_htlc_output!(4,
4113 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4114 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4115 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4119 // commitment tx with seven outputs untrimmed (maximum feerate)
4120 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4121 chan.feerate_per_kw = 647;
4123 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4124 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4125 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4127 assert_eq!(unsigned_tx.1.len(), 5);
4129 test_htlc_output!(0,
4130 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4131 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4132 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4134 test_htlc_output!(1,
4135 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4136 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4137 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4139 test_htlc_output!(2,
4140 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4141 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4142 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4144 test_htlc_output!(3,
4145 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4146 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4147 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4149 test_htlc_output!(4,
4150 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4151 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4152 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4156 // commitment tx with six outputs untrimmed (minimum feerate)
4157 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4158 chan.feerate_per_kw = 648;
4160 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4161 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4162 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4164 assert_eq!(unsigned_tx.1.len(), 4);
4166 test_htlc_output!(0,
4167 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4168 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4169 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4171 test_htlc_output!(1,
4172 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4173 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4174 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4176 test_htlc_output!(2,
4177 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4178 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4179 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4181 test_htlc_output!(3,
4182 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4183 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4184 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4188 // commitment tx with six outputs untrimmed (maximum feerate)
4189 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4190 chan.feerate_per_kw = 2069;
4192 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4193 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4194 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4196 assert_eq!(unsigned_tx.1.len(), 4);
4198 test_htlc_output!(0,
4199 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4200 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4201 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4203 test_htlc_output!(1,
4204 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4205 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4206 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4208 test_htlc_output!(2,
4209 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4210 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4211 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4213 test_htlc_output!(3,
4214 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4215 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4216 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4220 // commitment tx with five outputs untrimmed (minimum feerate)
4221 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4222 chan.feerate_per_kw = 2070;
4224 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4225 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4226 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4228 assert_eq!(unsigned_tx.1.len(), 3);
4230 test_htlc_output!(0,
4231 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4232 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4233 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4235 test_htlc_output!(1,
4236 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4237 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4238 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4240 test_htlc_output!(2,
4241 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4242 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4243 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4247 // commitment tx with five outputs untrimmed (maximum feerate)
4248 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4249 chan.feerate_per_kw = 2194;
4251 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4252 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4253 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4255 assert_eq!(unsigned_tx.1.len(), 3);
4257 test_htlc_output!(0,
4258 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4259 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4260 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4262 test_htlc_output!(1,
4263 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4264 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4265 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4267 test_htlc_output!(2,
4268 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4269 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4270 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4274 // commitment tx with four outputs untrimmed (minimum feerate)
4275 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4276 chan.feerate_per_kw = 2195;
4278 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4279 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4280 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4282 assert_eq!(unsigned_tx.1.len(), 2);
4284 test_htlc_output!(0,
4285 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4286 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4287 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4289 test_htlc_output!(1,
4290 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4291 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4292 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4296 // commitment tx with four outputs untrimmed (maximum feerate)
4297 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4298 chan.feerate_per_kw = 3702;
4300 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4301 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4302 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4304 assert_eq!(unsigned_tx.1.len(), 2);
4306 test_htlc_output!(0,
4307 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4308 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4309 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4311 test_htlc_output!(1,
4312 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4313 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4314 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4318 // commitment tx with three outputs untrimmed (minimum feerate)
4319 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4320 chan.feerate_per_kw = 3703;
4322 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4323 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4324 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4326 assert_eq!(unsigned_tx.1.len(), 1);
4328 test_htlc_output!(0,
4329 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4330 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4331 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4335 // commitment tx with three outputs untrimmed (maximum feerate)
4336 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4337 chan.feerate_per_kw = 4914;
4339 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4340 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4341 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4343 assert_eq!(unsigned_tx.1.len(), 1);
4345 test_htlc_output!(0,
4346 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4347 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4348 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4352 // commitment tx with two outputs untrimmed (minimum feerate)
4353 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4354 chan.feerate_per_kw = 4915;
4356 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4357 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4358 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4360 assert_eq!(unsigned_tx.1.len(), 0);
4364 // commitment tx with two outputs untrimmed (maximum feerate)
4365 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4366 chan.feerate_per_kw = 9651180;
4368 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4369 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4370 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4372 assert_eq!(unsigned_tx.1.len(), 0);
4376 // commitment tx with one output untrimmed (minimum feerate)
4377 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4378 chan.feerate_per_kw = 9651181;
4380 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4381 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4382 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4384 assert_eq!(unsigned_tx.1.len(), 0);
4388 // commitment tx with fee greater than funder amount
4389 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4390 chan.feerate_per_kw = 9651936;
4392 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4393 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4394 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4396 assert_eq!(unsigned_tx.1.len(), 0);
4401 fn test_per_commitment_secret_gen() {
4402 // Test vectors from BOLT 3 Appendix D:
4404 let mut seed = [0; 32];
4405 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4406 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4407 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4409 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4410 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4411 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4413 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4414 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4416 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4417 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4419 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4420 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4421 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4425 fn test_key_derivation() {
4426 // Test vectors from BOLT 3 Appendix E:
4427 let secp_ctx = Secp256k1::new();
4429 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4430 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4432 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4433 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4435 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4436 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4438 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4439 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4441 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4442 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4444 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4445 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4447 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4448 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());