1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::BitcoinHash;
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode;
9 use bitcoin::hashes::{Hash, HashEngine};
10 use bitcoin::hashes::sha256::Hash as Sha256;
11 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
13 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
14 use bitcoin::secp256k1::{Secp256k1,Signature};
15 use bitcoin::secp256k1;
17 use ln::features::{ChannelFeatures, InitFeatures};
19 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
20 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
21 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
22 use ln::chan_utils::{CounterpartyCommitmentSecrets, LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys};
24 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
25 use chain::transaction::OutPoint;
26 use chain::keysinterface::{ChannelKeys, KeysInterface};
27 use util::transaction_utils;
28 use util::ser::{Readable, Writeable, Writer};
29 use util::logger::Logger;
30 use util::errors::APIError;
31 use util::config::{UserConfig,ChannelConfig};
34 use std::default::Default;
35 use std::{cmp,mem,fmt};
39 pub struct ChannelValueStat {
40 pub value_to_self_msat: u64,
41 pub channel_value_msat: u64,
42 pub channel_reserve_msat: u64,
43 pub pending_outbound_htlcs_amount_msat: u64,
44 pub pending_inbound_htlcs_amount_msat: u64,
45 pub holding_cell_outbound_amount_msat: u64,
46 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
49 enum InboundHTLCRemovalReason {
50 FailRelay(msgs::OnionErrorPacket),
51 FailMalformed(([u8; 32], u16)),
52 Fulfill(PaymentPreimage),
55 enum InboundHTLCState {
56 /// Added by remote, to be included in next local commitment tx.
57 RemoteAnnounced(PendingHTLCStatus),
58 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
59 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
60 /// accept this HTLC. Implies AwaitingRemoteRevoke.
61 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
62 /// a remote revoke_and_ack on a previous state before we can do so.
63 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
64 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
65 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
66 /// accept this HTLC. Implies AwaitingRemoteRevoke.
67 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
69 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
71 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
72 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
74 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
75 /// commitment transaction without it as otherwise we'll have to force-close the channel to
76 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
77 /// anyway). That said, ChannelMonitor does this for us (see
78 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
79 /// local state before then, once we're sure that the next commitment_signed and
80 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
81 LocalRemoved(InboundHTLCRemovalReason),
84 struct InboundHTLCOutput {
88 payment_hash: PaymentHash,
89 state: InboundHTLCState,
92 enum OutboundHTLCState {
93 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
94 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
95 /// we will promote to Committed (note that they may not accept it until the next time we
96 /// revoke, but we don't really care about that:
97 /// * they've revoked, so worst case we can announce an old state and get our (option on)
98 /// money back (though we won't), and,
99 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
100 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
101 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
102 /// we'll never get out of sync).
103 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
104 /// OutboundHTLCOutput's size just for a temporary bit
105 LocalAnnounced(Box<msgs::OnionPacket>),
107 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
108 /// the change (though they'll need to revoke before we fail the payment).
109 RemoteRemoved(Option<HTLCFailReason>),
110 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
111 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
113 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
114 /// remote revoke_and_ack on a previous state before we can do so.
115 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
116 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
117 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
119 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
120 /// revoke_and_ack to drop completely.
121 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
124 struct OutboundHTLCOutput {
128 payment_hash: PaymentHash,
129 state: OutboundHTLCState,
133 /// See AwaitingRemoteRevoke ChannelState for more info
134 enum HTLCUpdateAwaitingACK {
135 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
139 payment_hash: PaymentHash,
141 onion_routing_packet: msgs::OnionPacket,
144 payment_preimage: PaymentPreimage,
149 err_packet: msgs::OnionErrorPacket,
153 /// There are a few "states" and then a number of flags which can be applied:
154 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
155 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
156 /// move on to ChannelFunded.
157 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
158 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
159 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
161 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
162 OurInitSent = (1 << 0),
163 /// Implies we have received their open_channel/accept_channel message
164 TheirInitSent = (1 << 1),
165 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
166 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
167 /// upon receipt of funding_created, so simply skip this state.
169 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
170 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
171 /// and our counterparty consider the funding transaction confirmed.
173 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
174 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
175 TheirFundingLocked = (1 << 4),
176 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
177 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
178 OurFundingLocked = (1 << 5),
180 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
181 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
183 PeerDisconnected = (1 << 7),
184 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
185 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
186 /// outbound messages until they've managed to do so.
187 MonitorUpdateFailed = (1 << 8),
188 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
189 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
190 /// messages as then we will be unable to determine which HTLCs they included in their
191 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
193 /// Flag is set on ChannelFunded.
194 AwaitingRemoteRevoke = (1 << 9),
195 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
196 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
197 /// to respond with our own shutdown message when possible.
198 RemoteShutdownSent = (1 << 10),
199 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
200 /// point, we may not add any new HTLCs to the channel.
201 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
202 /// us their shutdown.
203 LocalShutdownSent = (1 << 11),
204 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
205 /// to drop us, but we store this anyway.
206 ShutdownComplete = 4096,
208 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
209 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
211 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
213 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
214 /// If channel is public, network should have a liveness view announced by us on a
215 /// best-effort, which means we may filter out some status transitions to avoid spam.
216 /// See further timer_chan_freshness_every_min.
219 /// Status has been gossiped.
221 /// Status has been changed.
223 /// Status has been marked to be gossiped at next flush
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<ChanSigner: ChannelKeys> {
232 config: ChannelConfig,
236 channel_id: [u8; 32],
238 channel_outbound: bool,
239 secp_ctx: Secp256k1<secp256k1::All>,
240 channel_value_satoshis: u64,
242 latest_monitor_update_id: u64,
245 local_keys: ChanSigner,
247 pub(super) local_keys: ChanSigner,
248 shutdown_pubkey: PublicKey,
249 destination_script: Script,
251 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
252 // generation start at 0 and count up...this simplifies some parts of implementation at the
253 // cost of others, but should really just be changed.
255 cur_local_commitment_transaction_number: u64,
256 cur_remote_commitment_transaction_number: u64,
257 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
258 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
259 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
260 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
262 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
263 /// need to ensure we resend them in the order we originally generated them. Note that because
264 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
265 /// sufficient to simply set this to the opposite of any message we are generating as we
266 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
267 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
269 resend_order: RAACommitmentOrder,
271 monitor_pending_funding_locked: bool,
272 monitor_pending_revoke_and_ack: bool,
273 monitor_pending_commitment_signed: bool,
274 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
275 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
277 // pending_update_fee is filled when sending and receiving update_fee
278 // For outbound channel, feerate_per_kw is updated with the value from
279 // pending_update_fee when revoke_and_ack is received
281 // For inbound channel, feerate_per_kw is updated when it receives
282 // commitment_signed and revoke_and_ack is generated
283 // The pending value is kept when another pair of update_fee and commitment_signed
284 // is received during AwaitingRemoteRevoke and relieved when the expected
285 // revoke_and_ack is received and new commitment_signed is generated to be
286 // sent to the funder. Otherwise, the pending value is removed when receiving
287 // commitment_signed.
288 pending_update_fee: Option<u64>,
289 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
290 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
291 // is received. holding_cell_update_fee is updated when there are additional
292 // update_fee() during ChannelState::AwaitingRemoteRevoke.
293 holding_cell_update_fee: Option<u64>,
294 next_local_htlc_id: u64,
295 next_remote_htlc_id: u64,
296 update_time_counter: u32,
299 #[cfg(debug_assertions)]
300 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
301 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
302 #[cfg(debug_assertions)]
303 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
304 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
306 last_sent_closing_fee: Option<(u64, u64, Signature)>, // (feerate, fee, our_sig)
308 funding_txo: Option<OutPoint>,
310 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
311 /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
312 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
313 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
314 funding_tx_confirmed_in: Option<BlockHash>,
315 short_channel_id: Option<u64>,
316 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
317 /// ChannelManager deserialization (hence pub(super))
318 pub(super) last_block_connected: BlockHash,
319 funding_tx_confirmations: u64,
321 their_dust_limit_satoshis: u64,
323 pub(super) our_dust_limit_satoshis: u64,
325 our_dust_limit_satoshis: u64,
327 pub(super) their_max_htlc_value_in_flight_msat: u64,
329 their_max_htlc_value_in_flight_msat: u64,
330 //get_our_max_htlc_value_in_flight_msat(): u64,
331 /// minimum channel reserve for self to maintain - set by them.
332 local_channel_reserve_satoshis: u64,
333 // get_remote_channel_reserve_satoshis(channel_value_sats: u64): u64
334 their_htlc_minimum_msat: u64,
335 our_htlc_minimum_msat: u64,
336 their_to_self_delay: u16,
337 our_to_self_delay: u16,
339 pub their_max_accepted_htlcs: u16,
341 their_max_accepted_htlcs: u16,
342 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
345 their_pubkeys: Option<ChannelPublicKeys>,
347 their_cur_commitment_point: Option<PublicKey>,
349 their_prev_commitment_point: Option<PublicKey>,
350 their_node_id: PublicKey,
352 their_shutdown_scriptpubkey: Option<Script>,
354 /// Used exclusively to broadcast the latest local state, mostly a historical quirk that this
356 channel_monitor: Option<ChannelMonitor<ChanSigner>>,
357 commitment_secrets: CounterpartyCommitmentSecrets,
359 network_sync: UpdateStatus,
362 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
363 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
364 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
365 /// really allow for this, so instead we're stuck closing it out at that point.
366 const UNCONF_THRESHOLD: u32 = 6;
367 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
368 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?)
371 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
373 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
375 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
377 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
379 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
381 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
383 /// Used to return a simple Error back to ChannelManager. Will get converted to a
384 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
385 /// channel_id in ChannelManager.
386 pub(super) enum ChannelError {
387 Ignore(&'static str),
389 CloseDelayBroadcast(&'static str),
392 impl fmt::Debug for ChannelError {
393 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
395 &ChannelError::Ignore(e) => write!(f, "Ignore : {}", e),
396 &ChannelError::Close(e) => write!(f, "Close : {}", e),
397 &ChannelError::CloseDelayBroadcast(e) => write!(f, "CloseDelayBroadcast : {}", e)
402 macro_rules! secp_check {
403 ($res: expr, $err: expr) => {
406 Err(_) => return Err(ChannelError::Close($err)),
411 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
412 // Convert constants + channel value to limits:
413 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
414 channel_value_satoshis * 1000 / 10 //TODO
417 /// Returns a minimum channel reserve value the remote needs to maintain,
420 /// Guaranteed to return a value no larger than channel_value_satoshis
421 pub(crate) fn get_remote_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
422 let (q, _) = channel_value_satoshis.overflowing_div(100);
423 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
426 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
427 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
431 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, APIError>
432 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
433 F::Target: FeeEstimator,
435 let chan_keys = keys_provider.get_channel_keys(false, channel_value_satoshis);
437 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
438 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
441 if push_msat > channel_value_satoshis * 1000 {
442 return Err(APIError::APIMisuseError{err: "push value > channel value"});
444 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
445 return Err(APIError::APIMisuseError{err: "Configured with an unreasonable our_to_self_delay putting user funds at risks"});
449 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
450 if Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(channel_value_satoshis) < Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate) {
451 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
454 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
458 config: config.channel_options.clone(),
460 channel_id: keys_provider.get_channel_id(),
461 channel_state: ChannelState::OurInitSent as u32,
462 channel_outbound: true,
463 secp_ctx: Secp256k1::new(),
464 channel_value_satoshis: channel_value_satoshis,
466 latest_monitor_update_id: 0,
468 local_keys: chan_keys,
469 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
470 destination_script: keys_provider.get_destination_script(),
472 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
473 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
474 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
476 pending_inbound_htlcs: Vec::new(),
477 pending_outbound_htlcs: Vec::new(),
478 holding_cell_htlc_updates: Vec::new(),
479 pending_update_fee: None,
480 holding_cell_update_fee: None,
481 next_local_htlc_id: 0,
482 next_remote_htlc_id: 0,
483 update_time_counter: 1,
485 resend_order: RAACommitmentOrder::CommitmentFirst,
487 monitor_pending_funding_locked: false,
488 monitor_pending_revoke_and_ack: false,
489 monitor_pending_commitment_signed: false,
490 monitor_pending_forwards: Vec::new(),
491 monitor_pending_failures: Vec::new(),
493 #[cfg(debug_assertions)]
494 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
495 #[cfg(debug_assertions)]
496 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
498 last_sent_closing_fee: None,
501 funding_tx_confirmed_in: None,
502 short_channel_id: None,
503 last_block_connected: Default::default(),
504 funding_tx_confirmations: 0,
506 feerate_per_kw: feerate,
507 their_dust_limit_satoshis: 0,
508 our_dust_limit_satoshis: Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate),
509 their_max_htlc_value_in_flight_msat: 0,
510 local_channel_reserve_satoshis: 0,
511 their_htlc_minimum_msat: 0,
512 our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
513 their_to_self_delay: 0,
514 our_to_self_delay: config.own_channel_config.our_to_self_delay,
515 their_max_accepted_htlcs: 0,
516 minimum_depth: 0, // Filled in in accept_channel
519 their_cur_commitment_point: None,
521 their_prev_commitment_point: None,
522 their_node_id: their_node_id,
524 their_shutdown_scriptpubkey: None,
526 channel_monitor: None,
527 commitment_secrets: CounterpartyCommitmentSecrets::new(),
529 network_sync: UpdateStatus::Fresh,
533 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
534 where F::Target: FeeEstimator
536 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
537 return Err(ChannelError::Close("Peer's feerate much too low"));
539 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
540 return Err(ChannelError::Close("Peer's feerate much too high"));
545 /// Creates a new channel from a remote sides' request for one.
546 /// Assumes chain_hash has already been checked and corresponds with what we expect!
547 pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, ChannelError>
548 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
549 F::Target: FeeEstimator
551 let mut chan_keys = keys_provider.get_channel_keys(true, msg.funding_satoshis);
552 let their_pubkeys = ChannelPublicKeys {
553 funding_pubkey: msg.funding_pubkey,
554 revocation_basepoint: msg.revocation_basepoint,
555 payment_point: msg.payment_point,
556 delayed_payment_basepoint: msg.delayed_payment_basepoint,
557 htlc_basepoint: msg.htlc_basepoint
559 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
560 let mut local_config = (*config).channel_options.clone();
562 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
563 return Err(ChannelError::Close("Configured with an unreasonable our_to_self_delay putting user funds at risks"));
566 // Check sanity of message fields:
567 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
568 return Err(ChannelError::Close("funding value > 2^24"));
570 if msg.channel_reserve_satoshis > msg.funding_satoshis {
571 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
573 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
574 return Err(ChannelError::Close("push_msat larger than funding value"));
576 if msg.dust_limit_satoshis > msg.funding_satoshis {
577 return Err(ChannelError::Close("Peer never wants payout outputs?"));
579 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
580 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
582 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
583 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
585 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
587 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
588 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
590 if msg.max_accepted_htlcs < 1 {
591 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
593 if msg.max_accepted_htlcs > 483 {
594 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
597 // Now check against optional parameters as set by config...
598 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
599 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
601 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
602 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
604 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
605 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
607 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
608 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
610 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
611 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
613 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
614 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
616 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
617 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
620 // Convert things into internal flags and prep our state:
622 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
623 if config.peer_channel_config_limits.force_announced_channel_preference {
624 if local_config.announced_channel != their_announce {
625 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
628 // we either accept their preference or the preferences match
629 local_config.announced_channel = their_announce;
631 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
633 let our_dust_limit_satoshis = Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate);
634 let remote_channel_reserve_satoshis = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(msg.funding_satoshis);
635 if remote_channel_reserve_satoshis < our_dust_limit_satoshis {
636 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
638 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
639 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
641 if remote_channel_reserve_satoshis < msg.dust_limit_satoshis {
642 return Err(ChannelError::Close("Dust limit too high for the channel reserve we require the remote to keep"));
645 // check if the funder's amount for the initial commitment tx is sufficient
646 // for full fee payment
647 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
648 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
649 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
652 let to_local_msat = msg.push_msat;
653 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
654 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= remote_channel_reserve_satoshis * 1000 {
655 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
658 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
659 match &msg.shutdown_scriptpubkey {
660 &OptionalField::Present(ref script) => {
661 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
662 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
664 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
665 } else if script.len() == 0 {
667 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
669 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
672 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
673 &OptionalField::Absent => {
674 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
681 config: local_config,
683 channel_id: msg.temporary_channel_id,
684 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
685 channel_outbound: false,
686 secp_ctx: Secp256k1::new(),
688 latest_monitor_update_id: 0,
690 local_keys: chan_keys,
691 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
692 destination_script: keys_provider.get_destination_script(),
694 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
695 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
696 value_to_self_msat: msg.push_msat,
698 pending_inbound_htlcs: Vec::new(),
699 pending_outbound_htlcs: Vec::new(),
700 holding_cell_htlc_updates: Vec::new(),
701 pending_update_fee: None,
702 holding_cell_update_fee: None,
703 next_local_htlc_id: 0,
704 next_remote_htlc_id: 0,
705 update_time_counter: 1,
707 resend_order: RAACommitmentOrder::CommitmentFirst,
709 monitor_pending_funding_locked: false,
710 monitor_pending_revoke_and_ack: false,
711 monitor_pending_commitment_signed: false,
712 monitor_pending_forwards: Vec::new(),
713 monitor_pending_failures: Vec::new(),
715 #[cfg(debug_assertions)]
716 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
717 #[cfg(debug_assertions)]
718 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
720 last_sent_closing_fee: None,
723 funding_tx_confirmed_in: None,
724 short_channel_id: None,
725 last_block_connected: Default::default(),
726 funding_tx_confirmations: 0,
728 feerate_per_kw: msg.feerate_per_kw as u64,
729 channel_value_satoshis: msg.funding_satoshis,
730 their_dust_limit_satoshis: msg.dust_limit_satoshis,
731 our_dust_limit_satoshis: our_dust_limit_satoshis,
732 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
733 local_channel_reserve_satoshis: msg.channel_reserve_satoshis,
734 their_htlc_minimum_msat: msg.htlc_minimum_msat,
735 our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
736 their_to_self_delay: msg.to_self_delay,
737 our_to_self_delay: config.own_channel_config.our_to_self_delay,
738 their_max_accepted_htlcs: msg.max_accepted_htlcs,
739 minimum_depth: config.own_channel_config.minimum_depth,
741 their_pubkeys: Some(their_pubkeys),
742 their_cur_commitment_point: Some(msg.first_per_commitment_point),
744 their_prev_commitment_point: None,
745 their_node_id: their_node_id,
747 their_shutdown_scriptpubkey,
749 channel_monitor: None,
750 commitment_secrets: CounterpartyCommitmentSecrets::new(),
752 network_sync: UpdateStatus::Fresh,
758 // Utilities to derive keys:
760 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
761 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), idx);
762 SecretKey::from_slice(&res).unwrap()
765 // Utilities to build transactions:
767 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
768 let mut sha = Sha256::engine();
769 let our_payment_point = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key());
771 let their_payment_point = &self.their_pubkeys.as_ref().unwrap().payment_point.serialize();
772 if self.channel_outbound {
773 sha.input(&our_payment_point.serialize());
774 sha.input(their_payment_point);
776 sha.input(their_payment_point);
777 sha.input(&our_payment_point.serialize());
779 let res = Sha256::from_engine(sha).into_inner();
781 ((res[26] as u64) << 5*8) |
782 ((res[27] as u64) << 4*8) |
783 ((res[28] as u64) << 3*8) |
784 ((res[29] as u64) << 2*8) |
785 ((res[30] as u64) << 1*8) |
786 ((res[31] as u64) << 0*8)
789 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
790 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
791 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
792 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
793 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
795 /// @local is used only to convert relevant internal structures which refer to remote vs local
796 /// to decide value of outputs and direction of HTLCs.
797 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
798 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
799 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
800 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
801 /// which peer generated this transaction and "to whom" this transaction flows.
802 /// Returns (the transaction built, the number of HTLC outputs which were present in the
803 /// transaction, the list of HTLCs which were not ignored when building the transaction).
804 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
805 /// sources are provided only for outbound HTLCs in the third return value.
807 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64, logger: &L) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
808 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
811 let mut ins: Vec<TxIn> = Vec::new();
813 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
814 script_sig: Script::new(),
815 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
821 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
822 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
824 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
825 let mut remote_htlc_total_msat = 0;
826 let mut local_htlc_total_msat = 0;
827 let mut value_to_self_msat_offset = 0;
829 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), self.get_commitment_transaction_number_obscure_factor(), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
831 macro_rules! get_htlc_in_commitment {
832 ($htlc: expr, $offered: expr) => {
833 HTLCOutputInCommitment {
835 amount_msat: $htlc.amount_msat,
836 cltv_expiry: $htlc.cltv_expiry,
837 payment_hash: $htlc.payment_hash,
838 transaction_output_index: None
843 macro_rules! add_htlc_output {
844 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
845 if $outbound == local { // "offered HTLC output"
846 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
847 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
848 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
850 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
851 value: $htlc.amount_msat / 1000
852 }, Some((htlc_in_tx, $source))));
854 log_trace!(logger, " ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
855 included_dust_htlcs.push((htlc_in_tx, $source));
858 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
859 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
860 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
861 txouts.push((TxOut { // "received HTLC output"
862 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
863 value: $htlc.amount_msat / 1000
864 }, Some((htlc_in_tx, $source))));
866 log_trace!(logger, " ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
867 included_dust_htlcs.push((htlc_in_tx, $source));
873 for ref htlc in self.pending_inbound_htlcs.iter() {
874 let (include, state_name) = match htlc.state {
875 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
876 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
877 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
878 InboundHTLCState::Committed => (true, "Committed"),
879 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
883 add_htlc_output!(htlc, false, None, state_name);
884 remote_htlc_total_msat += htlc.amount_msat;
886 log_trace!(logger, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
888 &InboundHTLCState::LocalRemoved(ref reason) => {
889 if generated_by_local {
890 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
891 value_to_self_msat_offset += htlc.amount_msat as i64;
900 for ref htlc in self.pending_outbound_htlcs.iter() {
901 let (include, state_name) = match htlc.state {
902 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
903 OutboundHTLCState::Committed => (true, "Committed"),
904 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
905 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
906 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
910 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
911 local_htlc_total_msat += htlc.amount_msat;
913 log_trace!(logger, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
915 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
916 value_to_self_msat_offset -= htlc.amount_msat as i64;
918 OutboundHTLCState::RemoteRemoved(None) => {
919 if !generated_by_local {
920 value_to_self_msat_offset -= htlc.amount_msat as i64;
928 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
929 assert!(value_to_self_msat >= 0);
930 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
931 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
932 // "violate" their reserve value by couting those against it. Thus, we have to convert
933 // everything to i64 before subtracting as otherwise we can overflow.
934 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
935 assert!(value_to_remote_msat >= 0);
937 #[cfg(debug_assertions)]
939 // Make sure that the to_self/to_remote is always either past the appropriate
940 // channel_reserve *or* it is making progress towards it.
941 let mut max_commitment_tx_output = if generated_by_local {
942 self.max_commitment_tx_output_local.lock().unwrap()
944 self.max_commitment_tx_output_remote.lock().unwrap()
946 debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.local_channel_reserve_satoshis as i64);
947 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
948 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
949 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
952 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
953 let (value_to_self, value_to_remote) = if self.channel_outbound {
954 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
956 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
959 let value_to_a = if local { value_to_self } else { value_to_remote };
960 let value_to_b = if local { value_to_remote } else { value_to_self };
962 if value_to_a >= (dust_limit_satoshis as i64) {
963 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
965 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
966 if local { self.their_to_self_delay } else { self.our_to_self_delay },
967 &keys.a_delayed_payment_key).to_v0_p2wsh(),
968 value: value_to_a as u64
972 if value_to_b >= (dust_limit_satoshis as i64) {
973 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
974 let static_payment_pk = if local {
975 self.their_pubkeys.as_ref().unwrap().payment_point
977 self.local_keys.pubkeys().payment_point
980 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
981 .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
983 value: value_to_b as u64
987 transaction_utils::sort_outputs(&mut txouts, |a, b| {
988 if let &Some(ref a_htlc) = a {
989 if let &Some(ref b_htlc) = b {
990 a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
991 // Note that due to hash collisions, we have to have a fallback comparison
992 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
994 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
995 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
996 // close the channel due to mismatches - they're doing something dumb:
997 } else { cmp::Ordering::Equal }
998 } else { cmp::Ordering::Equal }
1001 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
1002 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
1003 for (idx, mut out) in txouts.drain(..).enumerate() {
1004 outputs.push(out.0);
1005 if let Some((mut htlc, source_option)) = out.1.take() {
1006 htlc.transaction_output_index = Some(idx as u32);
1007 htlcs_included.push((htlc, source_option));
1010 let non_dust_htlc_count = htlcs_included.len();
1011 htlcs_included.append(&mut included_dust_htlcs);
1015 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1018 }, non_dust_htlc_count, htlcs_included)
1022 fn get_closing_scriptpubkey(&self) -> Script {
1023 let our_channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1024 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
1028 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
1029 (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)
1033 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1035 let mut ins: Vec<TxIn> = Vec::new();
1037 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
1038 script_sig: Script::new(),
1039 sequence: 0xffffffff,
1040 witness: Vec::new(),
1045 assert!(self.pending_inbound_htlcs.is_empty());
1046 assert!(self.pending_outbound_htlcs.is_empty());
1047 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1049 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1050 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1051 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 };
1053 if value_to_self < 0 {
1054 assert!(self.channel_outbound);
1055 total_fee_satoshis += (-value_to_self) as u64;
1056 } else if value_to_remote < 0 {
1057 assert!(!self.channel_outbound);
1058 total_fee_satoshis += (-value_to_remote) as u64;
1061 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1062 txouts.push((TxOut {
1063 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1064 value: value_to_remote as u64
1068 if value_to_self as u64 > self.our_dust_limit_satoshis {
1069 txouts.push((TxOut {
1070 script_pubkey: self.get_closing_scriptpubkey(),
1071 value: value_to_self as u64
1075 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1077 let mut outputs: Vec<TxOut> = Vec::new();
1078 for out in txouts.drain(..) {
1079 outputs.push(out.0);
1087 }, total_fee_satoshis)
1091 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1092 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1093 /// our counterparty!)
1094 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1095 /// TODO Some magic rust shit to compile-time check this?
1096 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1097 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1098 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key());
1099 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1100 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1102 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys"))
1106 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1107 /// will sign and send to our counterparty.
1108 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1109 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1110 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1111 //may see payments to it!
1112 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key());
1113 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1114 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1116 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &their_pubkeys.delayed_payment_basepoint, &their_pubkeys.htlc_basepoint, &revocation_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1119 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1120 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1121 /// Panics if called before accept_channel/new_from_req
1122 pub fn get_funding_redeemscript(&self) -> Script {
1123 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
1124 make_funding_redeemscript(&our_funding_key, self.their_funding_pubkey())
1127 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1128 /// @local is used only to convert relevant internal structures which refer to remote vs local
1129 /// to decide value of outputs and direction of HTLCs.
1130 fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1131 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { self.our_to_self_delay }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1134 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1135 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1136 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1138 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1139 /// but then have a reorg which settles on an HTLC-failure on chain.
1140 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1141 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1142 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1143 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1145 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1146 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1148 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1150 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1152 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1153 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1154 // these, but for now we just have to treat them as normal.
1156 let mut pending_idx = std::usize::MAX;
1157 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1158 if htlc.htlc_id == htlc_id_arg {
1159 assert_eq!(htlc.payment_hash, payment_hash_calc);
1161 InboundHTLCState::Committed => {},
1162 InboundHTLCState::LocalRemoved(ref reason) => {
1163 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1165 log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1167 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1168 return Ok((None, None));
1171 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1172 // Don't return in release mode here so that we can update channel_monitor
1179 if pending_idx == std::usize::MAX {
1180 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1183 // Now update local state:
1185 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1186 // can claim it even if the channel hits the chain before we see their next commitment.
1187 self.latest_monitor_update_id += 1;
1188 let monitor_update = ChannelMonitorUpdate {
1189 update_id: self.latest_monitor_update_id,
1190 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1191 payment_preimage: payment_preimage_arg.clone(),
1194 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
1196 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1197 for pending_update in self.holding_cell_htlc_updates.iter() {
1198 match pending_update {
1199 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1200 if htlc_id_arg == htlc_id {
1201 // Make sure we don't leave latest_monitor_update_id incremented here:
1202 self.latest_monitor_update_id -= 1;
1203 debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1204 return Ok((None, None));
1207 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1208 if htlc_id_arg == htlc_id {
1209 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1210 // TODO: We may actually be able to switch to a fulfill here, though its
1211 // rare enough it may not be worth the complexity burden.
1212 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1213 return Ok((None, Some(monitor_update)));
1219 log_trace!(logger, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1220 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1221 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1223 return Ok((None, Some(monitor_update)));
1227 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1228 if let InboundHTLCState::Committed = htlc.state {
1230 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1231 return Ok((None, Some(monitor_update)));
1233 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1234 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1237 Ok((Some(msgs::UpdateFulfillHTLC {
1238 channel_id: self.channel_id(),
1239 htlc_id: htlc_id_arg,
1240 payment_preimage: payment_preimage_arg,
1241 }), Some(monitor_update)))
1244 pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1245 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger)? {
1246 (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1247 let (commitment, mut additional_update) = self.send_commitment_no_status_check(logger)?;
1248 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1249 // strictly increasing by one, so decrement it here.
1250 self.latest_monitor_update_id = monitor_update.update_id;
1251 monitor_update.updates.append(&mut additional_update.updates);
1252 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1254 (Some(update_fulfill_htlc), None) => {
1255 let (commitment, monitor_update) = self.send_commitment_no_status_check(logger)?;
1256 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1258 (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1259 (None, None) => Ok((None, None))
1263 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1264 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1265 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1267 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1268 /// but then have a reorg which settles on an HTLC-failure on chain.
1269 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1270 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1271 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1273 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1275 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1276 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1277 // these, but for now we just have to treat them as normal.
1279 let mut pending_idx = std::usize::MAX;
1280 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1281 if htlc.htlc_id == htlc_id_arg {
1283 InboundHTLCState::Committed => {},
1284 InboundHTLCState::LocalRemoved(_) => {
1285 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1289 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1290 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1296 if pending_idx == std::usize::MAX {
1297 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1300 // Now update local state:
1301 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1302 for pending_update in self.holding_cell_htlc_updates.iter() {
1303 match pending_update {
1304 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1305 if htlc_id_arg == htlc_id {
1306 debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1307 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1310 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1311 if htlc_id_arg == htlc_id {
1312 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1313 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1319 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1320 htlc_id: htlc_id_arg,
1327 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1328 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1331 Ok(Some(msgs::UpdateFailHTLC {
1332 channel_id: self.channel_id(),
1333 htlc_id: htlc_id_arg,
1338 // Message handlers:
1340 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1341 // Check sanity of message fields:
1342 if !self.channel_outbound {
1343 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1345 if self.channel_state != ChannelState::OurInitSent as u32 {
1346 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1348 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1349 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1351 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1352 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1354 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1355 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1357 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1358 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1360 if msg.dust_limit_satoshis > Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) {
1361 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1363 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1364 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1366 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1367 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1369 if msg.max_accepted_htlcs < 1 {
1370 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1372 if msg.max_accepted_htlcs > 483 {
1373 return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1376 // Now check against optional parameters as set by config...
1377 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1378 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1380 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1381 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1383 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1384 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1386 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1387 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1389 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1390 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1392 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1393 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1395 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1396 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1399 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1400 match &msg.shutdown_scriptpubkey {
1401 &OptionalField::Present(ref script) => {
1402 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1403 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1404 Some(script.clone())
1405 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1406 } else if script.len() == 0 {
1408 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1410 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
1413 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1414 &OptionalField::Absent => {
1415 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
1420 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1421 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1422 self.local_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1423 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1424 self.their_to_self_delay = msg.to_self_delay;
1425 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1426 self.minimum_depth = msg.minimum_depth;
1428 let their_pubkeys = ChannelPublicKeys {
1429 funding_pubkey: msg.funding_pubkey,
1430 revocation_basepoint: msg.revocation_basepoint,
1431 payment_point: msg.payment_point,
1432 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1433 htlc_basepoint: msg.htlc_basepoint
1436 self.local_keys.set_remote_channel_pubkeys(&their_pubkeys);
1437 self.their_pubkeys = Some(their_pubkeys);
1439 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1440 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1442 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1447 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Transaction, LocalCommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1448 let funding_script = self.get_funding_redeemscript();
1450 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1451 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1452 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1454 // They sign the "local" commitment transaction...
1455 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_initial_commitment_tx), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1456 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, self.their_funding_pubkey()), "Invalid funding_created signature from peer");
1458 let localtx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx, sig.clone(), &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), self.their_funding_pubkey(), local_keys, self.feerate_per_kw, Vec::new());
1460 let remote_keys = self.build_remote_transaction_keys()?;
1461 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1462 let remote_signature = self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
1463 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0;
1465 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1466 Ok((remote_initial_commitment_tx, localtx, remote_signature))
1469 fn their_funding_pubkey(&self) -> &PublicKey {
1470 &self.their_pubkeys.as_ref().expect("their_funding_pubkey() only allowed after accept_channel").funding_pubkey
1473 pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<ChanSigner>), ChannelError> where L::Target: Logger {
1474 if self.channel_outbound {
1475 return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1477 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1478 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1479 // remember the channel, so it's safe to just send an error_message here and drop the
1481 return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1483 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1484 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1485 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1486 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1489 let funding_txo = OutPoint{ txid: msg.funding_txid, index: msg.funding_output_index };
1490 self.funding_txo = Some(funding_txo.clone());
1492 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature, logger) {
1495 self.funding_txo = None;
1500 // Now that we're past error-generating stuff, update our local state:
1502 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1503 let funding_redeemscript = self.get_funding_redeemscript();
1504 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1505 macro_rules! create_monitor {
1507 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1508 &self.shutdown_pubkey, self.our_to_self_delay,
1509 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1510 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1511 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1512 self.get_commitment_transaction_number_obscure_factor(),
1513 local_initial_commitment_tx.clone());
1515 channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap(), logger);
1520 self.channel_monitor = Some(create_monitor!());
1521 let channel_monitor = create_monitor!();
1523 self.channel_state = ChannelState::FundingSent as u32;
1524 self.channel_id = funding_txo.to_channel_id();
1525 self.cur_remote_commitment_transaction_number -= 1;
1526 self.cur_local_commitment_transaction_number -= 1;
1528 Ok((msgs::FundingSigned {
1529 channel_id: self.channel_id,
1530 signature: our_signature
1531 }, channel_monitor))
1534 /// Handles a funding_signed message from the remote end.
1535 /// If this call is successful, broadcast the funding transaction (and not before!)
1536 pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, logger: &L) -> Result<ChannelMonitor<ChanSigner>, ChannelError> where L::Target: Logger {
1537 if !self.channel_outbound {
1538 return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1540 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1541 return Err(ChannelError::Close("Received funding_signed in strange state!"));
1543 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1544 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1545 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1546 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1549 let funding_script = self.get_funding_redeemscript();
1551 let remote_keys = self.build_remote_transaction_keys()?;
1552 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1554 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1555 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1556 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1558 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1560 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1561 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, their_funding_pubkey) {
1562 return Err(ChannelError::Close("Invalid funding_signed signature from peer"));
1565 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1566 let funding_redeemscript = self.get_funding_redeemscript();
1567 let funding_txo = self.funding_txo.as_ref().unwrap();
1568 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1569 macro_rules! create_monitor {
1571 let local_commitment_tx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx.clone(), msg.signature.clone(), &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), their_funding_pubkey, local_keys.clone(), self.feerate_per_kw, Vec::new());
1572 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1573 &self.shutdown_pubkey, self.our_to_self_delay,
1574 &self.destination_script, (funding_txo.clone(), funding_txo_script.clone()),
1575 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1576 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1577 self.get_commitment_transaction_number_obscure_factor(),
1578 local_commitment_tx);
1580 channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap(), logger);
1586 self.channel_monitor = Some(create_monitor!());
1587 let channel_monitor = create_monitor!();
1589 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1590 self.channel_state = ChannelState::FundingSent as u32;
1591 self.cur_local_commitment_transaction_number -= 1;
1592 self.cur_remote_commitment_transaction_number -= 1;
1597 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1598 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1599 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1602 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1604 if non_shutdown_state == ChannelState::FundingSent as u32 {
1605 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1606 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1607 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1608 self.update_time_counter += 1;
1609 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1610 // Note that funding_signed/funding_created will have decremented both by 1!
1611 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1612 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1613 // If we reconnected before sending our funding locked they may still resend theirs:
1614 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1615 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1616 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1617 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1619 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1622 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1625 self.their_prev_commitment_point = self.their_cur_commitment_point;
1626 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1630 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1631 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1632 let mut htlc_inbound_value_msat = 0;
1633 for ref htlc in self.pending_inbound_htlcs.iter() {
1634 htlc_inbound_value_msat += htlc.amount_msat;
1636 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1639 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1641 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1642 let mut htlc_outbound_value_msat = 0;
1643 for ref htlc in self.pending_outbound_htlcs.iter() {
1644 htlc_outbound_value_msat += htlc.amount_msat;
1647 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1648 for update in self.holding_cell_htlc_updates.iter() {
1649 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1650 htlc_outbound_count += 1;
1651 htlc_outbound_value_msat += amount_msat;
1655 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1658 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1659 /// Doesn't bother handling the
1660 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1661 /// corner case properly.
1662 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1663 // Note that we have to handle overflow due to the above case.
1664 (cmp::min(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1665 cmp::min(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1668 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1669 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1670 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1672 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1673 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1675 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1676 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1678 if msg.amount_msat == 0 {
1679 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC"));
1681 if msg.amount_msat < self.our_htlc_minimum_msat {
1682 return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1685 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1686 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1687 return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1689 // Check our_max_htlc_value_in_flight_msat
1690 if htlc_inbound_value_msat + msg.amount_msat > Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1691 return Err(ChannelError::Close("Remote HTLC add would put them over our max HTLC value"));
1693 // Check remote_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1694 // the reserve_satoshis we told them to always have as direct payment so that they lose
1695 // something if we punish them for broadcasting an old state).
1696 // Note that we don't really care about having a small/no to_remote output in our local
1697 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1698 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1699 // present in the next commitment transaction we send them (at least for fulfilled ones,
1700 // failed ones won't modify value_to_self).
1701 // Note that we will send HTLCs which another instance of rust-lightning would think
1702 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1703 // Channel state once they will not be present in the next received commitment
1705 let mut removed_outbound_total_msat = 0;
1706 for ref htlc in self.pending_outbound_htlcs.iter() {
1707 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1708 removed_outbound_total_msat += htlc.amount_msat;
1709 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1710 removed_outbound_total_msat += htlc.amount_msat;
1713 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1714 return Err(ChannelError::Close("Remote HTLC add would put them under their reserve value"));
1716 if self.next_remote_htlc_id != msg.htlc_id {
1717 return Err(ChannelError::Close("Remote skipped HTLC ID"));
1719 if msg.cltv_expiry >= 500000000 {
1720 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1723 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1724 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1725 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1729 // Now update local state:
1730 self.next_remote_htlc_id += 1;
1731 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1732 htlc_id: msg.htlc_id,
1733 amount_msat: msg.amount_msat,
1734 payment_hash: msg.payment_hash,
1735 cltv_expiry: msg.cltv_expiry,
1736 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1741 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1743 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1744 for htlc in self.pending_outbound_htlcs.iter_mut() {
1745 if htlc.htlc_id == htlc_id {
1746 match check_preimage {
1748 Some(payment_hash) =>
1749 if payment_hash != htlc.payment_hash {
1750 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1754 OutboundHTLCState::LocalAnnounced(_) =>
1755 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1756 OutboundHTLCState::Committed => {
1757 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1759 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1760 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1762 return Ok(&htlc.source);
1765 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1768 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1769 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1770 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1772 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1773 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1776 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1777 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1780 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1781 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1782 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1784 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1785 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1788 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1792 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1793 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1794 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1796 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1797 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1800 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1804 pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
1805 where F::Target: FeeEstimator,
1808 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1809 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state")));
1811 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1812 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish")));
1814 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1815 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds")));
1818 let funding_script = self.get_funding_redeemscript();
1820 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1822 let mut update_fee = false;
1823 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1825 self.pending_update_fee.unwrap()
1830 let mut local_commitment_tx = {
1831 let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw, logger);
1832 let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1833 (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1835 let local_commitment_txid = local_commitment_tx.0.txid();
1836 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1837 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_commitment_tx.0), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1838 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1839 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer")));
1842 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1844 let num_htlcs = local_commitment_tx.1;
1845 let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1847 let remote_reserve_we_require = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
1848 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + remote_reserve_we_require {
1849 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee")));
1853 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1854 return Err((None, ChannelError::Close("Got wrong number of HTLC signatures from remote")));
1857 // TODO: Merge these two, sadly they are currently both required to be passed separately to
1859 let mut htlcs_without_source = Vec::with_capacity(local_commitment_tx.2.len());
1860 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1861 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1862 if let Some(_) = htlc.transaction_output_index {
1863 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1864 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1865 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1866 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript));
1867 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
1868 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer")));
1870 htlcs_without_source.push((htlc.clone(), Some(msg.htlc_signatures[idx])));
1871 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
1873 htlcs_without_source.push((htlc.clone(), None));
1874 htlcs_and_sigs.push((htlc, None, source));
1878 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1879 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 1);
1881 // Update state now that we've passed all the can-fail calls...
1882 let mut need_our_commitment = false;
1883 if !self.channel_outbound {
1884 if let Some(fee_update) = self.pending_update_fee {
1885 self.feerate_per_kw = fee_update;
1886 // We later use the presence of pending_update_fee to indicate we should generate a
1887 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1888 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1889 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1890 need_our_commitment = true;
1891 self.pending_update_fee = None;
1896 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1898 self.latest_monitor_update_id += 1;
1899 let mut monitor_update = ChannelMonitorUpdate {
1900 update_id: self.latest_monitor_update_id,
1901 updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
1902 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_commitment_tx.0, msg.signature.clone(), &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), &their_funding_pubkey, local_keys, self.feerate_per_kw, htlcs_without_source),
1903 htlc_outputs: htlcs_and_sigs
1906 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
1908 for htlc in self.pending_inbound_htlcs.iter_mut() {
1909 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1910 Some(forward_info.clone())
1912 if let Some(forward_info) = new_forward {
1913 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1914 need_our_commitment = true;
1917 for htlc in self.pending_outbound_htlcs.iter_mut() {
1918 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1919 Some(fail_reason.take())
1921 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1922 need_our_commitment = true;
1926 self.cur_local_commitment_transaction_number -= 1;
1927 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1928 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1929 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1931 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1932 // In case we initially failed monitor updating without requiring a response, we need
1933 // to make sure the RAA gets sent first.
1934 self.monitor_pending_revoke_and_ack = true;
1935 if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1936 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1937 // the corresponding HTLC status updates so that get_last_commitment_update
1938 // includes the right HTLCs.
1939 self.monitor_pending_commitment_signed = true;
1940 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
1941 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1942 // strictly increasing by one, so decrement it here.
1943 self.latest_monitor_update_id = monitor_update.update_id;
1944 monitor_update.updates.append(&mut additional_update.updates);
1946 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1947 // re-send the message on restoration)
1948 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA")));
1951 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1952 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1953 // we'll send one right away when we get the revoke_and_ack when we
1954 // free_holding_cell_htlcs().
1955 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
1956 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1957 // strictly increasing by one, so decrement it here.
1958 self.latest_monitor_update_id = monitor_update.update_id;
1959 monitor_update.updates.append(&mut additional_update.updates);
1961 } else if !need_our_commitment {
1962 (None, self.maybe_propose_first_closing_signed(fee_estimator))
1963 } else { (None, None) };
1965 Ok((msgs::RevokeAndACK {
1966 channel_id: self.channel_id,
1967 per_commitment_secret: per_commitment_secret,
1968 next_per_commitment_point: next_per_commitment_point,
1969 }, our_commitment_signed, closing_signed, monitor_update))
1972 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1973 /// fulfilling or failing the last pending HTLC)
1974 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
1975 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1976 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1977 log_trace!(logger, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
1979 let mut monitor_update = ChannelMonitorUpdate {
1980 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
1981 updates: Vec::new(),
1984 let mut htlc_updates = Vec::new();
1985 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1986 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1987 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1988 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1990 for htlc_update in htlc_updates.drain(..) {
1991 // Note that this *can* fail, though it should be due to rather-rare conditions on
1992 // fee races with adding too many outputs which push our total payments just over
1993 // the limit. In case it's less rare than I anticipate, we may want to revisit
1994 // handling this case better and maybe fulfilling some of the HTLCs while attempting
1995 // to rebalance channels.
1996 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1997 self.holding_cell_htlc_updates.push(htlc_update);
1999 match &htlc_update {
2000 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2001 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2002 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2005 ChannelError::Ignore(ref msg) => {
2006 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2009 log_info!(logger, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
2016 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2017 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2018 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2019 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2020 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2021 monitor_update.updates.append(&mut additional_monitor_update.updates);
2025 if let ChannelError::Ignore(_) = e {}
2027 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2032 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2033 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2034 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2036 if let ChannelError::Ignore(_) = e {}
2038 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2045 self.holding_cell_htlc_updates.push(htlc_update);
2046 if let Some(ChannelError::Ignore(_)) = err {
2047 // If we failed to add the HTLC, but got an Ignore error, we should
2048 // still send the new commitment_signed, so reset the err to None.
2054 //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2055 //fail it back the route, if it's a temporary issue we can ignore it...
2058 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2059 // This should never actually happen and indicates we got some Errs back
2060 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2061 // case there is some strange way to hit duplicate HTLC removes.
2064 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2065 self.pending_update_fee = self.holding_cell_update_fee.take();
2066 Some(msgs::UpdateFee {
2067 channel_id: self.channel_id,
2068 feerate_per_kw: feerate as u32,
2074 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2075 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2076 // but we want them to be strictly increasing by one, so reset it here.
2077 self.latest_monitor_update_id = monitor_update.update_id;
2078 monitor_update.updates.append(&mut additional_update.updates);
2080 Ok(Some((msgs::CommitmentUpdate {
2082 update_fulfill_htlcs,
2084 update_fail_malformed_htlcs: Vec::new(),
2085 update_fee: update_fee,
2087 }, monitor_update)))
2096 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2097 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2098 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2099 /// generating an appropriate error *after* the channel state has been updated based on the
2100 /// revoke_and_ack message.
2101 pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), ChannelError>
2102 where F::Target: FeeEstimator,
2105 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2106 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2108 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2109 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2111 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2112 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2115 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2116 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
2117 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2121 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2122 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2123 // haven't given them a new commitment transaction to broadcast). We should probably
2124 // take advantage of this by updating our channel monitor, sending them an error, and
2125 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2126 // lot of work, and there's some chance this is all a misunderstanding anyway.
2127 // We have to do *something*, though, since our signer may get mad at us for otherwise
2128 // jumping a remote commitment number, so best to just force-close and move on.
2129 return Err(ChannelError::Close("Received an unexpected revoke_and_ack"));
2132 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2133 .map_err(|_| ChannelError::Close("Previous secrets did not match new one"))?;
2134 self.latest_monitor_update_id += 1;
2135 let mut monitor_update = ChannelMonitorUpdate {
2136 update_id: self.latest_monitor_update_id,
2137 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2138 idx: self.cur_remote_commitment_transaction_number + 1,
2139 secret: msg.per_commitment_secret,
2142 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
2144 // Update state now that we've passed all the can-fail calls...
2145 // (note that we may still fail to generate the new commitment_signed message, but that's
2146 // OK, we step the channel here and *then* if the new generation fails we can fail the
2147 // channel based on that, but stepping stuff here should be safe either way.
2148 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2149 self.their_prev_commitment_point = self.their_cur_commitment_point;
2150 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2151 self.cur_remote_commitment_transaction_number -= 1;
2153 log_trace!(logger, "Updating HTLCs on receipt of RAA...");
2154 let mut to_forward_infos = Vec::new();
2155 let mut revoked_htlcs = Vec::new();
2156 let mut update_fail_htlcs = Vec::new();
2157 let mut update_fail_malformed_htlcs = Vec::new();
2158 let mut require_commitment = false;
2159 let mut value_to_self_msat_diff: i64 = 0;
2162 // Take references explicitly so that we can hold multiple references to self.
2163 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2164 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2166 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2167 pending_inbound_htlcs.retain(|htlc| {
2168 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2169 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2170 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2171 value_to_self_msat_diff += htlc.amount_msat as i64;
2176 pending_outbound_htlcs.retain(|htlc| {
2177 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2178 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2179 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2180 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2182 // They fulfilled, so we sent them money
2183 value_to_self_msat_diff -= htlc.amount_msat as i64;
2188 for htlc in pending_inbound_htlcs.iter_mut() {
2189 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2190 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2192 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2193 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2197 let mut state = InboundHTLCState::Committed;
2198 mem::swap(&mut state, &mut htlc.state);
2200 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2201 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2202 require_commitment = true;
2203 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2204 match forward_info {
2205 PendingHTLCStatus::Fail(fail_msg) => {
2206 require_commitment = true;
2208 HTLCFailureMsg::Relay(msg) => {
2209 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2210 update_fail_htlcs.push(msg)
2212 HTLCFailureMsg::Malformed(msg) => {
2213 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2214 update_fail_malformed_htlcs.push(msg)
2218 PendingHTLCStatus::Forward(forward_info) => {
2219 to_forward_infos.push((forward_info, htlc.htlc_id));
2220 htlc.state = InboundHTLCState::Committed;
2226 for htlc in pending_outbound_htlcs.iter_mut() {
2227 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2228 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2229 htlc.state = OutboundHTLCState::Committed;
2231 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2232 Some(fail_reason.take())
2234 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2235 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2236 require_commitment = true;
2240 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2242 if self.channel_outbound {
2243 if let Some(feerate) = self.pending_update_fee.take() {
2244 self.feerate_per_kw = feerate;
2247 if let Some(feerate) = self.pending_update_fee {
2248 // Because a node cannot send two commitment_signeds in a row without getting a
2249 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2250 // it should use to create keys with) and because a node can't send a
2251 // commitment_signed without changes, checking if the feerate is equal to the
2252 // pending feerate update is sufficient to detect require_commitment.
2253 if feerate == self.feerate_per_kw {
2254 require_commitment = true;
2255 self.pending_update_fee = None;
2260 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2261 // We can't actually generate a new commitment transaction (incl by freeing holding
2262 // cells) while we can't update the monitor, so we just return what we have.
2263 if require_commitment {
2264 self.monitor_pending_commitment_signed = true;
2265 // When the monitor updating is restored we'll call get_last_commitment_update(),
2266 // which does not update state, but we're definitely now awaiting a remote revoke
2267 // before we can step forward any more, so set it here.
2268 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2269 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2270 // strictly increasing by one, so decrement it here.
2271 self.latest_monitor_update_id = monitor_update.update_id;
2272 monitor_update.updates.append(&mut additional_update.updates);
2274 self.monitor_pending_forwards.append(&mut to_forward_infos);
2275 self.monitor_pending_failures.append(&mut revoked_htlcs);
2276 return Ok((None, Vec::new(), Vec::new(), None, monitor_update))
2279 match self.free_holding_cell_htlcs(logger)? {
2280 Some((mut commitment_update, mut additional_update)) => {
2281 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2282 for fail_msg in update_fail_htlcs.drain(..) {
2283 commitment_update.update_fail_htlcs.push(fail_msg);
2285 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2286 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2287 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2290 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2291 // strictly increasing by one, so decrement it here.
2292 self.latest_monitor_update_id = monitor_update.update_id;
2293 monitor_update.updates.append(&mut additional_update.updates);
2295 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update))
2298 if require_commitment {
2299 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2301 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2302 // strictly increasing by one, so decrement it here.
2303 self.latest_monitor_update_id = monitor_update.update_id;
2304 monitor_update.updates.append(&mut additional_update.updates);
2306 Ok((Some(msgs::CommitmentUpdate {
2307 update_add_htlcs: Vec::new(),
2308 update_fulfill_htlcs: Vec::new(),
2310 update_fail_malformed_htlcs,
2313 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2315 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update))
2322 /// Adds a pending update to this channel. See the doc for send_htlc for
2323 /// further details on the optionness of the return value.
2324 /// You MUST call send_commitment prior to any other calls on this Channel
2325 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2326 if !self.channel_outbound {
2327 panic!("Cannot send fee from inbound channel");
2329 if !self.is_usable() {
2330 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2332 if !self.is_live() {
2333 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2336 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2337 self.holding_cell_update_fee = Some(feerate_per_kw);
2341 debug_assert!(self.pending_update_fee.is_none());
2342 self.pending_update_fee = Some(feerate_per_kw);
2344 Some(msgs::UpdateFee {
2345 channel_id: self.channel_id,
2346 feerate_per_kw: feerate_per_kw as u32,
2350 pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u64, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2351 match self.send_update_fee(feerate_per_kw) {
2352 Some(update_fee) => {
2353 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2354 Ok(Some((update_fee, commitment_signed, monitor_update)))
2360 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2361 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2362 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2363 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2364 /// No further message handling calls may be made until a channel_reestablish dance has
2366 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Vec<(HTLCSource, PaymentHash)> where L::Target: Logger {
2367 let mut outbound_drops = Vec::new();
2369 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2370 if self.channel_state < ChannelState::FundingSent as u32 {
2371 self.channel_state = ChannelState::ShutdownComplete as u32;
2372 return outbound_drops;
2374 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2375 // will be retransmitted.
2376 self.last_sent_closing_fee = None;
2378 let mut inbound_drop_count = 0;
2379 self.pending_inbound_htlcs.retain(|htlc| {
2381 InboundHTLCState::RemoteAnnounced(_) => {
2382 // They sent us an update_add_htlc but we never got the commitment_signed.
2383 // We'll tell them what commitment_signed we're expecting next and they'll drop
2384 // this HTLC accordingly
2385 inbound_drop_count += 1;
2388 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2389 // We received a commitment_signed updating this HTLC and (at least hopefully)
2390 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2391 // in response to it yet, so don't touch it.
2394 InboundHTLCState::Committed => true,
2395 InboundHTLCState::LocalRemoved(_) => {
2396 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2397 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2398 // (that we missed). Keep this around for now and if they tell us they missed
2399 // the commitment_signed we can re-transmit the update then.
2404 self.next_remote_htlc_id -= inbound_drop_count;
2406 for htlc in self.pending_outbound_htlcs.iter_mut() {
2407 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2408 // They sent us an update to remove this but haven't yet sent the corresponding
2409 // commitment_signed, we need to move it back to Committed and they can re-send
2410 // the update upon reconnection.
2411 htlc.state = OutboundHTLCState::Committed;
2415 self.holding_cell_htlc_updates.retain(|htlc_update| {
2417 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2418 outbound_drops.push((source.clone(), payment_hash.clone()));
2421 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2424 self.channel_state |= ChannelState::PeerDisconnected as u32;
2425 log_debug!(logger, "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()));
2429 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2430 /// updates are partially paused.
2431 /// This must be called immediately after the call which generated the ChannelMonitor update
2432 /// which failed. The messages which were generated from that call which generated the
2433 /// monitor update failure must *not* have been sent to the remote end, and must instead
2434 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2435 pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2436 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2437 self.monitor_pending_revoke_and_ack = resend_raa;
2438 self.monitor_pending_commitment_signed = resend_commitment;
2439 assert!(self.monitor_pending_forwards.is_empty());
2440 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2441 assert!(self.monitor_pending_failures.is_empty());
2442 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2443 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2446 /// Indicates that the latest ChannelMonitor update has been committed by the client
2447 /// successfully and we should restore normal operation. Returns messages which should be sent
2448 /// to the remote side.
2449 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) where L::Target: Logger {
2450 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2451 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2453 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2455 // Because we will never generate a FundingBroadcastSafe event when we're in
2456 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2457 // they received the FundingBroadcastSafe event, we can only ever hit
2458 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2459 // monitor on funding_created, and we even got the funding transaction confirmed before the
2460 // monitor was persisted.
2461 let funding_locked = if self.monitor_pending_funding_locked {
2462 assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2463 self.monitor_pending_funding_locked = false;
2464 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2465 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2466 Some(msgs::FundingLocked {
2467 channel_id: self.channel_id(),
2468 next_per_commitment_point: next_per_commitment_point,
2472 let mut forwards = Vec::new();
2473 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2474 let mut failures = Vec::new();
2475 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2477 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2478 self.monitor_pending_revoke_and_ack = false;
2479 self.monitor_pending_commitment_signed = false;
2480 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2483 let raa = if self.monitor_pending_revoke_and_ack {
2484 Some(self.get_last_revoke_and_ack())
2486 let commitment_update = if self.monitor_pending_commitment_signed {
2487 Some(self.get_last_commitment_update(logger))
2490 self.monitor_pending_revoke_and_ack = false;
2491 self.monitor_pending_commitment_signed = false;
2492 let order = self.resend_order.clone();
2493 log_trace!(logger, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2494 if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2495 if commitment_update.is_some() { "a" } else { "no" },
2496 if raa.is_some() { "an" } else { "no" },
2497 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2498 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2501 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2502 where F::Target: FeeEstimator
2504 if self.channel_outbound {
2505 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2507 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2508 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2510 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2511 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2512 self.update_time_counter += 1;
2516 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2517 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2518 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 2);
2519 msgs::RevokeAndACK {
2520 channel_id: self.channel_id,
2521 per_commitment_secret,
2522 next_per_commitment_point,
2526 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2527 let mut update_add_htlcs = Vec::new();
2528 let mut update_fulfill_htlcs = Vec::new();
2529 let mut update_fail_htlcs = Vec::new();
2530 let mut update_fail_malformed_htlcs = Vec::new();
2532 for htlc in self.pending_outbound_htlcs.iter() {
2533 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2534 update_add_htlcs.push(msgs::UpdateAddHTLC {
2535 channel_id: self.channel_id(),
2536 htlc_id: htlc.htlc_id,
2537 amount_msat: htlc.amount_msat,
2538 payment_hash: htlc.payment_hash,
2539 cltv_expiry: htlc.cltv_expiry,
2540 onion_routing_packet: (**onion_packet).clone(),
2545 for htlc in self.pending_inbound_htlcs.iter() {
2546 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2548 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2549 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2550 channel_id: self.channel_id(),
2551 htlc_id: htlc.htlc_id,
2552 reason: err_packet.clone()
2555 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2556 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2557 channel_id: self.channel_id(),
2558 htlc_id: htlc.htlc_id,
2559 sha256_of_onion: sha256_of_onion.clone(),
2560 failure_code: failure_code.clone(),
2563 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2564 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2565 channel_id: self.channel_id(),
2566 htlc_id: htlc.htlc_id,
2567 payment_preimage: payment_preimage.clone(),
2574 log_trace!(logger, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2575 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2576 msgs::CommitmentUpdate {
2577 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2579 commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2583 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2584 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2585 pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
2586 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2587 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2588 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2589 // just close here instead of trying to recover.
2590 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2593 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2594 msg.next_local_commitment_number == 0 {
2595 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2598 if msg.next_remote_commitment_number > 0 {
2599 match msg.data_loss_protect {
2600 OptionalField::Present(ref data_loss) => {
2601 if chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1) != data_loss.your_last_per_commitment_secret {
2602 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided"));
2604 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2605 return Err(ChannelError::CloseDelayBroadcast(
2606 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting"
2610 OptionalField::Absent => {}
2614 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2615 // remaining cases either succeed or ErrorMessage-fail).
2616 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2618 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2619 Some(msgs::Shutdown {
2620 channel_id: self.channel_id,
2621 scriptpubkey: self.get_closing_scriptpubkey(),
2625 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2626 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2627 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2628 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2629 if msg.next_remote_commitment_number != 0 {
2630 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2632 // Short circuit the whole handler as there is nothing we can resend them
2633 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2636 // We have OurFundingLocked set!
2637 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2638 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2639 return Ok((Some(msgs::FundingLocked {
2640 channel_id: self.channel_id(),
2641 next_per_commitment_point: next_per_commitment_point,
2642 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2645 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2646 // Remote isn't waiting on any RevokeAndACK from us!
2647 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2649 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2650 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2651 self.monitor_pending_revoke_and_ack = true;
2654 Some(self.get_last_revoke_and_ack())
2657 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2660 // We increment cur_remote_commitment_transaction_number only upon receipt of
2661 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2662 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2663 // the corresponding revoke_and_ack back yet.
2664 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 };
2666 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2667 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2668 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2669 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2670 Some(msgs::FundingLocked {
2671 channel_id: self.channel_id(),
2672 next_per_commitment_point: next_per_commitment_point,
2676 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2677 if required_revoke.is_some() {
2678 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2680 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2683 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2684 // We're up-to-date and not waiting on a remote revoke (if we are our
2685 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2686 // have received some updates while we were disconnected. Free the holding cell
2688 match self.free_holding_cell_htlcs(logger) {
2689 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2690 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2691 Ok(Some((commitment_update, monitor_update))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg)),
2692 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2695 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2697 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2698 if required_revoke.is_some() {
2699 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2701 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2704 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2705 self.monitor_pending_commitment_signed = true;
2706 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2709 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), shutdown_msg));
2711 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2715 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2716 where F::Target: FeeEstimator
2718 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2719 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2720 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2724 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2725 if self.feerate_per_kw > proposed_feerate {
2726 proposed_feerate = self.feerate_per_kw;
2728 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2729 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2731 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2732 let our_sig = self.local_keys
2733 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2735 if our_sig.is_none() { return None; }
2737 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2738 Some(msgs::ClosingSigned {
2739 channel_id: self.channel_id,
2740 fee_satoshis: total_fee_satoshis,
2741 signature: our_sig.unwrap(),
2745 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2746 where F::Target: FeeEstimator
2748 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2749 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2751 if self.channel_state < ChannelState::FundingSent as u32 {
2752 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2753 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2754 // can do that via error message without getting a connection fail anyway...
2755 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2757 for htlc in self.pending_inbound_htlcs.iter() {
2758 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2759 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2762 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2764 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2765 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2766 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2767 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2770 //Check shutdown_scriptpubkey form as BOLT says we must
2771 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2772 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2775 if self.their_shutdown_scriptpubkey.is_some() {
2776 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2777 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2780 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2783 // From here on out, we may not fail!
2785 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2786 self.update_time_counter += 1;
2788 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2789 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2790 // cell HTLCs and return them to fail the payment.
2791 self.holding_cell_update_fee = None;
2792 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2793 self.holding_cell_htlc_updates.retain(|htlc_update| {
2795 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2796 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2802 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2803 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2804 // any further commitment updates after we set LocalShutdownSent.
2806 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2809 Some(msgs::Shutdown {
2810 channel_id: self.channel_id,
2811 scriptpubkey: self.get_closing_scriptpubkey(),
2815 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2816 self.update_time_counter += 1;
2818 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2821 fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2822 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2823 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2824 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2826 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2828 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()).serialize();
2829 let their_funding_key = self.their_funding_pubkey().serialize();
2830 if our_funding_key[..] < their_funding_key[..] {
2831 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2832 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2834 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2835 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2837 tx.input[0].witness[1].push(SigHashType::All as u8);
2838 tx.input[0].witness[2].push(SigHashType::All as u8);
2840 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2843 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2844 where F::Target: FeeEstimator
2846 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2847 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2849 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2850 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2852 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2853 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2855 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2856 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2859 let funding_redeemscript = self.get_funding_redeemscript();
2860 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2861 if used_total_fee != msg.fee_satoshis {
2862 return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2864 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2866 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2868 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
2871 // The remote end may have decided to revoke their output due to inconsistent dust
2872 // limits, so check for that case by re-checking the signature here.
2873 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2874 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2875 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer");
2879 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
2880 if last_fee == msg.fee_satoshis {
2881 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2882 self.channel_state = ChannelState::ShutdownComplete as u32;
2883 self.update_time_counter += 1;
2884 return Ok((None, Some(closing_tx)));
2888 macro_rules! propose_new_feerate {
2889 ($new_feerate: expr) => {
2890 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2891 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2892 let our_sig = self.local_keys
2893 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2894 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2895 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
2896 return Ok((Some(msgs::ClosingSigned {
2897 channel_id: self.channel_id,
2898 fee_satoshis: used_total_fee,
2904 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight() as u64;
2905 if self.channel_outbound {
2906 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2907 if proposed_sat_per_kw > our_max_feerate {
2908 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2909 if our_max_feerate <= last_feerate {
2910 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2913 propose_new_feerate!(our_max_feerate);
2916 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2917 if proposed_sat_per_kw < our_min_feerate {
2918 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2919 if our_min_feerate >= last_feerate {
2920 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2923 propose_new_feerate!(our_min_feerate);
2927 let our_sig = self.local_keys
2928 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2929 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2930 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2932 self.channel_state = ChannelState::ShutdownComplete as u32;
2933 self.update_time_counter += 1;
2935 Ok((Some(msgs::ClosingSigned {
2936 channel_id: self.channel_id,
2937 fee_satoshis: msg.fee_satoshis,
2939 }), Some(closing_tx)))
2942 // Public utilities:
2944 pub fn channel_id(&self) -> [u8; 32] {
2948 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2949 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2950 pub fn get_user_id(&self) -> u64 {
2954 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2955 pub fn channel_monitor(&mut self) -> &mut ChannelMonitor<ChanSigner> {
2956 if self.channel_state < ChannelState::FundingSent as u32 {
2957 panic!("Can't get a channel monitor until funding has been created");
2959 self.channel_monitor.as_mut().unwrap()
2962 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2963 /// is_usable() returns true).
2964 /// Allowed in any state (including after shutdown)
2965 pub fn get_short_channel_id(&self) -> Option<u64> {
2966 self.short_channel_id
2969 /// Returns the funding_txo we either got from our peer, or were given by
2970 /// get_outbound_funding_created.
2971 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2975 /// Allowed in any state (including after shutdown)
2976 pub fn get_their_node_id(&self) -> PublicKey {
2980 /// Allowed in any state (including after shutdown)
2981 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2982 self.our_htlc_minimum_msat
2985 /// Allowed in any state (including after shutdown)
2986 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2987 self.our_htlc_minimum_msat
2990 pub fn get_value_satoshis(&self) -> u64 {
2991 self.channel_value_satoshis
2994 pub fn get_fee_proportional_millionths(&self) -> u32 {
2995 self.config.fee_proportional_millionths
2999 pub fn get_feerate(&self) -> u64 {
3003 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
3004 self.cur_local_commitment_transaction_number + 1
3007 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
3008 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3011 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
3012 self.cur_remote_commitment_transaction_number + 2
3016 pub fn get_local_keys(&self) -> &ChanSigner {
3021 pub fn get_value_stat(&self) -> ChannelValueStat {
3023 value_to_self_msat: self.value_to_self_msat,
3024 channel_value_msat: self.channel_value_satoshis * 1000,
3025 channel_reserve_msat: self.local_channel_reserve_satoshis * 1000,
3026 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3027 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3028 holding_cell_outbound_amount_msat: {
3030 for h in self.holding_cell_htlc_updates.iter() {
3032 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3040 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3044 /// Allowed in any state (including after shutdown)
3045 pub fn get_update_time_counter(&self) -> u32 {
3046 self.update_time_counter
3049 pub fn get_latest_monitor_update_id(&self) -> u64 {
3050 self.latest_monitor_update_id
3053 pub fn should_announce(&self) -> bool {
3054 self.config.announced_channel
3057 pub fn is_outbound(&self) -> bool {
3058 self.channel_outbound
3061 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3062 /// Allowed in any state (including after shutdown)
3063 pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3064 where F::Target: FeeEstimator
3066 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3067 // output value back into a transaction with the regular channel output:
3069 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3070 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3072 if self.channel_outbound {
3073 // + the marginal fee increase cost to us in the commitment transaction:
3074 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3077 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3078 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3083 /// Returns true if we've ever received a message from the remote end for this Channel
3084 pub fn have_received_message(&self) -> bool {
3085 self.channel_state > (ChannelState::OurInitSent as u32)
3088 /// Returns true if this channel is fully established and not known to be closing.
3089 /// Allowed in any state (including after shutdown)
3090 pub fn is_usable(&self) -> bool {
3091 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3092 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3095 /// Returns true if this channel is currently available for use. This is a superset of
3096 /// is_usable() and considers things like the channel being temporarily disabled.
3097 /// Allowed in any state (including after shutdown)
3098 pub fn is_live(&self) -> bool {
3099 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3102 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3103 /// Allowed in any state (including after shutdown)
3104 pub fn is_awaiting_monitor_update(&self) -> bool {
3105 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3108 /// Returns true if funding_created was sent/received.
3109 pub fn is_funding_initiated(&self) -> bool {
3110 self.channel_state >= ChannelState::FundingSent as u32
3113 /// Returns true if this channel is fully shut down. True here implies that no further actions
3114 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3115 /// will be handled appropriately by the chain monitor.
3116 pub fn is_shutdown(&self) -> bool {
3117 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3118 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3123 pub fn to_disabled_staged(&mut self) {
3124 self.network_sync = UpdateStatus::DisabledStaged;
3127 pub fn to_disabled_marked(&mut self) {
3128 self.network_sync = UpdateStatus::DisabledMarked;
3131 pub fn to_fresh(&mut self) {
3132 self.network_sync = UpdateStatus::Fresh;
3135 pub fn is_disabled_staged(&self) -> bool {
3136 self.network_sync == UpdateStatus::DisabledStaged
3139 pub fn is_disabled_marked(&self) -> bool {
3140 self.network_sync == UpdateStatus::DisabledMarked
3143 /// When we receive a new block, we (a) check whether the block contains the funding
3144 /// transaction (which would start us counting blocks until we send the funding_signed), and
3145 /// (b) check the height of the block against outbound holding cell HTLCs in case we need to
3146 /// give up on them prematurely and time them out. Everything else (e.g. commitment
3147 /// transaction broadcasts, channel closure detection, HTLC transaction broadcasting, etc) is
3148 /// handled by the ChannelMonitor.
3150 /// If we return Err, the channel may have been closed, at which point the standard
3151 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3153 /// Only returns an ErrorAction of DisconnectPeer, if Err.
3155 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3157 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
3158 let mut timed_out_htlcs = Vec::new();
3159 self.holding_cell_htlc_updates.retain(|htlc_update| {
3161 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3162 if *cltv_expiry <= height + HTLC_FAIL_BACK_BUFFER {
3163 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3170 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3171 if header.bitcoin_hash() != self.last_block_connected {
3172 if self.funding_tx_confirmations > 0 {
3173 self.funding_tx_confirmations += 1;
3176 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3177 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3178 if tx.txid() == self.funding_txo.unwrap().txid {
3179 let txo_idx = self.funding_txo.unwrap().index as usize;
3180 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3181 tx.output[txo_idx].value != self.channel_value_satoshis {
3182 if self.channel_outbound {
3183 // If we generated the funding transaction and it doesn't match what it
3184 // should, the client is really broken and we should just panic and
3185 // tell them off. That said, because hash collisions happen with high
3186 // probability in fuzztarget mode, if we're fuzzing we just close the
3187 // channel and move on.
3188 #[cfg(not(feature = "fuzztarget"))]
3189 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3191 self.channel_state = ChannelState::ShutdownComplete as u32;
3192 self.update_time_counter += 1;
3193 return Err(msgs::ErrorMessage {
3194 channel_id: self.channel_id(),
3195 data: "funding tx had wrong script/value".to_owned()
3198 if self.channel_outbound {
3199 for input in tx.input.iter() {
3200 if input.witness.is_empty() {
3201 // We generated a malleable funding transaction, implying we've
3202 // just exposed ourselves to funds loss to our counterparty.
3203 #[cfg(not(feature = "fuzztarget"))]
3204 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3208 self.funding_tx_confirmations = 1;
3209 self.short_channel_id = Some(((height as u64) << (5*8)) |
3210 ((*index_in_block as u64) << (2*8)) |
3211 ((txo_idx as u64) << (0*8)));
3216 if header.bitcoin_hash() != self.last_block_connected {
3217 self.last_block_connected = header.bitcoin_hash();
3218 self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3219 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3220 channel_monitor.last_block_hash = self.last_block_connected;
3222 if self.funding_tx_confirmations > 0 {
3223 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3224 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3225 self.channel_state |= ChannelState::OurFundingLocked as u32;
3227 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3228 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3229 self.update_time_counter += 1;
3231 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3232 // We got a reorg but not enough to trigger a force close, just update
3233 // funding_tx_confirmed_in and return.
3235 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3236 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3238 // We got a reorg but not enough to trigger a force close, just update
3239 // funding_tx_confirmed_in and return.
3242 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3244 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3245 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3246 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3247 //a protocol oversight, but I assume I'm just missing something.
3248 if need_commitment_update {
3249 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3250 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3251 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
3252 return Ok((Some(msgs::FundingLocked {
3253 channel_id: self.channel_id,
3254 next_per_commitment_point: next_per_commitment_point,
3255 }), timed_out_htlcs));
3257 self.monitor_pending_funding_locked = true;
3258 return Ok((None, timed_out_htlcs));
3264 Ok((None, timed_out_htlcs))
3267 /// Called by channelmanager based on chain blocks being disconnected.
3268 /// Returns true if we need to close the channel now due to funding transaction
3269 /// unconfirmation/reorg.
3270 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3271 if self.funding_tx_confirmations > 0 {
3272 self.funding_tx_confirmations -= 1;
3273 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3277 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3278 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3280 self.last_block_connected = header.bitcoin_hash();
3281 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3282 channel_monitor.last_block_hash = self.last_block_connected;
3287 // Methods to get unprompted messages to send to the remote end (or where we already returned
3288 // something in the handler for the message that prompted this message):
3290 pub fn get_open_channel<F: Deref>(&self, chain_hash: BlockHash, fee_estimator: &F) -> msgs::OpenChannel
3291 where F::Target: FeeEstimator
3293 if !self.channel_outbound {
3294 panic!("Tried to open a channel for an inbound channel?");
3296 if self.channel_state != ChannelState::OurInitSent as u32 {
3297 panic!("Cannot generate an open_channel after we've moved forward");
3300 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3301 panic!("Tried to send an open_channel for a channel that has already advanced");
3304 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3307 chain_hash: chain_hash,
3308 temporary_channel_id: self.channel_id,
3309 funding_satoshis: self.channel_value_satoshis,
3310 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3311 dust_limit_satoshis: self.our_dust_limit_satoshis,
3312 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3313 channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3314 htlc_minimum_msat: self.our_htlc_minimum_msat,
3315 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3316 to_self_delay: self.our_to_self_delay,
3317 max_accepted_htlcs: OUR_MAX_HTLCS,
3318 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3319 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3320 payment_point: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key()),
3321 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3322 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3323 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3324 channel_flags: if self.config.announced_channel {1} else {0},
3325 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3329 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3330 if self.channel_outbound {
3331 panic!("Tried to send accept_channel for an outbound channel?");
3333 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3334 panic!("Tried to send accept_channel after channel had moved forward");
3336 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3337 panic!("Tried to send an accept_channel for a channel that has already advanced");
3340 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3342 msgs::AcceptChannel {
3343 temporary_channel_id: self.channel_id,
3344 dust_limit_satoshis: self.our_dust_limit_satoshis,
3345 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3346 channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3347 htlc_minimum_msat: self.our_htlc_minimum_msat,
3348 minimum_depth: self.minimum_depth,
3349 to_self_delay: self.our_to_self_delay,
3350 max_accepted_htlcs: OUR_MAX_HTLCS,
3351 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3352 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3353 payment_point: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key()),
3354 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3355 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3356 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3357 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3361 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3362 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3363 let remote_keys = self.build_remote_transaction_keys()?;
3364 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
3365 Ok(self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
3366 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0)
3369 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3370 /// a funding_created message for the remote peer.
3371 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3372 /// or if called on an inbound channel.
3373 /// Note that channel_id changes during this call!
3374 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3375 /// If an Err is returned, it is a ChannelError::Close.
3376 pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
3377 if !self.channel_outbound {
3378 panic!("Tried to create outbound funding_created message on an inbound channel!");
3380 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3381 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)");
3383 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3384 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3385 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3386 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3389 self.funding_txo = Some(funding_txo.clone());
3390 let our_signature = match self.get_outbound_funding_created_signature(logger) {
3393 log_error!(logger, "Got bad signatures: {:?}!", e);
3394 self.funding_txo = None;
3399 let temporary_channel_id = self.channel_id;
3401 // Now that we're past error-generating stuff, update our local state:
3403 self.channel_state = ChannelState::FundingCreated as u32;
3404 self.channel_id = funding_txo.to_channel_id();
3406 Ok(msgs::FundingCreated {
3407 temporary_channel_id,
3408 funding_txid: funding_txo.txid,
3409 funding_output_index: funding_txo.index,
3410 signature: our_signature
3414 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3415 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3416 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3417 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3418 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3420 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3421 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3422 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3423 if !self.config.announced_channel {
3424 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3426 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3427 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3429 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3430 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3433 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3434 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
3436 let msg = msgs::UnsignedChannelAnnouncement {
3437 features: ChannelFeatures::known(),
3438 chain_hash: chain_hash,
3439 short_channel_id: self.get_short_channel_id().unwrap(),
3440 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3441 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3442 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey().clone() },
3443 bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { our_bitcoin_key },
3444 excess_data: Vec::new(),
3447 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3448 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement"))?;
3453 /// May panic if called on a channel that wasn't immediately-previously
3454 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3455 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3456 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3457 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3458 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3459 // current to_remote balances. However, it no longer has any use, and thus is now simply
3460 // set to a dummy (but valid, as required by the spec) public key.
3461 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3462 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3463 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3464 let mut pk = [2; 33]; pk[1] = 0xff;
3465 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3466 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3467 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3468 log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3469 OptionalField::Present(DataLossProtect {
3470 your_last_per_commitment_secret: remote_last_secret,
3471 my_current_per_commitment_point: dummy_pubkey
3474 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3475 OptionalField::Present(DataLossProtect {
3476 your_last_per_commitment_secret: [0;32],
3477 my_current_per_commitment_point: dummy_pubkey,
3480 msgs::ChannelReestablish {
3481 channel_id: self.channel_id(),
3482 // The protocol has two different commitment number concepts - the "commitment
3483 // transaction number", which starts from 0 and counts up, and the "revocation key
3484 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3485 // commitment transaction numbers by the index which will be used to reveal the
3486 // revocation key for that commitment transaction, which means we have to convert them
3487 // to protocol-level commitment numbers here...
3489 // next_local_commitment_number is the next commitment_signed number we expect to
3490 // receive (indicating if they need to resend one that we missed).
3491 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3492 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3493 // receive, however we track it by the next commitment number for a remote transaction
3494 // (which is one further, as they always revoke previous commitment transaction, not
3495 // the one we send) so we have to decrement by 1. Note that if
3496 // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3497 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3499 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3505 // Send stuff to our remote peers:
3507 /// Adds a pending outbound HTLC to this channel, note that you probably want
3508 /// send_htlc_and_commit instead cause you'll want both messages at once.
3509 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3510 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3511 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3512 /// You MUST call send_commitment prior to any other calls on this Channel
3513 /// If an Err is returned, it's a ChannelError::Ignore!
3514 pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
3515 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3516 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3519 if amount_msat > self.channel_value_satoshis * 1000 {
3520 return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3523 if amount_msat == 0 {
3524 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC"));
3527 if amount_msat < self.their_htlc_minimum_msat {
3528 return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3531 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3532 // Note that this should never really happen, if we're !is_live() on receipt of an
3533 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3534 // the user to send directly into a !is_live() channel. However, if we
3535 // disconnected during the time the previous hop was doing the commitment dance we may
3536 // end up getting here after the forwarding delay. In any case, returning an
3537 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3538 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3541 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3542 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3543 return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3545 // Check their_max_htlc_value_in_flight_msat
3546 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3547 return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
3550 // Check self.local_channel_reserve_satoshis (the amount we must keep as
3551 // reserve for the remote to have something to claim if we misbehave)
3552 if self.value_to_self_msat < self.local_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3553 return Err(ChannelError::Ignore("Cannot send value that would put us under local channel reserve value"));
3556 // Now update local state:
3557 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3558 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3559 amount_msat: amount_msat,
3560 payment_hash: payment_hash,
3561 cltv_expiry: cltv_expiry,
3563 onion_routing_packet: onion_routing_packet,
3568 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3569 htlc_id: self.next_local_htlc_id,
3570 amount_msat: amount_msat,
3571 payment_hash: payment_hash.clone(),
3572 cltv_expiry: cltv_expiry,
3573 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3577 let res = msgs::UpdateAddHTLC {
3578 channel_id: self.channel_id,
3579 htlc_id: self.next_local_htlc_id,
3580 amount_msat: amount_msat,
3581 payment_hash: payment_hash,
3582 cltv_expiry: cltv_expiry,
3583 onion_routing_packet: onion_routing_packet,
3585 self.next_local_htlc_id += 1;
3590 /// Creates a signed commitment transaction to send to the remote peer.
3591 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3592 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3593 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3594 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3595 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3596 panic!("Cannot create commitment tx until channel is fully established");
3598 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3599 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3601 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3602 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3604 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3605 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");
3607 let mut have_updates = self.pending_update_fee.is_some();
3608 for htlc in self.pending_outbound_htlcs.iter() {
3609 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3610 have_updates = true;
3612 if have_updates { break; }
3614 for htlc in self.pending_inbound_htlcs.iter() {
3615 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3616 have_updates = true;
3618 if have_updates { break; }
3621 panic!("Cannot create commitment tx until we have some updates to send");
3623 self.send_commitment_no_status_check(logger)
3625 /// Only fails in case of bad keys
3626 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3627 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3628 // fail to generate this, we still are at least at a position where upgrading their status
3630 for htlc in self.pending_inbound_htlcs.iter_mut() {
3631 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3632 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3634 if let Some(state) = new_state {
3638 for htlc in self.pending_outbound_htlcs.iter_mut() {
3639 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3640 Some(fail_reason.take())
3642 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3645 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3647 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update(logger) {
3648 Ok((res, (remote_commitment_tx, mut htlcs))) => {
3649 // Update state now that we've passed all the can-fail calls...
3650 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3651 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3652 (res, remote_commitment_tx, htlcs_no_ref)
3654 Err(e) => return Err(e),
3657 self.latest_monitor_update_id += 1;
3658 let monitor_update = ChannelMonitorUpdate {
3659 update_id: self.latest_monitor_update_id,
3660 updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3661 unsigned_commitment_tx: remote_commitment_tx.clone(),
3662 htlc_outputs: htlcs.clone(),
3663 commitment_number: self.cur_remote_commitment_transaction_number,
3664 their_revocation_point: self.their_cur_commitment_point.unwrap()
3667 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
3668 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3669 Ok((res, monitor_update))
3672 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3673 /// when we shouldn't change HTLC/channel state.
3674 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
3675 let mut feerate_per_kw = self.feerate_per_kw;
3676 if let Some(feerate) = self.pending_update_fee {
3677 if self.channel_outbound {
3678 feerate_per_kw = feerate;
3682 let remote_keys = self.build_remote_transaction_keys()?;
3683 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw, logger);
3684 let (signature, htlc_signatures);
3687 let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3688 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3692 let res = self.local_keys.sign_remote_commitment(feerate_per_kw, &remote_commitment_tx.0, &remote_keys, &htlcs, self.our_to_self_delay, &self.secp_ctx)
3693 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?;
3695 htlc_signatures = res.1;
3697 log_trace!(logger, "Signed remote commitment tx {} with redeemscript {} -> {}",
3698 encode::serialize_hex(&remote_commitment_tx.0),
3699 encode::serialize_hex(&self.get_funding_redeemscript()),
3700 log_bytes!(signature.serialize_compact()[..]));
3702 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3703 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3704 encode::serialize_hex(&chan_utils::build_htlc_transaction(&remote_commitment_tx.0.txid(), feerate_per_kw, self.our_to_self_delay, htlc, &remote_keys.a_delayed_payment_key, &remote_keys.revocation_key)),
3705 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &remote_keys)),
3706 log_bytes!(remote_keys.a_htlc_key.serialize()),
3707 log_bytes!(htlc_sig.serialize_compact()[..]));
3711 Ok((msgs::CommitmentSigned {
3712 channel_id: self.channel_id,
3715 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3718 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3719 /// to send to the remote peer in one go.
3720 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3722 pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
3723 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3724 Some(update_add_htlc) => {
3725 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
3726 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3732 /// Begins the shutdown process, getting a message for the remote peer and returning all
3733 /// holding cell HTLCs for payment failure.
3734 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3735 for htlc in self.pending_outbound_htlcs.iter() {
3736 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3737 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3740 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3741 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3742 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3744 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3745 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3748 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3749 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3750 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3753 let our_closing_script = self.get_closing_scriptpubkey();
3755 // From here on out, we may not fail!
3756 if self.channel_state < ChannelState::FundingSent as u32 {
3757 self.channel_state = ChannelState::ShutdownComplete as u32;
3759 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3761 self.update_time_counter += 1;
3763 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3764 // our shutdown until we've committed all of the pending changes.
3765 self.holding_cell_update_fee = None;
3766 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3767 self.holding_cell_htlc_updates.retain(|htlc_update| {
3769 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3770 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3777 Ok((msgs::Shutdown {
3778 channel_id: self.channel_id,
3779 scriptpubkey: our_closing_script,
3780 }, dropped_outbound_htlcs))
3783 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3784 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3785 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3786 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3787 /// immediately (others we will have to allow to time out).
3788 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>) {
3789 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3791 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3792 // return them to fail the payment.
3793 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3794 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3796 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3797 dropped_outbound_htlcs.push((source, payment_hash));
3803 for _htlc in self.pending_outbound_htlcs.drain(..) {
3804 //TODO: Do something with the remaining HTLCs
3805 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3809 self.channel_state = ChannelState::ShutdownComplete as u32;
3810 self.update_time_counter += 1;
3811 self.latest_monitor_update_id += 1;
3812 (self.funding_txo.clone(), ChannelMonitorUpdate {
3813 update_id: self.latest_monitor_update_id,
3814 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3815 }, dropped_outbound_htlcs)
3819 const SERIALIZATION_VERSION: u8 = 1;
3820 const MIN_SERIALIZATION_VERSION: u8 = 1;
3822 impl Writeable for InboundHTLCRemovalReason {
3823 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3825 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3827 error_packet.write(writer)?;
3829 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3831 onion_hash.write(writer)?;
3832 err_code.write(writer)?;
3834 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3836 payment_preimage.write(writer)?;
3843 impl Readable for InboundHTLCRemovalReason {
3844 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
3845 Ok(match <u8 as Readable>::read(reader)? {
3846 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3847 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3848 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3849 _ => return Err(DecodeError::InvalidValue),
3854 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
3855 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3856 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3857 // called but include holding cell updates (and obviously we don't modify self).
3859 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3860 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3862 self.user_id.write(writer)?;
3863 self.config.write(writer)?;
3865 self.channel_id.write(writer)?;
3866 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3867 self.channel_outbound.write(writer)?;
3868 self.channel_value_satoshis.write(writer)?;
3870 self.latest_monitor_update_id.write(writer)?;
3872 self.local_keys.write(writer)?;
3873 self.shutdown_pubkey.write(writer)?;
3874 self.destination_script.write(writer)?;
3876 self.cur_local_commitment_transaction_number.write(writer)?;
3877 self.cur_remote_commitment_transaction_number.write(writer)?;
3878 self.value_to_self_msat.write(writer)?;
3880 let mut dropped_inbound_htlcs = 0;
3881 for htlc in self.pending_inbound_htlcs.iter() {
3882 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3883 dropped_inbound_htlcs += 1;
3886 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3887 for htlc in self.pending_inbound_htlcs.iter() {
3888 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
3891 htlc.htlc_id.write(writer)?;
3892 htlc.amount_msat.write(writer)?;
3893 htlc.cltv_expiry.write(writer)?;
3894 htlc.payment_hash.write(writer)?;
3896 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
3897 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3899 htlc_state.write(writer)?;
3901 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3903 htlc_state.write(writer)?;
3905 &InboundHTLCState::Committed => {
3908 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3910 removal_reason.write(writer)?;
3915 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3916 for htlc in self.pending_outbound_htlcs.iter() {
3917 htlc.htlc_id.write(writer)?;
3918 htlc.amount_msat.write(writer)?;
3919 htlc.cltv_expiry.write(writer)?;
3920 htlc.payment_hash.write(writer)?;
3921 htlc.source.write(writer)?;
3923 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3925 onion_packet.write(writer)?;
3927 &OutboundHTLCState::Committed => {
3930 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3932 fail_reason.write(writer)?;
3934 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3936 fail_reason.write(writer)?;
3938 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3940 fail_reason.write(writer)?;
3945 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3946 for update in self.holding_cell_htlc_updates.iter() {
3948 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3950 amount_msat.write(writer)?;
3951 cltv_expiry.write(writer)?;
3952 payment_hash.write(writer)?;
3953 source.write(writer)?;
3954 onion_routing_packet.write(writer)?;
3956 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3958 payment_preimage.write(writer)?;
3959 htlc_id.write(writer)?;
3961 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3963 htlc_id.write(writer)?;
3964 err_packet.write(writer)?;
3969 match self.resend_order {
3970 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3971 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3974 self.monitor_pending_funding_locked.write(writer)?;
3975 self.monitor_pending_revoke_and_ack.write(writer)?;
3976 self.monitor_pending_commitment_signed.write(writer)?;
3978 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3979 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3980 pending_forward.write(writer)?;
3981 htlc_id.write(writer)?;
3984 (self.monitor_pending_failures.len() as u64).write(writer)?;
3985 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3986 htlc_source.write(writer)?;
3987 payment_hash.write(writer)?;
3988 fail_reason.write(writer)?;
3991 self.pending_update_fee.write(writer)?;
3992 self.holding_cell_update_fee.write(writer)?;
3994 self.next_local_htlc_id.write(writer)?;
3995 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3996 self.update_time_counter.write(writer)?;
3997 self.feerate_per_kw.write(writer)?;
3999 match self.last_sent_closing_fee {
4000 Some((feerate, fee, sig)) => {
4002 feerate.write(writer)?;
4006 None => 0u8.write(writer)?,
4009 self.funding_txo.write(writer)?;
4010 self.funding_tx_confirmed_in.write(writer)?;
4011 self.short_channel_id.write(writer)?;
4013 self.last_block_connected.write(writer)?;
4014 self.funding_tx_confirmations.write(writer)?;
4016 self.their_dust_limit_satoshis.write(writer)?;
4017 self.our_dust_limit_satoshis.write(writer)?;
4018 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4019 self.local_channel_reserve_satoshis.write(writer)?;
4020 self.their_htlc_minimum_msat.write(writer)?;
4021 self.our_htlc_minimum_msat.write(writer)?;
4022 self.their_to_self_delay.write(writer)?;
4023 self.our_to_self_delay.write(writer)?;
4024 self.their_max_accepted_htlcs.write(writer)?;
4025 self.minimum_depth.write(writer)?;
4027 self.their_pubkeys.write(writer)?;
4028 self.their_cur_commitment_point.write(writer)?;
4030 self.their_prev_commitment_point.write(writer)?;
4031 self.their_node_id.write(writer)?;
4033 self.their_shutdown_scriptpubkey.write(writer)?;
4035 self.commitment_secrets.write(writer)?;
4037 self.channel_monitor.as_ref().unwrap().write_for_disk(writer)?;
4042 impl<ChanSigner: ChannelKeys + Readable> Readable for Channel<ChanSigner> {
4043 fn read<R : ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4044 let _ver: u8 = Readable::read(reader)?;
4045 let min_ver: u8 = Readable::read(reader)?;
4046 if min_ver > SERIALIZATION_VERSION {
4047 return Err(DecodeError::UnknownVersion);
4050 let user_id = Readable::read(reader)?;
4051 let config: ChannelConfig = Readable::read(reader)?;
4053 let channel_id = Readable::read(reader)?;
4054 let channel_state = Readable::read(reader)?;
4055 let channel_outbound = Readable::read(reader)?;
4056 let channel_value_satoshis = Readable::read(reader)?;
4058 let latest_monitor_update_id = Readable::read(reader)?;
4060 let local_keys = Readable::read(reader)?;
4061 let shutdown_pubkey = Readable::read(reader)?;
4062 let destination_script = Readable::read(reader)?;
4064 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4065 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4066 let value_to_self_msat = Readable::read(reader)?;
4068 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4069 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4070 for _ in 0..pending_inbound_htlc_count {
4071 pending_inbound_htlcs.push(InboundHTLCOutput {
4072 htlc_id: Readable::read(reader)?,
4073 amount_msat: Readable::read(reader)?,
4074 cltv_expiry: Readable::read(reader)?,
4075 payment_hash: Readable::read(reader)?,
4076 state: match <u8 as Readable>::read(reader)? {
4077 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4078 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4079 3 => InboundHTLCState::Committed,
4080 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4081 _ => return Err(DecodeError::InvalidValue),
4086 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4087 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4088 for _ in 0..pending_outbound_htlc_count {
4089 pending_outbound_htlcs.push(OutboundHTLCOutput {
4090 htlc_id: Readable::read(reader)?,
4091 amount_msat: Readable::read(reader)?,
4092 cltv_expiry: Readable::read(reader)?,
4093 payment_hash: Readable::read(reader)?,
4094 source: Readable::read(reader)?,
4095 state: match <u8 as Readable>::read(reader)? {
4096 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4097 1 => OutboundHTLCState::Committed,
4098 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4099 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4100 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4101 _ => return Err(DecodeError::InvalidValue),
4106 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4107 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4108 for _ in 0..holding_cell_htlc_update_count {
4109 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4110 0 => HTLCUpdateAwaitingACK::AddHTLC {
4111 amount_msat: Readable::read(reader)?,
4112 cltv_expiry: Readable::read(reader)?,
4113 payment_hash: Readable::read(reader)?,
4114 source: Readable::read(reader)?,
4115 onion_routing_packet: Readable::read(reader)?,
4117 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4118 payment_preimage: Readable::read(reader)?,
4119 htlc_id: Readable::read(reader)?,
4121 2 => HTLCUpdateAwaitingACK::FailHTLC {
4122 htlc_id: Readable::read(reader)?,
4123 err_packet: Readable::read(reader)?,
4125 _ => return Err(DecodeError::InvalidValue),
4129 let resend_order = match <u8 as Readable>::read(reader)? {
4130 0 => RAACommitmentOrder::CommitmentFirst,
4131 1 => RAACommitmentOrder::RevokeAndACKFirst,
4132 _ => return Err(DecodeError::InvalidValue),
4135 let monitor_pending_funding_locked = Readable::read(reader)?;
4136 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4137 let monitor_pending_commitment_signed = Readable::read(reader)?;
4139 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4140 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4141 for _ in 0..monitor_pending_forwards_count {
4142 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4145 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4146 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4147 for _ in 0..monitor_pending_failures_count {
4148 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4151 let pending_update_fee = Readable::read(reader)?;
4152 let holding_cell_update_fee = Readable::read(reader)?;
4154 let next_local_htlc_id = Readable::read(reader)?;
4155 let next_remote_htlc_id = Readable::read(reader)?;
4156 let update_time_counter = Readable::read(reader)?;
4157 let feerate_per_kw = Readable::read(reader)?;
4159 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4161 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4162 _ => return Err(DecodeError::InvalidValue),
4165 let funding_txo = Readable::read(reader)?;
4166 let funding_tx_confirmed_in = Readable::read(reader)?;
4167 let short_channel_id = Readable::read(reader)?;
4169 let last_block_connected = Readable::read(reader)?;
4170 let funding_tx_confirmations = Readable::read(reader)?;
4172 let their_dust_limit_satoshis = Readable::read(reader)?;
4173 let our_dust_limit_satoshis = Readable::read(reader)?;
4174 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4175 let local_channel_reserve_satoshis = Readable::read(reader)?;
4176 let their_htlc_minimum_msat = Readable::read(reader)?;
4177 let our_htlc_minimum_msat = Readable::read(reader)?;
4178 let their_to_self_delay = Readable::read(reader)?;
4179 let our_to_self_delay = Readable::read(reader)?;
4180 let their_max_accepted_htlcs = Readable::read(reader)?;
4181 let minimum_depth = Readable::read(reader)?;
4183 let their_pubkeys = Readable::read(reader)?;
4184 let their_cur_commitment_point = Readable::read(reader)?;
4186 let their_prev_commitment_point = Readable::read(reader)?;
4187 let their_node_id = Readable::read(reader)?;
4189 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4190 let commitment_secrets = Readable::read(reader)?;
4192 let (monitor_last_block, channel_monitor) = Readable::read(reader)?;
4193 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
4194 // doing full block connection operations on the internal ChannelMonitor copies
4195 if monitor_last_block != last_block_connected {
4196 return Err(DecodeError::InvalidValue);
4206 secp_ctx: Secp256k1::new(),
4207 channel_value_satoshis,
4209 latest_monitor_update_id,
4215 cur_local_commitment_transaction_number,
4216 cur_remote_commitment_transaction_number,
4219 pending_inbound_htlcs,
4220 pending_outbound_htlcs,
4221 holding_cell_htlc_updates,
4225 monitor_pending_funding_locked,
4226 monitor_pending_revoke_and_ack,
4227 monitor_pending_commitment_signed,
4228 monitor_pending_forwards,
4229 monitor_pending_failures,
4232 holding_cell_update_fee,
4234 next_remote_htlc_id,
4235 update_time_counter,
4238 #[cfg(debug_assertions)]
4239 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4240 #[cfg(debug_assertions)]
4241 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4243 last_sent_closing_fee,
4246 funding_tx_confirmed_in,
4248 last_block_connected,
4249 funding_tx_confirmations,
4251 their_dust_limit_satoshis,
4252 our_dust_limit_satoshis,
4253 their_max_htlc_value_in_flight_msat,
4254 local_channel_reserve_satoshis,
4255 their_htlc_minimum_msat,
4256 our_htlc_minimum_msat,
4257 their_to_self_delay,
4259 their_max_accepted_htlcs,
4263 their_cur_commitment_point,
4265 their_prev_commitment_point,
4268 their_shutdown_scriptpubkey,
4270 channel_monitor: Some(channel_monitor),
4273 network_sync: UpdateStatus::Fresh,
4280 use bitcoin::BitcoinHash;
4281 use bitcoin::util::bip143;
4282 use bitcoin::consensus::encode::serialize;
4283 use bitcoin::blockdata::script::{Script, Builder};
4284 use bitcoin::blockdata::transaction::{Transaction, TxOut};
4285 use bitcoin::blockdata::constants::genesis_block;
4286 use bitcoin::blockdata::opcodes;
4287 use bitcoin::network::constants::Network;
4288 use bitcoin::hashes::hex::FromHex;
4290 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4291 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4292 use ln::channel::MAX_FUNDING_SATOSHIS;
4293 use ln::features::InitFeatures;
4294 use ln::msgs::{OptionalField, DataLossProtect};
4296 use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4297 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4298 use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4299 use chain::transaction::OutPoint;
4300 use util::config::UserConfig;
4301 use util::enforcing_trait_impls::EnforcingChannelKeys;
4302 use util::test_utils;
4303 use util::logger::Logger;
4304 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4305 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4306 use bitcoin::hashes::sha256::Hash as Sha256;
4307 use bitcoin::hashes::Hash;
4308 use bitcoin::hash_types::{Txid, WPubkeyHash};
4310 use rand::{thread_rng,Rng};
4312 struct TestFeeEstimator {
4315 impl FeeEstimator for TestFeeEstimator {
4316 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4322 fn test_max_funding_satoshis() {
4323 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4324 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4328 chan_keys: InMemoryChannelKeys,
4330 impl KeysInterface for Keys {
4331 type ChanKeySigner = InMemoryChannelKeys;
4333 fn get_node_secret(&self) -> SecretKey { panic!(); }
4334 fn get_destination_script(&self) -> Script {
4335 let secp_ctx = Secp256k1::signing_only();
4336 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4337 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4338 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4341 fn get_shutdown_pubkey(&self) -> PublicKey {
4342 let secp_ctx = Secp256k1::signing_only();
4343 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4344 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4347 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4348 self.chan_keys.clone()
4350 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) { panic!(); }
4351 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4354 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4355 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4359 fn channel_reestablish_no_updates() {
4360 let feeest = TestFeeEstimator{fee_est: 15000};
4361 let logger = test_utils::TestLogger::new();
4362 let secp_ctx = Secp256k1::new();
4363 let mut seed = [0; 32];
4364 let mut rng = thread_rng();
4365 rng.fill_bytes(&mut seed);
4366 let network = Network::Testnet;
4367 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4369 // Go through the flow of opening a channel between two nodes.
4371 // Create Node A's channel
4372 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4373 let config = UserConfig::default();
4374 let mut node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&feeest, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4376 // Create Node B's channel by receiving Node A's open_channel message
4377 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash(), &&feeest);
4378 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4379 let mut node_b_chan = Channel::<EnforcingChannelKeys>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
4381 // Node B --> Node A: accept channel
4382 let accept_channel_msg = node_b_chan.get_accept_channel();
4383 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4385 // Node A --> Node B: funding created
4386 let output_script = node_a_chan.get_funding_redeemscript();
4387 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4388 value: 10000000, script_pubkey: output_script.clone(),
4390 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
4391 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap();
4392 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, &&logger).unwrap();
4394 // Node B --> Node A: funding signed
4395 let _ = node_a_chan.funding_signed(&funding_signed_msg, &&logger);
4397 // Now disconnect the two nodes and check that the commitment point in
4398 // Node B's channel_reestablish message is sane.
4399 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4400 let msg = node_b_chan.get_channel_reestablish(&&logger);
4401 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4402 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4403 match msg.data_loss_protect {
4404 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4405 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4410 // Check that the commitment point in Node A's channel_reestablish message
4412 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4413 let msg = node_a_chan.get_channel_reestablish(&&logger);
4414 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4415 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4416 match msg.data_loss_protect {
4417 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4418 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4425 fn outbound_commitment_test() {
4426 // Test vectors from BOLT 3 Appendix C:
4427 let feeest = TestFeeEstimator{fee_est: 15000};
4428 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4429 let secp_ctx = Secp256k1::new();
4431 let mut chan_keys = InMemoryChannelKeys::new(
4433 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4434 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4435 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4436 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4437 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4439 // These aren't set in the test vectors:
4440 [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],
4444 assert_eq!(PublicKey::from_secret_key(&secp_ctx, chan_keys.funding_key()).serialize()[..],
4445 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4446 let keys_provider = Keys { chan_keys: chan_keys.clone() };
4448 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4449 let mut config = UserConfig::default();
4450 config.channel_options.announced_channel = false;
4451 let mut chan = Channel::<InMemoryChannelKeys>::new_outbound(&&feeest, &&keys_provider, their_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
4452 chan.their_to_self_delay = 144;
4453 chan.our_dust_limit_satoshis = 546;
4455 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
4456 chan.funding_txo = Some(funding_info);
4458 let their_pubkeys = ChannelPublicKeys {
4459 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4460 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4461 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4462 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4463 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4465 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
4467 assert_eq!(their_pubkeys.payment_point.serialize()[..],
4468 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4470 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4471 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4473 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4474 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4476 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4477 // derived from a commitment_seed, so instead we copy it here and call
4478 // build_commitment_transaction.
4479 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.delayed_payment_base_key());
4480 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4481 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4482 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.htlc_base_key());
4483 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint).unwrap();
4485 chan.their_pubkeys = Some(their_pubkeys);
4487 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4490 macro_rules! test_commitment {
4491 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr, {
4492 $( { $htlc_idx: expr, $their_htlc_sig_hex: expr, $our_htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
4495 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
4496 let htlcs = res.2.drain(..)
4497 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4501 let redeemscript = chan.get_funding_redeemscript();
4502 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4503 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4504 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4506 let mut per_htlc = Vec::new();
4507 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
4509 let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4510 per_htlc.push((unsigned_tx.1[$htlc_idx].clone(), Some(remote_signature)));
4512 assert_eq!(unsigned_tx.1.len(), per_htlc.len());
4514 localtx = LocalCommitmentTransaction::new_missing_local_sig(unsigned_tx.0.clone(), their_signature.clone(), &PublicKey::from_secret_key(&secp_ctx, chan.local_keys.funding_key()), chan.their_funding_pubkey(), keys.clone(), chan.feerate_per_kw, per_htlc);
4515 let local_sig = chan_keys.sign_local_commitment(&localtx, &chan.secp_ctx).unwrap();
4516 assert_eq!(Signature::from_der(&hex::decode($our_sig_hex).unwrap()[..]).unwrap(), local_sig);
4518 assert_eq!(serialize(&localtx.add_local_sig(&redeemscript, local_sig))[..],
4519 hex::decode($tx_hex).unwrap()[..]);
4521 let htlc_sigs = chan_keys.sign_local_commitment_htlc_transactions(&localtx, chan.their_to_self_delay, &chan.secp_ctx).unwrap();
4522 let mut htlc_sig_iter = localtx.per_htlc.iter().zip(htlc_sigs.iter().enumerate());
4525 let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4527 let ref htlc = unsigned_tx.1[$htlc_idx];
4528 let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4529 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4530 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4531 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4533 let mut preimage: Option<PaymentPreimage> = None;
4536 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4537 if out == htlc.payment_hash {
4538 preimage = Some(PaymentPreimage([i; 32]));
4542 assert!(preimage.is_some());
4545 let mut htlc_sig = htlc_sig_iter.next().unwrap();
4546 while (htlc_sig.1).1.is_none() { htlc_sig = htlc_sig_iter.next().unwrap(); }
4547 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx));
4549 let our_signature = Signature::from_der(&hex::decode($our_htlc_sig_hex).unwrap()[..]).unwrap();
4550 assert_eq!(Some(our_signature), *(htlc_sig.1).1);
4551 assert_eq!(serialize(&localtx.get_signed_htlc_tx((htlc_sig.1).0, &(htlc_sig.1).1.unwrap(), &preimage, chan.their_to_self_delay))[..],
4552 hex::decode($htlc_tx_hex).unwrap()[..]);
4555 let htlc_sig = htlc_sig_iter.next();
4556 if htlc_sig.is_none() { break; }
4557 assert!((htlc_sig.unwrap().1).1.is_none());
4562 // simple commitment tx with no HTLCs
4563 chan.value_to_self_msat = 7000000000;
4565 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
4566 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
4567 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4569 chan.pending_inbound_htlcs.push({
4570 let mut out = InboundHTLCOutput{
4572 amount_msat: 1000000,
4574 payment_hash: PaymentHash([0; 32]),
4575 state: InboundHTLCState::Committed,
4577 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4580 chan.pending_inbound_htlcs.push({
4581 let mut out = InboundHTLCOutput{
4583 amount_msat: 2000000,
4585 payment_hash: PaymentHash([0; 32]),
4586 state: InboundHTLCState::Committed,
4588 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4591 chan.pending_outbound_htlcs.push({
4592 let mut out = OutboundHTLCOutput{
4594 amount_msat: 2000000,
4596 payment_hash: PaymentHash([0; 32]),
4597 state: OutboundHTLCState::Committed,
4598 source: HTLCSource::dummy(),
4600 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4603 chan.pending_outbound_htlcs.push({
4604 let mut out = OutboundHTLCOutput{
4606 amount_msat: 3000000,
4608 payment_hash: PaymentHash([0; 32]),
4609 state: OutboundHTLCState::Committed,
4610 source: HTLCSource::dummy(),
4612 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4615 chan.pending_inbound_htlcs.push({
4616 let mut out = InboundHTLCOutput{
4618 amount_msat: 4000000,
4620 payment_hash: PaymentHash([0; 32]),
4621 state: InboundHTLCState::Committed,
4623 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4627 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4628 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4629 chan.feerate_per_kw = 0;
4631 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
4632 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
4633 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4636 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
4637 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
4638 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4641 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
4642 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
4643 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4646 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
4647 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
4648 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4651 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
4652 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
4653 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4656 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
4657 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
4658 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4661 // commitment tx with seven outputs untrimmed (maximum feerate)
4662 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4663 chan.feerate_per_kw = 647;
4665 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
4666 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
4667 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4670 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
4671 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
4672 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4675 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
4676 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
4677 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4680 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
4681 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
4682 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4685 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
4686 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
4687 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4690 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
4691 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
4692 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4695 // commitment tx with six outputs untrimmed (minimum feerate)
4696 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4697 chan.feerate_per_kw = 648;
4699 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
4700 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
4701 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4704 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
4705 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
4706 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4709 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
4710 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
4711 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4714 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
4715 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
4716 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4719 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
4720 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
4721 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4724 // commitment tx with six outputs untrimmed (maximum feerate)
4725 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4726 chan.feerate_per_kw = 2069;
4728 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
4729 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
4730 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4733 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
4734 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
4735 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4738 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
4739 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
4740 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4743 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
4744 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
4745 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4748 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
4749 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
4750 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4753 // commitment tx with five outputs untrimmed (minimum feerate)
4754 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4755 chan.feerate_per_kw = 2070;
4757 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
4758 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
4759 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4762 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
4763 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
4764 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4767 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
4768 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
4769 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4772 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
4773 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
4774 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4777 // commitment tx with five outputs untrimmed (maximum feerate)
4778 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4779 chan.feerate_per_kw = 2194;
4781 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
4782 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
4783 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4786 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
4787 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
4788 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4791 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
4792 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
4793 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4796 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
4797 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
4798 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4801 // commitment tx with four outputs untrimmed (minimum feerate)
4802 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4803 chan.feerate_per_kw = 2195;
4805 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
4806 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
4807 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4810 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
4811 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
4812 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4815 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
4816 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
4817 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4820 // commitment tx with four outputs untrimmed (maximum feerate)
4821 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4822 chan.feerate_per_kw = 3702;
4824 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
4825 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
4826 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4829 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
4830 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
4831 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4834 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
4835 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
4836 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4839 // commitment tx with three outputs untrimmed (minimum feerate)
4840 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4841 chan.feerate_per_kw = 3703;
4843 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
4844 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
4845 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4848 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
4849 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
4850 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4853 // commitment tx with three outputs untrimmed (maximum feerate)
4854 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4855 chan.feerate_per_kw = 4914;
4857 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
4858 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
4859 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4862 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
4863 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
4864 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4867 // commitment tx with two outputs untrimmed (minimum feerate)
4868 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4869 chan.feerate_per_kw = 4915;
4871 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
4872 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
4873 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4875 // commitment tx with two outputs untrimmed (maximum feerate)
4876 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4877 chan.feerate_per_kw = 9651180;
4879 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
4880 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
4881 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4883 // commitment tx with one output untrimmed (minimum feerate)
4884 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4885 chan.feerate_per_kw = 9651181;
4887 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
4888 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
4889 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4891 // commitment tx with fee greater than funder amount
4892 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4893 chan.feerate_per_kw = 9651936;
4895 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
4896 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
4897 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4901 fn test_per_commitment_secret_gen() {
4902 // Test vectors from BOLT 3 Appendix D:
4904 let mut seed = [0; 32];
4905 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4906 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4907 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4909 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4910 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4911 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4913 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
4914 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4916 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
4917 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4919 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4920 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
4921 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4925 fn test_key_derivation() {
4926 // Test vectors from BOLT 3 Appendix E:
4927 let secp_ctx = Secp256k1::new();
4929 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4930 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4932 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4933 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4935 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4936 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4938 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4939 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4941 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4942 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4944 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4945 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4947 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4948 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());