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, ReadableArgs, Writeable, Writer};
29 use util::logger::{Logger, LogHolder};
30 use util::errors::APIError;
31 use util::config::{UserConfig,ChannelConfig};
34 use std::default::Default;
35 use std::{cmp,mem,fmt};
40 pub struct ChannelValueStat {
41 pub value_to_self_msat: u64,
42 pub channel_value_msat: u64,
43 pub channel_reserve_msat: u64,
44 pub pending_outbound_htlcs_amount_msat: u64,
45 pub pending_inbound_htlcs_amount_msat: u64,
46 pub holding_cell_outbound_amount_msat: u64,
47 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
50 enum InboundHTLCRemovalReason {
51 FailRelay(msgs::OnionErrorPacket),
52 FailMalformed(([u8; 32], u16)),
53 Fulfill(PaymentPreimage),
56 enum InboundHTLCState {
57 /// Added by remote, to be included in next local commitment tx.
58 RemoteAnnounced(PendingHTLCStatus),
59 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
60 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
61 /// accept this HTLC. Implies AwaitingRemoteRevoke.
62 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
63 /// a remote revoke_and_ack on a previous state before we can do so.
64 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
65 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
66 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
67 /// accept this HTLC. Implies AwaitingRemoteRevoke.
68 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
70 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
72 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
73 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
75 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
76 /// commitment transaction without it as otherwise we'll have to force-close the channel to
77 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
78 /// anyway). That said, ChannelMonitor does this for us (see
79 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
80 /// local state before then, once we're sure that the next commitment_signed and
81 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
82 LocalRemoved(InboundHTLCRemovalReason),
85 struct InboundHTLCOutput {
89 payment_hash: PaymentHash,
90 state: InboundHTLCState,
93 enum OutboundHTLCState {
94 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
95 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
96 /// we will promote to Committed (note that they may not accept it until the next time we
97 /// revoke, but we don't really care about that:
98 /// * they've revoked, so worst case we can announce an old state and get our (option on)
99 /// money back (though we won't), and,
100 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
101 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
102 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
103 /// we'll never get out of sync).
104 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
105 /// OutboundHTLCOutput's size just for a temporary bit
106 LocalAnnounced(Box<msgs::OnionPacket>),
108 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
109 /// the change (though they'll need to revoke before we fail the payment).
110 RemoteRemoved(Option<HTLCFailReason>),
111 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
112 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
113 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
114 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
115 /// remote revoke_and_ack on a previous state before we can do so.
116 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
117 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
118 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
119 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
120 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
121 /// revoke_and_ack to drop completely.
122 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
125 struct OutboundHTLCOutput {
129 payment_hash: PaymentHash,
130 state: OutboundHTLCState,
134 /// See AwaitingRemoteRevoke ChannelState for more info
135 enum HTLCUpdateAwaitingACK {
136 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
140 payment_hash: PaymentHash,
142 onion_routing_packet: msgs::OnionPacket,
145 payment_preimage: PaymentPreimage,
150 err_packet: msgs::OnionErrorPacket,
154 /// There are a few "states" and then a number of flags which can be applied:
155 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
156 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
157 /// move on to ChannelFunded.
158 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
159 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
160 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
162 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
163 OurInitSent = (1 << 0),
164 /// Implies we have received their open_channel/accept_channel message
165 TheirInitSent = (1 << 1),
166 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
167 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
168 /// upon receipt of funding_created, so simply skip this state.
170 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
171 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
172 /// and our counterparty consider the funding transaction confirmed.
174 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
175 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
176 TheirFundingLocked = (1 << 4),
177 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
178 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
179 OurFundingLocked = (1 << 5),
181 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
182 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
184 PeerDisconnected = (1 << 7),
185 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
186 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
187 /// outbound messages until they've managed to do so.
188 MonitorUpdateFailed = (1 << 8),
189 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
190 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
191 /// messages as then we will be unable to determine which HTLCs they included in their
192 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
194 /// Flag is set on ChannelFunded.
195 AwaitingRemoteRevoke = (1 << 9),
196 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
197 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
198 /// to respond with our own shutdown message when possible.
199 RemoteShutdownSent = (1 << 10),
200 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
201 /// point, we may not add any new HTLCs to the channel.
202 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
203 /// us their shutdown.
204 LocalShutdownSent = (1 << 11),
205 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
206 /// to drop us, but we store this anyway.
207 ShutdownComplete = 4096,
209 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
210 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
212 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
214 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
215 /// If channel is public, network should have a liveness view announced by us on a
216 /// best-effort, which means we may filter out some status transitions to avoid spam.
217 /// See further timer_chan_freshness_every_min.
220 /// Status has been gossiped.
222 /// Status has been changed.
224 /// Status has been marked to be gossiped at next flush
228 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
229 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
230 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
232 pub(super) struct Channel<ChanSigner: ChannelKeys> {
233 config: ChannelConfig,
237 channel_id: [u8; 32],
239 channel_outbound: bool,
240 secp_ctx: Secp256k1<secp256k1::All>,
241 channel_value_satoshis: u64,
243 latest_monitor_update_id: u64,
246 local_keys: ChanSigner,
248 pub(super) local_keys: ChanSigner,
249 shutdown_pubkey: PublicKey,
250 destination_script: Script,
252 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
253 // generation start at 0 and count up...this simplifies some parts of implementation at the
254 // cost of others, but should really just be changed.
256 cur_local_commitment_transaction_number: u64,
257 cur_remote_commitment_transaction_number: u64,
258 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
259 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
260 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
261 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
263 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
264 /// need to ensure we resend them in the order we originally generated them. Note that because
265 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
266 /// sufficient to simply set this to the opposite of any message we are generating as we
267 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
268 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
270 resend_order: RAACommitmentOrder,
272 monitor_pending_funding_locked: bool,
273 monitor_pending_revoke_and_ack: bool,
274 monitor_pending_commitment_signed: bool,
275 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
276 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
278 // pending_update_fee is filled when sending and receiving update_fee
279 // For outbound channel, feerate_per_kw is updated with the value from
280 // pending_update_fee when revoke_and_ack is received
282 // For inbound channel, feerate_per_kw is updated when it receives
283 // commitment_signed and revoke_and_ack is generated
284 // The pending value is kept when another pair of update_fee and commitment_signed
285 // is received during AwaitingRemoteRevoke and relieved when the expected
286 // revoke_and_ack is received and new commitment_signed is generated to be
287 // sent to the funder. Otherwise, the pending value is removed when receiving
288 // commitment_signed.
289 pending_update_fee: Option<u64>,
290 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
291 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
292 // is received. holding_cell_update_fee is updated when there are additional
293 // update_fee() during ChannelState::AwaitingRemoteRevoke.
294 holding_cell_update_fee: Option<u64>,
295 next_local_htlc_id: u64,
296 next_remote_htlc_id: u64,
297 update_time_counter: u32,
300 #[cfg(debug_assertions)]
301 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
302 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
303 #[cfg(debug_assertions)]
304 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
305 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
307 last_sent_closing_fee: Option<(u64, u64, Signature)>, // (feerate, fee, our_sig)
309 funding_txo: Option<OutPoint>,
311 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
312 /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
313 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
314 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
315 funding_tx_confirmed_in: Option<BlockHash>,
316 short_channel_id: Option<u64>,
317 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
318 /// ChannelManager deserialization (hence pub(super))
319 pub(super) last_block_connected: BlockHash,
320 funding_tx_confirmations: u64,
322 their_dust_limit_satoshis: u64,
324 pub(super) our_dust_limit_satoshis: u64,
326 our_dust_limit_satoshis: u64,
328 pub(super) their_max_htlc_value_in_flight_msat: u64,
330 their_max_htlc_value_in_flight_msat: u64,
331 //get_our_max_htlc_value_in_flight_msat(): u64,
332 /// minimum channel reserve for self to maintain - set by them.
333 local_channel_reserve_satoshis: u64,
334 // get_remote_channel_reserve_satoshis(channel_value_sats: u64): u64
335 their_htlc_minimum_msat: u64,
336 our_htlc_minimum_msat: u64,
337 their_to_self_delay: u16,
338 our_to_self_delay: u16,
340 pub their_max_accepted_htlcs: u16,
342 their_max_accepted_htlcs: u16,
343 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
346 their_pubkeys: Option<ChannelPublicKeys>,
348 their_cur_commitment_point: Option<PublicKey>,
350 their_prev_commitment_point: Option<PublicKey>,
351 their_node_id: PublicKey,
353 their_shutdown_scriptpubkey: Option<Script>,
355 /// Used exclusively to broadcast the latest local state, mostly a historical quirk that this
357 channel_monitor: Option<ChannelMonitor<ChanSigner>>,
358 commitment_secrets: CounterpartyCommitmentSecrets,
360 network_sync: UpdateStatus,
365 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
366 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
367 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
368 /// really allow for this, so instead we're stuck closing it out at that point.
369 const UNCONF_THRESHOLD: u32 = 6;
370 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
371 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?)
374 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
376 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
378 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
380 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
382 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
384 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
386 /// Used to return a simple Error back to ChannelManager. Will get converted to a
387 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
388 /// channel_id in ChannelManager.
389 pub(super) enum ChannelError {
390 Ignore(&'static str),
392 CloseDelayBroadcast(&'static str),
395 impl fmt::Debug for ChannelError {
396 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
398 &ChannelError::Ignore(e) => write!(f, "Ignore : {}", e),
399 &ChannelError::Close(e) => write!(f, "Close : {}", e),
400 &ChannelError::CloseDelayBroadcast(e) => write!(f, "CloseDelayBroadcast : {}", e)
405 macro_rules! secp_check {
406 ($res: expr, $err: expr) => {
409 Err(_) => return Err(ChannelError::Close($err)),
414 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
415 // Convert constants + channel value to limits:
416 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
417 channel_value_satoshis * 1000 / 10 //TODO
420 /// Returns a minimum channel reserve value the remote needs to maintain,
423 /// Guaranteed to return a value no larger than channel_value_satoshis
424 pub(crate) fn get_remote_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
425 let (q, _) = channel_value_satoshis.overflowing_div(100);
426 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
429 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
430 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
434 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, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel<ChanSigner>, APIError>
435 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
436 F::Target: FeeEstimator,
438 let chan_keys = keys_provider.get_channel_keys(false, channel_value_satoshis);
440 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
441 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
444 if push_msat > channel_value_satoshis * 1000 {
445 return Err(APIError::APIMisuseError{err: "push value > channel value"});
447 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
448 return Err(APIError::APIMisuseError{err: "Configured with an unreasonable our_to_self_delay putting user funds at risks"});
452 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
453 if Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(channel_value_satoshis) < Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate) {
454 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
457 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
461 config: config.channel_options.clone(),
463 channel_id: keys_provider.get_channel_id(),
464 channel_state: ChannelState::OurInitSent as u32,
465 channel_outbound: true,
466 secp_ctx: Secp256k1::new(),
467 channel_value_satoshis: channel_value_satoshis,
469 latest_monitor_update_id: 0,
471 local_keys: chan_keys,
472 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
473 destination_script: keys_provider.get_destination_script(),
475 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
476 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
477 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
479 pending_inbound_htlcs: Vec::new(),
480 pending_outbound_htlcs: Vec::new(),
481 holding_cell_htlc_updates: Vec::new(),
482 pending_update_fee: None,
483 holding_cell_update_fee: None,
484 next_local_htlc_id: 0,
485 next_remote_htlc_id: 0,
486 update_time_counter: 1,
488 resend_order: RAACommitmentOrder::CommitmentFirst,
490 monitor_pending_funding_locked: false,
491 monitor_pending_revoke_and_ack: false,
492 monitor_pending_commitment_signed: false,
493 monitor_pending_forwards: Vec::new(),
494 monitor_pending_failures: Vec::new(),
496 #[cfg(debug_assertions)]
497 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
498 #[cfg(debug_assertions)]
499 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
501 last_sent_closing_fee: None,
504 funding_tx_confirmed_in: None,
505 short_channel_id: None,
506 last_block_connected: Default::default(),
507 funding_tx_confirmations: 0,
509 feerate_per_kw: feerate,
510 their_dust_limit_satoshis: 0,
511 our_dust_limit_satoshis: Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate),
512 their_max_htlc_value_in_flight_msat: 0,
513 local_channel_reserve_satoshis: 0,
514 their_htlc_minimum_msat: 0,
515 our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
516 their_to_self_delay: 0,
517 our_to_self_delay: config.own_channel_config.our_to_self_delay,
518 their_max_accepted_htlcs: 0,
519 minimum_depth: 0, // Filled in in accept_channel
522 their_cur_commitment_point: None,
524 their_prev_commitment_point: None,
525 their_node_id: their_node_id,
527 their_shutdown_scriptpubkey: None,
529 channel_monitor: None,
530 commitment_secrets: CounterpartyCommitmentSecrets::new(),
532 network_sync: UpdateStatus::Fresh,
538 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
539 where F::Target: FeeEstimator
541 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
542 return Err(ChannelError::Close("Peer's feerate much too low"));
544 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
545 return Err(ChannelError::Close("Peer's feerate much too high"));
550 /// Creates a new channel from a remote sides' request for one.
551 /// Assumes chain_hash has already been checked and corresponds with what we expect!
552 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, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel<ChanSigner>, ChannelError>
553 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
554 F::Target: FeeEstimator
556 let mut chan_keys = keys_provider.get_channel_keys(true, msg.funding_satoshis);
557 let their_pubkeys = ChannelPublicKeys {
558 funding_pubkey: msg.funding_pubkey,
559 revocation_basepoint: msg.revocation_basepoint,
560 payment_point: msg.payment_point,
561 delayed_payment_basepoint: msg.delayed_payment_basepoint,
562 htlc_basepoint: msg.htlc_basepoint
564 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
565 let mut local_config = (*config).channel_options.clone();
567 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
568 return Err(ChannelError::Close("Configured with an unreasonable our_to_self_delay putting user funds at risks"));
571 // Check sanity of message fields:
572 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
573 return Err(ChannelError::Close("funding value > 2^24"));
575 if msg.channel_reserve_satoshis > msg.funding_satoshis {
576 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
578 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
579 return Err(ChannelError::Close("push_msat larger than funding value"));
581 if msg.dust_limit_satoshis > msg.funding_satoshis {
582 return Err(ChannelError::Close("Peer never wants payout outputs?"));
584 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
585 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
587 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
588 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
590 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
592 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
593 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
595 if msg.max_accepted_htlcs < 1 {
596 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
598 if msg.max_accepted_htlcs > 483 {
599 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
602 // Now check against optional parameters as set by config...
603 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
604 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
606 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
607 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
609 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
610 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
612 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
613 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
615 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
616 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
618 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
619 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
621 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
622 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
625 // Convert things into internal flags and prep our state:
627 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
628 if config.peer_channel_config_limits.force_announced_channel_preference {
629 if local_config.announced_channel != their_announce {
630 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
633 // we either accept their preference or the preferences match
634 local_config.announced_channel = their_announce;
636 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
638 let our_dust_limit_satoshis = Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate);
639 let remote_channel_reserve_satoshis = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(msg.funding_satoshis);
640 if remote_channel_reserve_satoshis < our_dust_limit_satoshis {
641 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
643 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
644 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
646 if remote_channel_reserve_satoshis < msg.dust_limit_satoshis {
647 return Err(ChannelError::Close("Dust limit too high for the channel reserve we require the remote to keep"));
650 // check if the funder's amount for the initial commitment tx is sufficient
651 // for full fee payment
652 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
653 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
654 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
657 let to_local_msat = msg.push_msat;
658 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
659 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= remote_channel_reserve_satoshis * 1000 {
660 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
663 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
664 match &msg.shutdown_scriptpubkey {
665 &OptionalField::Present(ref script) => {
666 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
667 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
669 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
670 } else if script.len() == 0 {
672 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
674 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
677 // 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
678 &OptionalField::Absent => {
679 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
686 config: local_config,
688 channel_id: msg.temporary_channel_id,
689 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
690 channel_outbound: false,
691 secp_ctx: Secp256k1::new(),
693 latest_monitor_update_id: 0,
695 local_keys: chan_keys,
696 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
697 destination_script: keys_provider.get_destination_script(),
699 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
700 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
701 value_to_self_msat: msg.push_msat,
703 pending_inbound_htlcs: Vec::new(),
704 pending_outbound_htlcs: Vec::new(),
705 holding_cell_htlc_updates: Vec::new(),
706 pending_update_fee: None,
707 holding_cell_update_fee: None,
708 next_local_htlc_id: 0,
709 next_remote_htlc_id: 0,
710 update_time_counter: 1,
712 resend_order: RAACommitmentOrder::CommitmentFirst,
714 monitor_pending_funding_locked: false,
715 monitor_pending_revoke_and_ack: false,
716 monitor_pending_commitment_signed: false,
717 monitor_pending_forwards: Vec::new(),
718 monitor_pending_failures: Vec::new(),
720 #[cfg(debug_assertions)]
721 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
722 #[cfg(debug_assertions)]
723 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
725 last_sent_closing_fee: None,
728 funding_tx_confirmed_in: None,
729 short_channel_id: None,
730 last_block_connected: Default::default(),
731 funding_tx_confirmations: 0,
733 feerate_per_kw: msg.feerate_per_kw as u64,
734 channel_value_satoshis: msg.funding_satoshis,
735 their_dust_limit_satoshis: msg.dust_limit_satoshis,
736 our_dust_limit_satoshis: our_dust_limit_satoshis,
737 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
738 local_channel_reserve_satoshis: msg.channel_reserve_satoshis,
739 their_htlc_minimum_msat: msg.htlc_minimum_msat,
740 our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
741 their_to_self_delay: msg.to_self_delay,
742 our_to_self_delay: config.own_channel_config.our_to_self_delay,
743 their_max_accepted_htlcs: msg.max_accepted_htlcs,
744 minimum_depth: config.own_channel_config.minimum_depth,
746 their_pubkeys: Some(their_pubkeys),
747 their_cur_commitment_point: Some(msg.first_per_commitment_point),
749 their_prev_commitment_point: None,
750 their_node_id: their_node_id,
752 their_shutdown_scriptpubkey,
754 channel_monitor: None,
755 commitment_secrets: CounterpartyCommitmentSecrets::new(),
757 network_sync: UpdateStatus::Fresh,
765 // Utilities to derive keys:
767 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
768 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), idx);
769 SecretKey::from_slice(&res).unwrap()
772 // Utilities to build transactions:
774 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
775 let mut sha = Sha256::engine();
776 let our_payment_point = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key());
778 let their_payment_point = &self.their_pubkeys.as_ref().unwrap().payment_point.serialize();
779 if self.channel_outbound {
780 sha.input(&our_payment_point.serialize());
781 sha.input(their_payment_point);
783 sha.input(their_payment_point);
784 sha.input(&our_payment_point.serialize());
786 let res = Sha256::from_engine(sha).into_inner();
788 ((res[26] as u64) << 5*8) |
789 ((res[27] as u64) << 4*8) |
790 ((res[28] as u64) << 3*8) |
791 ((res[29] as u64) << 2*8) |
792 ((res[30] as u64) << 1*8) |
793 ((res[31] as u64) << 0*8)
796 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
797 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
798 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
799 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
800 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
802 /// @local is used only to convert relevant internal structures which refer to remote vs local
803 /// to decide value of outputs and direction of HTLCs.
804 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
805 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
806 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
807 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
808 /// which peer generated this transaction and "to whom" this transaction flows.
809 /// Returns (the transaction built, the number of HTLC outputs which were present in the
810 /// transaction, the list of HTLCs which were not ignored when building the transaction).
811 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
812 /// sources are provided only for outbound HTLCs in the third return value.
814 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
815 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
818 let mut ins: Vec<TxIn> = Vec::new();
820 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
821 script_sig: Script::new(),
822 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
828 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
829 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
831 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
832 let mut remote_htlc_total_msat = 0;
833 let mut local_htlc_total_msat = 0;
834 let mut value_to_self_msat_offset = 0;
836 log_trace!(self, "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);
838 macro_rules! get_htlc_in_commitment {
839 ($htlc: expr, $offered: expr) => {
840 HTLCOutputInCommitment {
842 amount_msat: $htlc.amount_msat,
843 cltv_expiry: $htlc.cltv_expiry,
844 payment_hash: $htlc.payment_hash,
845 transaction_output_index: None
850 macro_rules! add_htlc_output {
851 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
852 if $outbound == local { // "offered HTLC output"
853 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
854 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
855 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
857 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
858 value: $htlc.amount_msat / 1000
859 }, Some((htlc_in_tx, $source))));
861 log_trace!(self, " ...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);
862 included_dust_htlcs.push((htlc_in_tx, $source));
865 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
866 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
867 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
868 txouts.push((TxOut { // "received HTLC output"
869 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
870 value: $htlc.amount_msat / 1000
871 }, Some((htlc_in_tx, $source))));
873 log_trace!(self, " ...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);
874 included_dust_htlcs.push((htlc_in_tx, $source));
880 for ref htlc in self.pending_inbound_htlcs.iter() {
881 let (include, state_name) = match htlc.state {
882 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
883 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
884 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
885 InboundHTLCState::Committed => (true, "Committed"),
886 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
890 add_htlc_output!(htlc, false, None, state_name);
891 remote_htlc_total_msat += htlc.amount_msat;
893 log_trace!(self, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
895 &InboundHTLCState::LocalRemoved(ref reason) => {
896 if generated_by_local {
897 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
898 value_to_self_msat_offset += htlc.amount_msat as i64;
907 for ref htlc in self.pending_outbound_htlcs.iter() {
908 let (include, state_name) = match htlc.state {
909 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
910 OutboundHTLCState::Committed => (true, "Committed"),
911 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
912 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
913 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
917 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
918 local_htlc_total_msat += htlc.amount_msat;
920 log_trace!(self, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
922 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
923 value_to_self_msat_offset -= htlc.amount_msat as i64;
925 OutboundHTLCState::RemoteRemoved(None) => {
926 if !generated_by_local {
927 value_to_self_msat_offset -= htlc.amount_msat as i64;
935 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
936 assert!(value_to_self_msat >= 0);
937 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
938 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
939 // "violate" their reserve value by couting those against it. Thus, we have to convert
940 // everything to i64 before subtracting as otherwise we can overflow.
941 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;
942 assert!(value_to_remote_msat >= 0);
944 #[cfg(debug_assertions)]
946 // Make sure that the to_self/to_remote is always either past the appropriate
947 // channel_reserve *or* it is making progress towards it.
948 let mut max_commitment_tx_output = if generated_by_local {
949 self.max_commitment_tx_output_local.lock().unwrap()
951 self.max_commitment_tx_output_remote.lock().unwrap()
953 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);
954 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
955 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);
956 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
959 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
960 let (value_to_self, value_to_remote) = if self.channel_outbound {
961 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
963 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
966 let value_to_a = if local { value_to_self } else { value_to_remote };
967 let value_to_b = if local { value_to_remote } else { value_to_self };
969 if value_to_a >= (dust_limit_satoshis as i64) {
970 log_trace!(self, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
972 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
973 if local { self.their_to_self_delay } else { self.our_to_self_delay },
974 &keys.a_delayed_payment_key).to_v0_p2wsh(),
975 value: value_to_a as u64
979 if value_to_b >= (dust_limit_satoshis as i64) {
980 log_trace!(self, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
981 let static_payment_pk = if local {
982 self.their_pubkeys.as_ref().unwrap().payment_point
984 self.local_keys.pubkeys().payment_point
987 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
988 .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
990 value: value_to_b as u64
994 transaction_utils::sort_outputs(&mut txouts, |a, b| {
995 if let &Some(ref a_htlc) = a {
996 if let &Some(ref b_htlc) = b {
997 a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
998 // Note that due to hash collisions, we have to have a fallback comparison
999 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1001 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
1002 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1003 // close the channel due to mismatches - they're doing something dumb:
1004 } else { cmp::Ordering::Equal }
1005 } else { cmp::Ordering::Equal }
1008 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
1009 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
1010 for (idx, mut out) in txouts.drain(..).enumerate() {
1011 outputs.push(out.0);
1012 if let Some((mut htlc, source_option)) = out.1.take() {
1013 htlc.transaction_output_index = Some(idx as u32);
1014 htlcs_included.push((htlc, source_option));
1017 let non_dust_htlc_count = htlcs_included.len();
1018 htlcs_included.append(&mut included_dust_htlcs);
1022 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1025 }, non_dust_htlc_count, htlcs_included)
1029 fn get_closing_scriptpubkey(&self) -> Script {
1030 let our_channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1031 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
1035 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
1036 (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)
1040 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1042 let mut ins: Vec<TxIn> = Vec::new();
1044 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
1045 script_sig: Script::new(),
1046 sequence: 0xffffffff,
1047 witness: Vec::new(),
1052 assert!(self.pending_inbound_htlcs.is_empty());
1053 assert!(self.pending_outbound_htlcs.is_empty());
1054 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1056 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1057 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1058 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 };
1060 if value_to_self < 0 {
1061 assert!(self.channel_outbound);
1062 total_fee_satoshis += (-value_to_self) as u64;
1063 } else if value_to_remote < 0 {
1064 assert!(!self.channel_outbound);
1065 total_fee_satoshis += (-value_to_remote) as u64;
1068 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1069 txouts.push((TxOut {
1070 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1071 value: value_to_remote as u64
1075 if value_to_self as u64 > self.our_dust_limit_satoshis {
1076 txouts.push((TxOut {
1077 script_pubkey: self.get_closing_scriptpubkey(),
1078 value: value_to_self as u64
1082 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1084 let mut outputs: Vec<TxOut> = Vec::new();
1085 for out in txouts.drain(..) {
1086 outputs.push(out.0);
1094 }, total_fee_satoshis)
1098 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1099 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1100 /// our counterparty!)
1101 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1102 /// TODO Some magic rust shit to compile-time check this?
1103 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1104 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1105 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key());
1106 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1107 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1109 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"))
1113 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1114 /// will sign and send to our counterparty.
1115 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1116 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1117 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1118 //may see payments to it!
1119 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key());
1120 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1121 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1123 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"))
1126 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1127 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1128 /// Panics if called before accept_channel/new_from_req
1129 pub fn get_funding_redeemscript(&self) -> Script {
1130 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
1131 make_funding_redeemscript(&our_funding_key, self.their_funding_pubkey())
1134 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1135 /// @local is used only to convert relevant internal structures which refer to remote vs local
1136 /// to decide value of outputs and direction of HTLCs.
1137 fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1138 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)
1141 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1142 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1143 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1145 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1146 /// but then have a reorg which settles on an HTLC-failure on chain.
1147 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> {
1148 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1149 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1150 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1152 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1153 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1155 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1157 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1159 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1160 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1161 // these, but for now we just have to treat them as normal.
1163 let mut pending_idx = std::usize::MAX;
1164 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1165 if htlc.htlc_id == htlc_id_arg {
1166 assert_eq!(htlc.payment_hash, payment_hash_calc);
1168 InboundHTLCState::Committed => {},
1169 InboundHTLCState::LocalRemoved(ref reason) => {
1170 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1172 log_warn!(self, "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()));
1174 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1175 return Ok((None, None));
1178 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1179 // Don't return in release mode here so that we can update channel_monitor
1186 if pending_idx == std::usize::MAX {
1187 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1190 // Now update local state:
1192 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1193 // can claim it even if the channel hits the chain before we see their next commitment.
1194 self.latest_monitor_update_id += 1;
1195 let monitor_update = ChannelMonitorUpdate {
1196 update_id: self.latest_monitor_update_id,
1197 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1198 payment_preimage: payment_preimage_arg.clone(),
1201 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1203 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1204 for pending_update in self.holding_cell_htlc_updates.iter() {
1205 match pending_update {
1206 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1207 if htlc_id_arg == htlc_id {
1208 // Make sure we don't leave latest_monitor_update_id incremented here:
1209 self.latest_monitor_update_id -= 1;
1210 debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1211 return Ok((None, None));
1214 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1215 if htlc_id_arg == htlc_id {
1216 log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1217 // TODO: We may actually be able to switch to a fulfill here, though its
1218 // rare enough it may not be worth the complexity burden.
1219 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1220 return Ok((None, Some(monitor_update)));
1226 log_trace!(self, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1227 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1228 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1230 return Ok((None, Some(monitor_update)));
1234 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1235 if let InboundHTLCState::Committed = htlc.state {
1237 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1238 return Ok((None, Some(monitor_update)));
1240 log_trace!(self, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1241 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1244 Ok((Some(msgs::UpdateFulfillHTLC {
1245 channel_id: self.channel_id(),
1246 htlc_id: htlc_id_arg,
1247 payment_preimage: payment_preimage_arg,
1248 }), Some(monitor_update)))
1251 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> {
1252 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1253 (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1254 let (commitment, mut additional_update) = self.send_commitment_no_status_check()?;
1255 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1256 // strictly increasing by one, so decrement it here.
1257 self.latest_monitor_update_id = monitor_update.update_id;
1258 monitor_update.updates.append(&mut additional_update.updates);
1259 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1261 (Some(update_fulfill_htlc), None) => {
1262 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1263 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1265 (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1266 (None, None) => Ok((None, None))
1270 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1271 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1272 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1274 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1275 /// but then have a reorg which settles on an HTLC-failure on chain.
1276 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1277 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1278 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1280 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1282 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1283 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1284 // these, but for now we just have to treat them as normal.
1286 let mut pending_idx = std::usize::MAX;
1287 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1288 if htlc.htlc_id == htlc_id_arg {
1290 InboundHTLCState::Committed => {},
1291 InboundHTLCState::LocalRemoved(_) => {
1292 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1296 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1297 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1303 if pending_idx == std::usize::MAX {
1304 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1307 // Now update local state:
1308 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1309 for pending_update in self.holding_cell_htlc_updates.iter() {
1310 match pending_update {
1311 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1312 if htlc_id_arg == htlc_id {
1313 debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1314 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1317 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1318 if htlc_id_arg == htlc_id {
1319 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1320 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1326 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1327 htlc_id: htlc_id_arg,
1334 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1335 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1338 Ok(Some(msgs::UpdateFailHTLC {
1339 channel_id: self.channel_id(),
1340 htlc_id: htlc_id_arg,
1345 // Message handlers:
1347 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1348 // Check sanity of message fields:
1349 if !self.channel_outbound {
1350 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1352 if self.channel_state != ChannelState::OurInitSent as u32 {
1353 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1355 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1356 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1358 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1359 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1361 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1362 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1364 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1365 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1367 if msg.dust_limit_satoshis > Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) {
1368 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1370 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1371 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1373 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1374 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1376 if msg.max_accepted_htlcs < 1 {
1377 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1379 if msg.max_accepted_htlcs > 483 {
1380 return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1383 // Now check against optional parameters as set by config...
1384 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1385 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1387 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1388 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1390 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1391 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1393 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1394 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1396 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1397 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1399 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1400 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1402 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1403 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1406 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1407 match &msg.shutdown_scriptpubkey {
1408 &OptionalField::Present(ref script) => {
1409 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1410 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1411 Some(script.clone())
1412 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1413 } else if script.len() == 0 {
1415 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1417 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
1420 // 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
1421 &OptionalField::Absent => {
1422 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
1427 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1428 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1429 self.local_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1430 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1431 self.their_to_self_delay = msg.to_self_delay;
1432 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1433 self.minimum_depth = msg.minimum_depth;
1435 let their_pubkeys = ChannelPublicKeys {
1436 funding_pubkey: msg.funding_pubkey,
1437 revocation_basepoint: msg.revocation_basepoint,
1438 payment_point: msg.payment_point,
1439 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1440 htlc_basepoint: msg.htlc_basepoint
1443 self.local_keys.set_remote_channel_pubkeys(&their_pubkeys);
1444 self.their_pubkeys = Some(their_pubkeys);
1446 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1447 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1449 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1454 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, LocalCommitmentTransaction, Signature), ChannelError> {
1455 let funding_script = self.get_funding_redeemscript();
1457 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1458 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1459 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)[..]);
1461 // They sign the "local" commitment transaction...
1462 log_trace!(self, "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));
1463 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, self.their_funding_pubkey()), "Invalid funding_created signature from peer");
1465 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());
1467 let remote_keys = self.build_remote_transaction_keys()?;
1468 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1469 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)
1470 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0;
1472 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1473 Ok((remote_initial_commitment_tx, localtx, remote_signature))
1476 fn their_funding_pubkey(&self) -> &PublicKey {
1477 &self.their_pubkeys.as_ref().expect("their_funding_pubkey() only allowed after accept_channel").funding_pubkey
1480 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor<ChanSigner>), ChannelError> {
1481 if self.channel_outbound {
1482 return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1484 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1485 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1486 // remember the channel, so it's safe to just send an error_message here and drop the
1488 return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1490 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1491 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1492 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1493 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1496 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1497 self.funding_txo = Some(funding_txo.clone());
1499 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1502 self.funding_txo = None;
1507 // Now that we're past error-generating stuff, update our local state:
1509 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1510 let funding_redeemscript = self.get_funding_redeemscript();
1511 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1512 macro_rules! create_monitor {
1514 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1515 &self.shutdown_pubkey, self.our_to_self_delay,
1516 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1517 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1518 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1519 self.get_commitment_transaction_number_obscure_factor(),
1520 local_initial_commitment_tx.clone(),
1521 self.logger.clone());
1523 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());
1528 self.channel_monitor = Some(create_monitor!());
1529 let channel_monitor = create_monitor!();
1531 self.channel_state = ChannelState::FundingSent as u32;
1532 self.channel_id = funding_txo.to_channel_id();
1533 self.cur_remote_commitment_transaction_number -= 1;
1534 self.cur_local_commitment_transaction_number -= 1;
1536 Ok((msgs::FundingSigned {
1537 channel_id: self.channel_id,
1538 signature: our_signature
1539 }, channel_monitor))
1542 /// Handles a funding_signed message from the remote end.
1543 /// If this call is successful, broadcast the funding transaction (and not before!)
1544 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor<ChanSigner>, ChannelError> {
1545 if !self.channel_outbound {
1546 return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1548 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1549 return Err(ChannelError::Close("Received funding_signed in strange state!"));
1551 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1552 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1553 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1554 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1557 let funding_script = self.get_funding_redeemscript();
1559 let remote_keys = self.build_remote_transaction_keys()?;
1560 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1562 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1563 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1564 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)[..]);
1566 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1568 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1569 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, their_funding_pubkey) {
1570 return Err(ChannelError::Close("Invalid funding_signed signature from peer"));
1573 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1574 let funding_redeemscript = self.get_funding_redeemscript();
1575 let funding_txo = self.funding_txo.as_ref().unwrap();
1576 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1577 macro_rules! create_monitor {
1579 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());
1580 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1581 &self.shutdown_pubkey, self.our_to_self_delay,
1582 &self.destination_script, (funding_txo.clone(), funding_txo_script.clone()),
1583 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1584 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1585 self.get_commitment_transaction_number_obscure_factor(),
1586 local_commitment_tx,
1587 self.logger.clone());
1589 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());
1595 self.channel_monitor = Some(create_monitor!());
1596 let channel_monitor = create_monitor!();
1598 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1599 self.channel_state = ChannelState::FundingSent as u32;
1600 self.cur_local_commitment_transaction_number -= 1;
1601 self.cur_remote_commitment_transaction_number -= 1;
1606 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1607 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1608 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1611 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1613 if non_shutdown_state == ChannelState::FundingSent as u32 {
1614 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1615 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1616 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1617 self.update_time_counter += 1;
1618 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1619 // Note that funding_signed/funding_created will have decremented both by 1!
1620 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1621 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1622 // If we reconnected before sending our funding locked they may still resend theirs:
1623 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1624 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1625 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1626 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1628 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1631 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1634 self.their_prev_commitment_point = self.their_cur_commitment_point;
1635 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1639 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1640 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1641 let mut htlc_inbound_value_msat = 0;
1642 for ref htlc in self.pending_inbound_htlcs.iter() {
1643 htlc_inbound_value_msat += htlc.amount_msat;
1645 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1648 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1650 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1651 let mut htlc_outbound_value_msat = 0;
1652 for ref htlc in self.pending_outbound_htlcs.iter() {
1653 htlc_outbound_value_msat += htlc.amount_msat;
1656 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1657 for update in self.holding_cell_htlc_updates.iter() {
1658 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1659 htlc_outbound_count += 1;
1660 htlc_outbound_value_msat += amount_msat;
1664 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1667 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1668 /// Doesn't bother handling the
1669 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1670 /// corner case properly.
1671 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1672 // Note that we have to handle overflow due to the above case.
1673 (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,
1674 cmp::min(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1677 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1678 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1679 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1681 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1682 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1684 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1685 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1687 if msg.amount_msat == 0 {
1688 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC"));
1690 if msg.amount_msat < self.our_htlc_minimum_msat {
1691 return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1694 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1695 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1696 return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1698 // Check our_max_htlc_value_in_flight_msat
1699 if htlc_inbound_value_msat + msg.amount_msat > Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1700 return Err(ChannelError::Close("Remote HTLC add would put them over our max HTLC value"));
1702 // Check remote_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1703 // the reserve_satoshis we told them to always have as direct payment so that they lose
1704 // something if we punish them for broadcasting an old state).
1705 // Note that we don't really care about having a small/no to_remote output in our local
1706 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1707 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1708 // present in the next commitment transaction we send them (at least for fulfilled ones,
1709 // failed ones won't modify value_to_self).
1710 // Note that we will send HTLCs which another instance of rust-lightning would think
1711 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1712 // Channel state once they will not be present in the next received commitment
1714 let mut removed_outbound_total_msat = 0;
1715 for ref htlc in self.pending_outbound_htlcs.iter() {
1716 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1717 removed_outbound_total_msat += htlc.amount_msat;
1718 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1719 removed_outbound_total_msat += htlc.amount_msat;
1722 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 {
1723 return Err(ChannelError::Close("Remote HTLC add would put them under their reserve value"));
1725 if self.next_remote_htlc_id != msg.htlc_id {
1726 return Err(ChannelError::Close("Remote skipped HTLC ID"));
1728 if msg.cltv_expiry >= 500000000 {
1729 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1732 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1733 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1734 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1738 // Now update local state:
1739 self.next_remote_htlc_id += 1;
1740 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1741 htlc_id: msg.htlc_id,
1742 amount_msat: msg.amount_msat,
1743 payment_hash: msg.payment_hash,
1744 cltv_expiry: msg.cltv_expiry,
1745 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1750 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1752 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1753 for htlc in self.pending_outbound_htlcs.iter_mut() {
1754 if htlc.htlc_id == htlc_id {
1755 match check_preimage {
1757 Some(payment_hash) =>
1758 if payment_hash != htlc.payment_hash {
1759 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1763 OutboundHTLCState::LocalAnnounced(_) =>
1764 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1765 OutboundHTLCState::Committed => {
1766 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1768 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1769 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1771 return Ok(&htlc.source);
1774 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1777 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1778 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1779 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1781 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1782 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1785 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1786 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1789 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1790 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1791 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1793 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1794 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1797 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1801 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1802 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1803 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1805 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1806 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1809 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1813 pub fn commitment_signed<F: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)> where F::Target: FeeEstimator {
1814 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1815 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state")));
1817 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1818 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish")));
1820 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1821 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds")));
1824 let funding_script = self.get_funding_redeemscript();
1826 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1828 let mut update_fee = false;
1829 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1831 self.pending_update_fee.unwrap()
1836 let mut local_commitment_tx = {
1837 let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1838 let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1839 (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1841 let local_commitment_txid = local_commitment_tx.0.txid();
1842 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)[..]);
1843 log_trace!(self, "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));
1844 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1845 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer")));
1848 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1850 let num_htlcs = local_commitment_tx.1;
1851 let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1853 let remote_reserve_we_require = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
1854 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + remote_reserve_we_require {
1855 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee")));
1859 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1860 return Err((None, ChannelError::Close("Got wrong number of HTLC signatures from remote")));
1863 // TODO: Merge these two, sadly they are currently both required to be passed separately to
1865 let mut htlcs_without_source = Vec::with_capacity(local_commitment_tx.2.len());
1866 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1867 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1868 if let Some(_) = htlc.transaction_output_index {
1869 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1870 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1871 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1872 log_trace!(self, "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));
1873 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
1874 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer")));
1876 htlcs_without_source.push((htlc.clone(), Some(msg.htlc_signatures[idx])));
1877 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
1879 htlcs_without_source.push((htlc.clone(), None));
1880 htlcs_and_sigs.push((htlc, None, source));
1884 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1885 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 1);
1887 // Update state now that we've passed all the can-fail calls...
1888 let mut need_our_commitment = false;
1889 if !self.channel_outbound {
1890 if let Some(fee_update) = self.pending_update_fee {
1891 self.feerate_per_kw = fee_update;
1892 // We later use the presence of pending_update_fee to indicate we should generate a
1893 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1894 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1895 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1896 need_our_commitment = true;
1897 self.pending_update_fee = None;
1902 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1904 self.latest_monitor_update_id += 1;
1905 let mut monitor_update = ChannelMonitorUpdate {
1906 update_id: self.latest_monitor_update_id,
1907 updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
1908 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),
1909 htlc_outputs: htlcs_and_sigs
1912 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1914 for htlc in self.pending_inbound_htlcs.iter_mut() {
1915 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1916 Some(forward_info.clone())
1918 if let Some(forward_info) = new_forward {
1919 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1920 need_our_commitment = true;
1923 for htlc in self.pending_outbound_htlcs.iter_mut() {
1924 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1925 Some(fail_reason.take())
1927 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1928 need_our_commitment = true;
1932 self.cur_local_commitment_transaction_number -= 1;
1933 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1934 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1935 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1937 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1938 // In case we initially failed monitor updating without requiring a response, we need
1939 // to make sure the RAA gets sent first.
1940 self.monitor_pending_revoke_and_ack = true;
1941 if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1942 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1943 // the corresponding HTLC status updates so that get_last_commitment_update
1944 // includes the right HTLCs.
1945 self.monitor_pending_commitment_signed = true;
1946 let (_, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1947 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1948 // strictly increasing by one, so decrement it here.
1949 self.latest_monitor_update_id = monitor_update.update_id;
1950 monitor_update.updates.append(&mut additional_update.updates);
1952 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1953 // re-send the message on restoration)
1954 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA")));
1957 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1958 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1959 // we'll send one right away when we get the revoke_and_ack when we
1960 // free_holding_cell_htlcs().
1961 let (msg, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1962 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1963 // strictly increasing by one, so decrement it here.
1964 self.latest_monitor_update_id = monitor_update.update_id;
1965 monitor_update.updates.append(&mut additional_update.updates);
1967 } else if !need_our_commitment {
1968 (None, self.maybe_propose_first_closing_signed(fee_estimator))
1969 } else { (None, None) };
1971 Ok((msgs::RevokeAndACK {
1972 channel_id: self.channel_id,
1973 per_commitment_secret: per_commitment_secret,
1974 next_per_commitment_point: next_per_commitment_point,
1975 }, our_commitment_signed, closing_signed, monitor_update))
1978 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1979 /// fulfilling or failing the last pending HTLC)
1980 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, ChannelError> {
1981 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1982 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1983 log_trace!(self, "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 { "" });
1985 let mut monitor_update = ChannelMonitorUpdate {
1986 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
1987 updates: Vec::new(),
1990 let mut htlc_updates = Vec::new();
1991 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1992 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1993 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1994 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1996 for htlc_update in htlc_updates.drain(..) {
1997 // Note that this *can* fail, though it should be due to rather-rare conditions on
1998 // fee races with adding too many outputs which push our total payments just over
1999 // the limit. In case it's less rare than I anticipate, we may want to revisit
2000 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2001 // to rebalance channels.
2002 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
2003 self.holding_cell_htlc_updates.push(htlc_update);
2005 match &htlc_update {
2006 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2007 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2008 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2011 ChannelError::Ignore(ref msg) => {
2012 log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2015 log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
2022 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2023 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
2024 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2025 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2026 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2027 monitor_update.updates.append(&mut additional_monitor_update.updates);
2031 if let ChannelError::Ignore(_) = e {}
2033 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2038 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2039 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2040 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2042 if let ChannelError::Ignore(_) = e {}
2044 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2051 self.holding_cell_htlc_updates.push(htlc_update);
2052 if let Some(ChannelError::Ignore(_)) = err {
2053 // If we failed to add the HTLC, but got an Ignore error, we should
2054 // still send the new commitment_signed, so reset the err to None.
2060 //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2061 //fail it back the route, if it's a temporary issue we can ignore it...
2064 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2065 // This should never actually happen and indicates we got some Errs back
2066 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2067 // case there is some strange way to hit duplicate HTLC removes.
2070 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2071 self.pending_update_fee = self.holding_cell_update_fee.take();
2072 Some(msgs::UpdateFee {
2073 channel_id: self.channel_id,
2074 feerate_per_kw: feerate as u32,
2080 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2081 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2082 // but we want them to be strictly increasing by one, so reset it here.
2083 self.latest_monitor_update_id = monitor_update.update_id;
2084 monitor_update.updates.append(&mut additional_update.updates);
2086 Ok(Some((msgs::CommitmentUpdate {
2088 update_fulfill_htlcs,
2090 update_fail_malformed_htlcs: Vec::new(),
2091 update_fee: update_fee,
2093 }, monitor_update)))
2102 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2103 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2104 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2105 /// generating an appropriate error *after* the channel state has been updated based on the
2106 /// revoke_and_ack message.
2107 pub fn revoke_and_ack<F: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), ChannelError>
2108 where F::Target: FeeEstimator
2110 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2111 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2113 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2114 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2116 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2117 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2120 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2121 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 {
2122 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2126 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2127 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2128 // haven't given them a new commitment transaction to broadcast). We should probably
2129 // take advantage of this by updating our channel monitor, sending them an error, and
2130 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2131 // lot of work, and there's some chance this is all a misunderstanding anyway.
2132 // We have to do *something*, though, since our signer may get mad at us for otherwise
2133 // jumping a remote commitment number, so best to just force-close and move on.
2134 return Err(ChannelError::Close("Received an unexpected revoke_and_ack"));
2137 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2138 .map_err(|_| ChannelError::Close("Previous secrets did not match new one"))?;
2139 self.latest_monitor_update_id += 1;
2140 let mut monitor_update = ChannelMonitorUpdate {
2141 update_id: self.latest_monitor_update_id,
2142 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2143 idx: self.cur_remote_commitment_transaction_number + 1,
2144 secret: msg.per_commitment_secret,
2147 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
2149 // Update state now that we've passed all the can-fail calls...
2150 // (note that we may still fail to generate the new commitment_signed message, but that's
2151 // OK, we step the channel here and *then* if the new generation fails we can fail the
2152 // channel based on that, but stepping stuff here should be safe either way.
2153 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2154 self.their_prev_commitment_point = self.their_cur_commitment_point;
2155 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2156 self.cur_remote_commitment_transaction_number -= 1;
2158 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2159 let mut to_forward_infos = Vec::new();
2160 let mut revoked_htlcs = Vec::new();
2161 let mut update_fail_htlcs = Vec::new();
2162 let mut update_fail_malformed_htlcs = Vec::new();
2163 let mut require_commitment = false;
2164 let mut value_to_self_msat_diff: i64 = 0;
2167 // Take references explicitly so that we can hold multiple references to self.
2168 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2169 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2170 let logger = LogHolder { logger: &self.logger };
2172 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2173 pending_inbound_htlcs.retain(|htlc| {
2174 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2175 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2176 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2177 value_to_self_msat_diff += htlc.amount_msat as i64;
2182 pending_outbound_htlcs.retain(|htlc| {
2183 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2184 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2185 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2186 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2188 // They fulfilled, so we sent them money
2189 value_to_self_msat_diff -= htlc.amount_msat as i64;
2194 for htlc in pending_inbound_htlcs.iter_mut() {
2195 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2196 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2198 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2199 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2203 let mut state = InboundHTLCState::Committed;
2204 mem::swap(&mut state, &mut htlc.state);
2206 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2207 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2208 require_commitment = true;
2209 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2210 match forward_info {
2211 PendingHTLCStatus::Fail(fail_msg) => {
2212 require_commitment = true;
2214 HTLCFailureMsg::Relay(msg) => {
2215 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2216 update_fail_htlcs.push(msg)
2218 HTLCFailureMsg::Malformed(msg) => {
2219 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2220 update_fail_malformed_htlcs.push(msg)
2224 PendingHTLCStatus::Forward(forward_info) => {
2225 to_forward_infos.push((forward_info, htlc.htlc_id));
2226 htlc.state = InboundHTLCState::Committed;
2232 for htlc in pending_outbound_htlcs.iter_mut() {
2233 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2234 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2235 htlc.state = OutboundHTLCState::Committed;
2237 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2238 Some(fail_reason.take())
2240 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2241 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2242 require_commitment = true;
2246 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2248 if self.channel_outbound {
2249 if let Some(feerate) = self.pending_update_fee.take() {
2250 self.feerate_per_kw = feerate;
2253 if let Some(feerate) = self.pending_update_fee {
2254 // Because a node cannot send two commitment_signeds in a row without getting a
2255 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2256 // it should use to create keys with) and because a node can't send a
2257 // commitment_signed without changes, checking if the feerate is equal to the
2258 // pending feerate update is sufficient to detect require_commitment.
2259 if feerate == self.feerate_per_kw {
2260 require_commitment = true;
2261 self.pending_update_fee = None;
2266 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2267 // We can't actually generate a new commitment transaction (incl by freeing holding
2268 // cells) while we can't update the monitor, so we just return what we have.
2269 if require_commitment {
2270 self.monitor_pending_commitment_signed = true;
2271 // When the monitor updating is restored we'll call get_last_commitment_update(),
2272 // which does not update state, but we're definitely now awaiting a remote revoke
2273 // before we can step forward any more, so set it here.
2274 let (_, mut additional_update) = self.send_commitment_no_status_check()?;
2275 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2276 // strictly increasing by one, so decrement it here.
2277 self.latest_monitor_update_id = monitor_update.update_id;
2278 monitor_update.updates.append(&mut additional_update.updates);
2280 self.monitor_pending_forwards.append(&mut to_forward_infos);
2281 self.monitor_pending_failures.append(&mut revoked_htlcs);
2282 return Ok((None, Vec::new(), Vec::new(), None, monitor_update))
2285 match self.free_holding_cell_htlcs()? {
2286 Some((mut commitment_update, mut additional_update)) => {
2287 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2288 for fail_msg in update_fail_htlcs.drain(..) {
2289 commitment_update.update_fail_htlcs.push(fail_msg);
2291 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2292 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2293 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2296 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2297 // strictly increasing by one, so decrement it here.
2298 self.latest_monitor_update_id = monitor_update.update_id;
2299 monitor_update.updates.append(&mut additional_update.updates);
2301 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update))
2304 if require_commitment {
2305 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2307 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2308 // strictly increasing by one, so decrement it here.
2309 self.latest_monitor_update_id = monitor_update.update_id;
2310 monitor_update.updates.append(&mut additional_update.updates);
2312 Ok((Some(msgs::CommitmentUpdate {
2313 update_add_htlcs: Vec::new(),
2314 update_fulfill_htlcs: Vec::new(),
2316 update_fail_malformed_htlcs,
2319 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2321 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update))
2328 /// Adds a pending update to this channel. See the doc for send_htlc for
2329 /// further details on the optionness of the return value.
2330 /// You MUST call send_commitment prior to any other calls on this Channel
2331 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2332 if !self.channel_outbound {
2333 panic!("Cannot send fee from inbound channel");
2335 if !self.is_usable() {
2336 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2338 if !self.is_live() {
2339 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2342 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2343 self.holding_cell_update_fee = Some(feerate_per_kw);
2347 debug_assert!(self.pending_update_fee.is_none());
2348 self.pending_update_fee = Some(feerate_per_kw);
2350 Some(msgs::UpdateFee {
2351 channel_id: self.channel_id,
2352 feerate_per_kw: feerate_per_kw as u32,
2356 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> {
2357 match self.send_update_fee(feerate_per_kw) {
2358 Some(update_fee) => {
2359 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2360 Ok(Some((update_fee, commitment_signed, monitor_update)))
2366 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2367 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2368 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2369 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2370 /// No further message handling calls may be made until a channel_reestablish dance has
2372 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2373 let mut outbound_drops = Vec::new();
2375 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2376 if self.channel_state < ChannelState::FundingSent as u32 {
2377 self.channel_state = ChannelState::ShutdownComplete as u32;
2378 return outbound_drops;
2380 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2381 // will be retransmitted.
2382 self.last_sent_closing_fee = None;
2384 let mut inbound_drop_count = 0;
2385 self.pending_inbound_htlcs.retain(|htlc| {
2387 InboundHTLCState::RemoteAnnounced(_) => {
2388 // They sent us an update_add_htlc but we never got the commitment_signed.
2389 // We'll tell them what commitment_signed we're expecting next and they'll drop
2390 // this HTLC accordingly
2391 inbound_drop_count += 1;
2394 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2395 // We received a commitment_signed updating this HTLC and (at least hopefully)
2396 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2397 // in response to it yet, so don't touch it.
2400 InboundHTLCState::Committed => true,
2401 InboundHTLCState::LocalRemoved(_) => {
2402 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2403 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2404 // (that we missed). Keep this around for now and if they tell us they missed
2405 // the commitment_signed we can re-transmit the update then.
2410 self.next_remote_htlc_id -= inbound_drop_count;
2412 for htlc in self.pending_outbound_htlcs.iter_mut() {
2413 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2414 // They sent us an update to remove this but haven't yet sent the corresponding
2415 // commitment_signed, we need to move it back to Committed and they can re-send
2416 // the update upon reconnection.
2417 htlc.state = OutboundHTLCState::Committed;
2421 self.holding_cell_htlc_updates.retain(|htlc_update| {
2423 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2424 outbound_drops.push((source.clone(), payment_hash.clone()));
2427 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2430 self.channel_state |= ChannelState::PeerDisconnected as u32;
2431 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2435 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2436 /// updates are partially paused.
2437 /// This must be called immediately after the call which generated the ChannelMonitor update
2438 /// which failed. The messages which were generated from that call which generated the
2439 /// monitor update failure must *not* have been sent to the remote end, and must instead
2440 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2441 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)>) {
2442 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2443 self.monitor_pending_revoke_and_ack = resend_raa;
2444 self.monitor_pending_commitment_signed = resend_commitment;
2445 assert!(self.monitor_pending_forwards.is_empty());
2446 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2447 assert!(self.monitor_pending_failures.is_empty());
2448 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2449 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2452 /// Indicates that the latest ChannelMonitor update has been committed by the client
2453 /// successfully and we should restore normal operation. Returns messages which should be sent
2454 /// to the remote side.
2455 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) {
2456 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2457 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2459 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2461 // Because we will never generate a FundingBroadcastSafe event when we're in
2462 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2463 // they received the FundingBroadcastSafe event, we can only ever hit
2464 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2465 // monitor on funding_created, and we even got the funding transaction confirmed before the
2466 // monitor was persisted.
2467 let funding_locked = if self.monitor_pending_funding_locked {
2468 assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2469 self.monitor_pending_funding_locked = false;
2470 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2471 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2472 Some(msgs::FundingLocked {
2473 channel_id: self.channel_id(),
2474 next_per_commitment_point: next_per_commitment_point,
2478 let mut forwards = Vec::new();
2479 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2480 let mut failures = Vec::new();
2481 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2483 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2484 self.monitor_pending_revoke_and_ack = false;
2485 self.monitor_pending_commitment_signed = false;
2486 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2489 let raa = if self.monitor_pending_revoke_and_ack {
2490 Some(self.get_last_revoke_and_ack())
2492 let commitment_update = if self.monitor_pending_commitment_signed {
2493 Some(self.get_last_commitment_update())
2496 self.monitor_pending_revoke_and_ack = false;
2497 self.monitor_pending_commitment_signed = false;
2498 let order = self.resend_order.clone();
2499 log_trace!(self, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2500 if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2501 if commitment_update.is_some() { "a" } else { "no" },
2502 if raa.is_some() { "an" } else { "no" },
2503 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2504 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2507 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2508 where F::Target: FeeEstimator
2510 if self.channel_outbound {
2511 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2513 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2514 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2516 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2517 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2518 self.update_time_counter += 1;
2522 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2523 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2524 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 2);
2525 msgs::RevokeAndACK {
2526 channel_id: self.channel_id,
2527 per_commitment_secret,
2528 next_per_commitment_point,
2532 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2533 let mut update_add_htlcs = Vec::new();
2534 let mut update_fulfill_htlcs = Vec::new();
2535 let mut update_fail_htlcs = Vec::new();
2536 let mut update_fail_malformed_htlcs = Vec::new();
2538 for htlc in self.pending_outbound_htlcs.iter() {
2539 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2540 update_add_htlcs.push(msgs::UpdateAddHTLC {
2541 channel_id: self.channel_id(),
2542 htlc_id: htlc.htlc_id,
2543 amount_msat: htlc.amount_msat,
2544 payment_hash: htlc.payment_hash,
2545 cltv_expiry: htlc.cltv_expiry,
2546 onion_routing_packet: (**onion_packet).clone(),
2551 for htlc in self.pending_inbound_htlcs.iter() {
2552 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2554 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2555 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2556 channel_id: self.channel_id(),
2557 htlc_id: htlc.htlc_id,
2558 reason: err_packet.clone()
2561 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2562 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2563 channel_id: self.channel_id(),
2564 htlc_id: htlc.htlc_id,
2565 sha256_of_onion: sha256_of_onion.clone(),
2566 failure_code: failure_code.clone(),
2569 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2570 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2571 channel_id: self.channel_id(),
2572 htlc_id: htlc.htlc_id,
2573 payment_preimage: payment_preimage.clone(),
2580 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2581 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2582 msgs::CommitmentUpdate {
2583 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2585 commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2589 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2590 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2591 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2592 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2593 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2594 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2595 // just close here instead of trying to recover.
2596 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2599 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2600 msg.next_local_commitment_number == 0 {
2601 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2604 if msg.next_remote_commitment_number > 0 {
2605 match msg.data_loss_protect {
2606 OptionalField::Present(ref data_loss) => {
2607 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 {
2608 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided"));
2610 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2611 return Err(ChannelError::CloseDelayBroadcast(
2612 "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"
2616 OptionalField::Absent => {}
2620 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2621 // remaining cases either succeed or ErrorMessage-fail).
2622 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2624 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2625 Some(msgs::Shutdown {
2626 channel_id: self.channel_id,
2627 scriptpubkey: self.get_closing_scriptpubkey(),
2631 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2632 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2633 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2634 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2635 if msg.next_remote_commitment_number != 0 {
2636 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2638 // Short circuit the whole handler as there is nothing we can resend them
2639 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2642 // We have OurFundingLocked set!
2643 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2644 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2645 return Ok((Some(msgs::FundingLocked {
2646 channel_id: self.channel_id(),
2647 next_per_commitment_point: next_per_commitment_point,
2648 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2651 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2652 // Remote isn't waiting on any RevokeAndACK from us!
2653 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2655 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2656 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2657 self.monitor_pending_revoke_and_ack = true;
2660 Some(self.get_last_revoke_and_ack())
2663 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2666 // We increment cur_remote_commitment_transaction_number only upon receipt of
2667 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2668 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2669 // the corresponding revoke_and_ack back yet.
2670 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 };
2672 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2673 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2674 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2675 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2676 Some(msgs::FundingLocked {
2677 channel_id: self.channel_id(),
2678 next_per_commitment_point: next_per_commitment_point,
2682 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2683 if required_revoke.is_some() {
2684 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2686 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2689 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2690 // We're up-to-date and not waiting on a remote revoke (if we are our
2691 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2692 // have received some updates while we were disconnected. Free the holding cell
2694 match self.free_holding_cell_htlcs() {
2695 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2696 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2697 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)),
2698 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2701 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2703 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2704 if required_revoke.is_some() {
2705 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2707 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2710 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2711 self.monitor_pending_commitment_signed = true;
2712 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2715 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, self.resend_order.clone(), shutdown_msg));
2717 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2721 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2722 where F::Target: FeeEstimator
2724 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2725 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2726 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2730 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2731 if self.feerate_per_kw > proposed_feerate {
2732 proposed_feerate = self.feerate_per_kw;
2734 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2735 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2737 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2738 let our_sig = self.local_keys
2739 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2741 if our_sig.is_none() { return None; }
2743 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2744 Some(msgs::ClosingSigned {
2745 channel_id: self.channel_id,
2746 fee_satoshis: total_fee_satoshis,
2747 signature: our_sig.unwrap(),
2751 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2752 where F::Target: FeeEstimator
2754 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2755 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2757 if self.channel_state < ChannelState::FundingSent as u32 {
2758 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2759 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2760 // can do that via error message without getting a connection fail anyway...
2761 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2763 for htlc in self.pending_inbound_htlcs.iter() {
2764 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2765 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2768 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2770 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2771 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2772 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2773 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2776 //Check shutdown_scriptpubkey form as BOLT says we must
2777 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2778 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2781 if self.their_shutdown_scriptpubkey.is_some() {
2782 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2783 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2786 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2789 // From here on out, we may not fail!
2791 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2792 self.update_time_counter += 1;
2794 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2795 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2796 // cell HTLCs and return them to fail the payment.
2797 self.holding_cell_update_fee = None;
2798 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2799 self.holding_cell_htlc_updates.retain(|htlc_update| {
2801 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2802 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2808 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2809 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2810 // any further commitment updates after we set LocalShutdownSent.
2812 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2815 Some(msgs::Shutdown {
2816 channel_id: self.channel_id,
2817 scriptpubkey: self.get_closing_scriptpubkey(),
2821 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2822 self.update_time_counter += 1;
2824 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2827 fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2828 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2829 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2830 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2832 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2834 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()).serialize();
2835 let their_funding_key = self.their_funding_pubkey().serialize();
2836 if our_funding_key[..] < their_funding_key[..] {
2837 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2838 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2840 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2841 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2843 tx.input[0].witness[1].push(SigHashType::All as u8);
2844 tx.input[0].witness[2].push(SigHashType::All as u8);
2846 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2849 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2850 where F::Target: FeeEstimator
2852 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2853 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2855 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2856 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2858 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2859 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2861 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2862 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2865 let funding_redeemscript = self.get_funding_redeemscript();
2866 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2867 if used_total_fee != msg.fee_satoshis {
2868 return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2870 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2872 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2874 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
2877 // The remote end may have decided to revoke their output due to inconsistent dust
2878 // limits, so check for that case by re-checking the signature here.
2879 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2880 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2881 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer");
2885 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
2886 if last_fee == msg.fee_satoshis {
2887 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2888 self.channel_state = ChannelState::ShutdownComplete as u32;
2889 self.update_time_counter += 1;
2890 return Ok((None, Some(closing_tx)));
2894 macro_rules! propose_new_feerate {
2895 ($new_feerate: expr) => {
2896 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2897 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2898 let our_sig = self.local_keys
2899 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2900 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2901 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
2902 return Ok((Some(msgs::ClosingSigned {
2903 channel_id: self.channel_id,
2904 fee_satoshis: used_total_fee,
2910 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight() as u64;
2911 if self.channel_outbound {
2912 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2913 if proposed_sat_per_kw > our_max_feerate {
2914 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2915 if our_max_feerate <= last_feerate {
2916 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2919 propose_new_feerate!(our_max_feerate);
2922 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2923 if proposed_sat_per_kw < our_min_feerate {
2924 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2925 if our_min_feerate >= last_feerate {
2926 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2929 propose_new_feerate!(our_min_feerate);
2933 let our_sig = self.local_keys
2934 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2935 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2936 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2938 self.channel_state = ChannelState::ShutdownComplete as u32;
2939 self.update_time_counter += 1;
2941 Ok((Some(msgs::ClosingSigned {
2942 channel_id: self.channel_id,
2943 fee_satoshis: msg.fee_satoshis,
2945 }), Some(closing_tx)))
2948 // Public utilities:
2950 pub fn channel_id(&self) -> [u8; 32] {
2954 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2955 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2956 pub fn get_user_id(&self) -> u64 {
2960 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2961 pub fn channel_monitor(&mut self) -> &mut ChannelMonitor<ChanSigner> {
2962 if self.channel_state < ChannelState::FundingSent as u32 {
2963 panic!("Can't get a channel monitor until funding has been created");
2965 self.channel_monitor.as_mut().unwrap()
2968 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2969 /// is_usable() returns true).
2970 /// Allowed in any state (including after shutdown)
2971 pub fn get_short_channel_id(&self) -> Option<u64> {
2972 self.short_channel_id
2975 /// Returns the funding_txo we either got from our peer, or were given by
2976 /// get_outbound_funding_created.
2977 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2981 /// Allowed in any state (including after shutdown)
2982 pub fn get_their_node_id(&self) -> PublicKey {
2986 /// Allowed in any state (including after shutdown)
2987 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2988 self.our_htlc_minimum_msat
2991 /// Allowed in any state (including after shutdown)
2992 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2993 self.our_htlc_minimum_msat
2996 pub fn get_value_satoshis(&self) -> u64 {
2997 self.channel_value_satoshis
3000 pub fn get_fee_proportional_millionths(&self) -> u32 {
3001 self.config.fee_proportional_millionths
3005 pub fn get_feerate(&self) -> u64 {
3009 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
3010 self.cur_local_commitment_transaction_number + 1
3013 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
3014 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3017 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
3018 self.cur_remote_commitment_transaction_number + 2
3022 pub fn get_local_keys(&self) -> &ChanSigner {
3027 pub fn get_value_stat(&self) -> ChannelValueStat {
3029 value_to_self_msat: self.value_to_self_msat,
3030 channel_value_msat: self.channel_value_satoshis * 1000,
3031 channel_reserve_msat: self.local_channel_reserve_satoshis * 1000,
3032 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3033 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3034 holding_cell_outbound_amount_msat: {
3036 for h in self.holding_cell_htlc_updates.iter() {
3038 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3046 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3050 /// Allowed in any state (including after shutdown)
3051 pub fn get_update_time_counter(&self) -> u32 {
3052 self.update_time_counter
3055 pub fn get_latest_monitor_update_id(&self) -> u64 {
3056 self.latest_monitor_update_id
3059 pub fn should_announce(&self) -> bool {
3060 self.config.announced_channel
3063 pub fn is_outbound(&self) -> bool {
3064 self.channel_outbound
3067 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3068 /// Allowed in any state (including after shutdown)
3069 pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3070 where F::Target: FeeEstimator
3072 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3073 // output value back into a transaction with the regular channel output:
3075 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3076 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3078 if self.channel_outbound {
3079 // + the marginal fee increase cost to us in the commitment transaction:
3080 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3083 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3084 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3089 /// Returns true if we've ever received a message from the remote end for this Channel
3090 pub fn have_received_message(&self) -> bool {
3091 self.channel_state > (ChannelState::OurInitSent as u32)
3094 /// Returns true if this channel is fully established and not known to be closing.
3095 /// Allowed in any state (including after shutdown)
3096 pub fn is_usable(&self) -> bool {
3097 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3098 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3101 /// Returns true if this channel is currently available for use. This is a superset of
3102 /// is_usable() and considers things like the channel being temporarily disabled.
3103 /// Allowed in any state (including after shutdown)
3104 pub fn is_live(&self) -> bool {
3105 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3108 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3109 /// Allowed in any state (including after shutdown)
3110 pub fn is_awaiting_monitor_update(&self) -> bool {
3111 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3114 /// Returns true if funding_created was sent/received.
3115 pub fn is_funding_initiated(&self) -> bool {
3116 self.channel_state >= ChannelState::FundingSent as u32
3119 /// Returns true if this channel is fully shut down. True here implies that no further actions
3120 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3121 /// will be handled appropriately by the chain monitor.
3122 pub fn is_shutdown(&self) -> bool {
3123 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3124 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3129 pub fn to_disabled_staged(&mut self) {
3130 self.network_sync = UpdateStatus::DisabledStaged;
3133 pub fn to_disabled_marked(&mut self) {
3134 self.network_sync = UpdateStatus::DisabledMarked;
3137 pub fn to_fresh(&mut self) {
3138 self.network_sync = UpdateStatus::Fresh;
3141 pub fn is_disabled_staged(&self) -> bool {
3142 self.network_sync == UpdateStatus::DisabledStaged
3145 pub fn is_disabled_marked(&self) -> bool {
3146 self.network_sync == UpdateStatus::DisabledMarked
3149 /// When we receive a new block, we (a) check whether the block contains the funding
3150 /// transaction (which would start us counting blocks until we send the funding_signed), and
3151 /// (b) check the height of the block against outbound holding cell HTLCs in case we need to
3152 /// give up on them prematurely and time them out. Everything else (e.g. commitment
3153 /// transaction broadcasts, channel closure detection, HTLC transaction broadcasting, etc) is
3154 /// handled by the ChannelMonitor.
3156 /// If we return Err, the channel may have been closed, at which point the standard
3157 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3159 /// Only returns an ErrorAction of DisconnectPeer, if Err.
3161 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3163 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> {
3164 let mut timed_out_htlcs = Vec::new();
3165 self.holding_cell_htlc_updates.retain(|htlc_update| {
3167 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3168 if *cltv_expiry <= height + HTLC_FAIL_BACK_BUFFER {
3169 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3176 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3177 if header.bitcoin_hash() != self.last_block_connected {
3178 if self.funding_tx_confirmations > 0 {
3179 self.funding_tx_confirmations += 1;
3182 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3183 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3184 if tx.txid() == self.funding_txo.unwrap().txid {
3185 let txo_idx = self.funding_txo.unwrap().index as usize;
3186 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3187 tx.output[txo_idx].value != self.channel_value_satoshis {
3188 if self.channel_outbound {
3189 // If we generated the funding transaction and it doesn't match what it
3190 // should, the client is really broken and we should just panic and
3191 // tell them off. That said, because hash collisions happen with high
3192 // probability in fuzztarget mode, if we're fuzzing we just close the
3193 // channel and move on.
3194 #[cfg(not(feature = "fuzztarget"))]
3195 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3197 self.channel_state = ChannelState::ShutdownComplete as u32;
3198 self.update_time_counter += 1;
3199 return Err(msgs::ErrorMessage {
3200 channel_id: self.channel_id(),
3201 data: "funding tx had wrong script/value".to_owned()
3204 if self.channel_outbound {
3205 for input in tx.input.iter() {
3206 if input.witness.is_empty() {
3207 // We generated a malleable funding transaction, implying we've
3208 // just exposed ourselves to funds loss to our counterparty.
3209 #[cfg(not(feature = "fuzztarget"))]
3210 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3214 self.funding_tx_confirmations = 1;
3215 self.short_channel_id = Some(((height as u64) << (5*8)) |
3216 ((*index_in_block as u64) << (2*8)) |
3217 ((txo_idx as u64) << (0*8)));
3222 if header.bitcoin_hash() != self.last_block_connected {
3223 self.last_block_connected = header.bitcoin_hash();
3224 self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3225 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3226 channel_monitor.last_block_hash = self.last_block_connected;
3228 if self.funding_tx_confirmations > 0 {
3229 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3230 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3231 self.channel_state |= ChannelState::OurFundingLocked as u32;
3233 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3234 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3235 self.update_time_counter += 1;
3237 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3238 // We got a reorg but not enough to trigger a force close, just update
3239 // funding_tx_confirmed_in and return.
3241 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3242 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3244 // We got a reorg but not enough to trigger a force close, just update
3245 // funding_tx_confirmed_in and return.
3248 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3250 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3251 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3252 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3253 //a protocol oversight, but I assume I'm just missing something.
3254 if need_commitment_update {
3255 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3256 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3257 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
3258 return Ok((Some(msgs::FundingLocked {
3259 channel_id: self.channel_id,
3260 next_per_commitment_point: next_per_commitment_point,
3261 }), timed_out_htlcs));
3263 self.monitor_pending_funding_locked = true;
3264 return Ok((None, timed_out_htlcs));
3270 Ok((None, timed_out_htlcs))
3273 /// Called by channelmanager based on chain blocks being disconnected.
3274 /// Returns true if we need to close the channel now due to funding transaction
3275 /// unconfirmation/reorg.
3276 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3277 if self.funding_tx_confirmations > 0 {
3278 self.funding_tx_confirmations -= 1;
3279 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3283 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3284 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3286 self.last_block_connected = header.bitcoin_hash();
3287 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3288 channel_monitor.last_block_hash = self.last_block_connected;
3293 // Methods to get unprompted messages to send to the remote end (or where we already returned
3294 // something in the handler for the message that prompted this message):
3296 pub fn get_open_channel<F: Deref>(&self, chain_hash: BlockHash, fee_estimator: &F) -> msgs::OpenChannel
3297 where F::Target: FeeEstimator
3299 if !self.channel_outbound {
3300 panic!("Tried to open a channel for an inbound channel?");
3302 if self.channel_state != ChannelState::OurInitSent as u32 {
3303 panic!("Cannot generate an open_channel after we've moved forward");
3306 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3307 panic!("Tried to send an open_channel for a channel that has already advanced");
3310 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3313 chain_hash: chain_hash,
3314 temporary_channel_id: self.channel_id,
3315 funding_satoshis: self.channel_value_satoshis,
3316 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3317 dust_limit_satoshis: self.our_dust_limit_satoshis,
3318 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3319 channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3320 htlc_minimum_msat: self.our_htlc_minimum_msat,
3321 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3322 to_self_delay: self.our_to_self_delay,
3323 max_accepted_htlcs: OUR_MAX_HTLCS,
3324 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3325 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3326 payment_point: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key()),
3327 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3328 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3329 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3330 channel_flags: if self.config.announced_channel {1} else {0},
3331 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3335 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3336 if self.channel_outbound {
3337 panic!("Tried to send accept_channel for an outbound channel?");
3339 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3340 panic!("Tried to send accept_channel after channel had moved forward");
3342 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3343 panic!("Tried to send an accept_channel for a channel that has already advanced");
3346 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3348 msgs::AcceptChannel {
3349 temporary_channel_id: self.channel_id,
3350 dust_limit_satoshis: self.our_dust_limit_satoshis,
3351 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3352 channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3353 htlc_minimum_msat: self.our_htlc_minimum_msat,
3354 minimum_depth: self.minimum_depth,
3355 to_self_delay: self.our_to_self_delay,
3356 max_accepted_htlcs: OUR_MAX_HTLCS,
3357 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3358 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3359 payment_point: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_key()),
3360 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3361 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3362 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3363 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3367 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3368 fn get_outbound_funding_created_signature(&mut self) -> Result<Signature, ChannelError> {
3369 let remote_keys = self.build_remote_transaction_keys()?;
3370 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3371 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)
3372 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0)
3375 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3376 /// a funding_created message for the remote peer.
3377 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3378 /// or if called on an inbound channel.
3379 /// Note that channel_id changes during this call!
3380 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3381 /// If an Err is returned, it is a ChannelError::Close.
3382 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<msgs::FundingCreated, ChannelError> {
3383 if !self.channel_outbound {
3384 panic!("Tried to create outbound funding_created message on an inbound channel!");
3386 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3387 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)");
3389 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3390 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3391 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3392 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3395 self.funding_txo = Some(funding_txo.clone());
3396 let our_signature = match self.get_outbound_funding_created_signature() {
3399 log_error!(self, "Got bad signatures: {:?}!", e);
3400 self.funding_txo = None;
3405 let temporary_channel_id = self.channel_id;
3407 // Now that we're past error-generating stuff, update our local state:
3409 self.channel_state = ChannelState::FundingCreated as u32;
3410 self.channel_id = funding_txo.to_channel_id();
3412 Ok(msgs::FundingCreated {
3413 temporary_channel_id,
3414 funding_txid: funding_txo.txid,
3415 funding_output_index: funding_txo.index,
3416 signature: our_signature
3420 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3421 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3422 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3423 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3424 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3426 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3427 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3428 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3429 if !self.config.announced_channel {
3430 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3432 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3433 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3435 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3436 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3439 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3440 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
3442 let msg = msgs::UnsignedChannelAnnouncement {
3443 features: ChannelFeatures::known(),
3444 chain_hash: chain_hash,
3445 short_channel_id: self.get_short_channel_id().unwrap(),
3446 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3447 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3448 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey().clone() },
3449 bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { our_bitcoin_key },
3450 excess_data: Vec::new(),
3453 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3454 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement"))?;
3459 /// May panic if called on a channel that wasn't immediately-previously
3460 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3461 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3462 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3463 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3464 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3465 // current to_remote balances. However, it no longer has any use, and thus is now simply
3466 // set to a dummy (but valid, as required by the spec) public key.
3467 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3468 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3469 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3470 let mut pk = [2; 33]; pk[1] = 0xff;
3471 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3472 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3473 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3474 log_trace!(self, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3475 OptionalField::Present(DataLossProtect {
3476 your_last_per_commitment_secret: remote_last_secret,
3477 my_current_per_commitment_point: dummy_pubkey
3480 log_info!(self, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3481 OptionalField::Present(DataLossProtect {
3482 your_last_per_commitment_secret: [0;32],
3483 my_current_per_commitment_point: dummy_pubkey,
3486 msgs::ChannelReestablish {
3487 channel_id: self.channel_id(),
3488 // The protocol has two different commitment number concepts - the "commitment
3489 // transaction number", which starts from 0 and counts up, and the "revocation key
3490 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3491 // commitment transaction numbers by the index which will be used to reveal the
3492 // revocation key for that commitment transaction, which means we have to convert them
3493 // to protocol-level commitment numbers here...
3495 // next_local_commitment_number is the next commitment_signed number we expect to
3496 // receive (indicating if they need to resend one that we missed).
3497 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3498 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3499 // receive, however we track it by the next commitment number for a remote transaction
3500 // (which is one further, as they always revoke previous commitment transaction, not
3501 // the one we send) so we have to decrement by 1. Note that if
3502 // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3503 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3505 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3511 // Send stuff to our remote peers:
3513 /// Adds a pending outbound HTLC to this channel, note that you probably want
3514 /// send_htlc_and_commit instead cause you'll want both messages at once.
3515 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3516 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3517 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3518 /// You MUST call send_commitment prior to any other calls on this Channel
3519 /// If an Err is returned, it's a ChannelError::Ignore!
3520 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> {
3521 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3522 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3525 if amount_msat > self.channel_value_satoshis * 1000 {
3526 return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3529 if amount_msat == 0 {
3530 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC"));
3533 if amount_msat < self.their_htlc_minimum_msat {
3534 return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3537 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3538 // Note that this should never really happen, if we're !is_live() on receipt of an
3539 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3540 // the user to send directly into a !is_live() channel. However, if we
3541 // disconnected during the time the previous hop was doing the commitment dance we may
3542 // end up getting here after the forwarding delay. In any case, returning an
3543 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3544 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3547 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3548 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3549 return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3551 // Check their_max_htlc_value_in_flight_msat
3552 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3553 return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
3556 // Check self.local_channel_reserve_satoshis (the amount we must keep as
3557 // reserve for the remote to have something to claim if we misbehave)
3558 if self.value_to_self_msat < self.local_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3559 return Err(ChannelError::Ignore("Cannot send value that would put us under local channel reserve value"));
3562 // Now update local state:
3563 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3564 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3565 amount_msat: amount_msat,
3566 payment_hash: payment_hash,
3567 cltv_expiry: cltv_expiry,
3569 onion_routing_packet: onion_routing_packet,
3574 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3575 htlc_id: self.next_local_htlc_id,
3576 amount_msat: amount_msat,
3577 payment_hash: payment_hash.clone(),
3578 cltv_expiry: cltv_expiry,
3579 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3583 let res = msgs::UpdateAddHTLC {
3584 channel_id: self.channel_id,
3585 htlc_id: self.next_local_htlc_id,
3586 amount_msat: amount_msat,
3587 payment_hash: payment_hash,
3588 cltv_expiry: cltv_expiry,
3589 onion_routing_packet: onion_routing_packet,
3591 self.next_local_htlc_id += 1;
3596 /// Creates a signed commitment transaction to send to the remote peer.
3597 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3598 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3599 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3600 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3601 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3602 panic!("Cannot create commitment tx until channel is fully established");
3604 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3605 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3607 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3608 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3610 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3611 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");
3613 let mut have_updates = self.pending_update_fee.is_some();
3614 for htlc in self.pending_outbound_htlcs.iter() {
3615 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3616 have_updates = true;
3618 if have_updates { break; }
3620 for htlc in self.pending_inbound_htlcs.iter() {
3621 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3622 have_updates = true;
3624 if have_updates { break; }
3627 panic!("Cannot create commitment tx until we have some updates to send");
3629 self.send_commitment_no_status_check()
3631 /// Only fails in case of bad keys
3632 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3633 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3634 // fail to generate this, we still are at least at a position where upgrading their status
3636 for htlc in self.pending_inbound_htlcs.iter_mut() {
3637 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3638 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3640 if let Some(state) = new_state {
3644 for htlc in self.pending_outbound_htlcs.iter_mut() {
3645 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3646 Some(fail_reason.take())
3648 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3651 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3653 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3654 Ok((res, (remote_commitment_tx, mut htlcs))) => {
3655 // Update state now that we've passed all the can-fail calls...
3656 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3657 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3658 (res, remote_commitment_tx, htlcs_no_ref)
3660 Err(e) => return Err(e),
3663 self.latest_monitor_update_id += 1;
3664 let monitor_update = ChannelMonitorUpdate {
3665 update_id: self.latest_monitor_update_id,
3666 updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3667 unsigned_commitment_tx: remote_commitment_tx.clone(),
3668 htlc_outputs: htlcs.clone(),
3669 commitment_number: self.cur_remote_commitment_transaction_number,
3670 their_revocation_point: self.their_cur_commitment_point.unwrap()
3673 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
3674 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3675 Ok((res, monitor_update))
3678 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3679 /// when we shouldn't change HTLC/channel state.
3680 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3681 let mut feerate_per_kw = self.feerate_per_kw;
3682 if let Some(feerate) = self.pending_update_fee {
3683 if self.channel_outbound {
3684 feerate_per_kw = feerate;
3688 let remote_keys = self.build_remote_transaction_keys()?;
3689 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3690 let (signature, htlc_signatures);
3693 let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3694 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3698 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)
3699 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?;
3701 htlc_signatures = res.1;
3703 log_trace!(self, "Signed remote commitment tx {} with redeemscript {} -> {}",
3704 encode::serialize_hex(&remote_commitment_tx.0),
3705 encode::serialize_hex(&self.get_funding_redeemscript()),
3706 log_bytes!(signature.serialize_compact()[..]));
3708 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3709 log_trace!(self, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3710 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)),
3711 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &remote_keys)),
3712 log_bytes!(remote_keys.a_htlc_key.serialize()),
3713 log_bytes!(htlc_sig.serialize_compact()[..]));
3717 Ok((msgs::CommitmentSigned {
3718 channel_id: self.channel_id,
3721 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3724 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3725 /// to send to the remote peer in one go.
3726 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3728 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> {
3729 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3730 Some(update_add_htlc) => {
3731 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3732 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3738 /// Begins the shutdown process, getting a message for the remote peer and returning all
3739 /// holding cell HTLCs for payment failure.
3740 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3741 for htlc in self.pending_outbound_htlcs.iter() {
3742 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3743 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3746 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3747 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3748 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3750 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3751 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3754 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3755 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3756 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3759 let our_closing_script = self.get_closing_scriptpubkey();
3761 // From here on out, we may not fail!
3762 if self.channel_state < ChannelState::FundingSent as u32 {
3763 self.channel_state = ChannelState::ShutdownComplete as u32;
3765 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3767 self.update_time_counter += 1;
3769 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3770 // our shutdown until we've committed all of the pending changes.
3771 self.holding_cell_update_fee = None;
3772 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3773 self.holding_cell_htlc_updates.retain(|htlc_update| {
3775 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3776 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3783 Ok((msgs::Shutdown {
3784 channel_id: self.channel_id,
3785 scriptpubkey: our_closing_script,
3786 }, dropped_outbound_htlcs))
3789 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3790 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3791 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3792 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3793 /// immediately (others we will have to allow to time out).
3794 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>) {
3795 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3797 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3798 // return them to fail the payment.
3799 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3800 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3802 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3803 dropped_outbound_htlcs.push((source, payment_hash));
3809 for _htlc in self.pending_outbound_htlcs.drain(..) {
3810 //TODO: Do something with the remaining HTLCs
3811 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3815 self.channel_state = ChannelState::ShutdownComplete as u32;
3816 self.update_time_counter += 1;
3817 self.latest_monitor_update_id += 1;
3818 (self.funding_txo.clone(), ChannelMonitorUpdate {
3819 update_id: self.latest_monitor_update_id,
3820 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3821 }, dropped_outbound_htlcs)
3825 const SERIALIZATION_VERSION: u8 = 1;
3826 const MIN_SERIALIZATION_VERSION: u8 = 1;
3828 impl Writeable for InboundHTLCRemovalReason {
3829 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3831 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3833 error_packet.write(writer)?;
3835 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3837 onion_hash.write(writer)?;
3838 err_code.write(writer)?;
3840 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3842 payment_preimage.write(writer)?;
3849 impl Readable for InboundHTLCRemovalReason {
3850 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
3851 Ok(match <u8 as Readable>::read(reader)? {
3852 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3853 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3854 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3855 _ => return Err(DecodeError::InvalidValue),
3860 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
3861 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3862 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3863 // called but include holding cell updates (and obviously we don't modify self).
3865 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3866 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3868 self.user_id.write(writer)?;
3869 self.config.write(writer)?;
3871 self.channel_id.write(writer)?;
3872 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3873 self.channel_outbound.write(writer)?;
3874 self.channel_value_satoshis.write(writer)?;
3876 self.latest_monitor_update_id.write(writer)?;
3878 self.local_keys.write(writer)?;
3879 self.shutdown_pubkey.write(writer)?;
3880 self.destination_script.write(writer)?;
3882 self.cur_local_commitment_transaction_number.write(writer)?;
3883 self.cur_remote_commitment_transaction_number.write(writer)?;
3884 self.value_to_self_msat.write(writer)?;
3886 let mut dropped_inbound_htlcs = 0;
3887 for htlc in self.pending_inbound_htlcs.iter() {
3888 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3889 dropped_inbound_htlcs += 1;
3892 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3893 for htlc in self.pending_inbound_htlcs.iter() {
3894 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
3897 htlc.htlc_id.write(writer)?;
3898 htlc.amount_msat.write(writer)?;
3899 htlc.cltv_expiry.write(writer)?;
3900 htlc.payment_hash.write(writer)?;
3902 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
3903 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3905 htlc_state.write(writer)?;
3907 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3909 htlc_state.write(writer)?;
3911 &InboundHTLCState::Committed => {
3914 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3916 removal_reason.write(writer)?;
3921 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3922 for htlc in self.pending_outbound_htlcs.iter() {
3923 htlc.htlc_id.write(writer)?;
3924 htlc.amount_msat.write(writer)?;
3925 htlc.cltv_expiry.write(writer)?;
3926 htlc.payment_hash.write(writer)?;
3927 htlc.source.write(writer)?;
3929 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3931 onion_packet.write(writer)?;
3933 &OutboundHTLCState::Committed => {
3936 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3938 fail_reason.write(writer)?;
3940 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3942 fail_reason.write(writer)?;
3944 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3946 fail_reason.write(writer)?;
3951 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3952 for update in self.holding_cell_htlc_updates.iter() {
3954 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3956 amount_msat.write(writer)?;
3957 cltv_expiry.write(writer)?;
3958 payment_hash.write(writer)?;
3959 source.write(writer)?;
3960 onion_routing_packet.write(writer)?;
3962 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3964 payment_preimage.write(writer)?;
3965 htlc_id.write(writer)?;
3967 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3969 htlc_id.write(writer)?;
3970 err_packet.write(writer)?;
3975 match self.resend_order {
3976 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3977 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3980 self.monitor_pending_funding_locked.write(writer)?;
3981 self.monitor_pending_revoke_and_ack.write(writer)?;
3982 self.monitor_pending_commitment_signed.write(writer)?;
3984 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3985 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3986 pending_forward.write(writer)?;
3987 htlc_id.write(writer)?;
3990 (self.monitor_pending_failures.len() as u64).write(writer)?;
3991 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3992 htlc_source.write(writer)?;
3993 payment_hash.write(writer)?;
3994 fail_reason.write(writer)?;
3997 self.pending_update_fee.write(writer)?;
3998 self.holding_cell_update_fee.write(writer)?;
4000 self.next_local_htlc_id.write(writer)?;
4001 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
4002 self.update_time_counter.write(writer)?;
4003 self.feerate_per_kw.write(writer)?;
4005 match self.last_sent_closing_fee {
4006 Some((feerate, fee, sig)) => {
4008 feerate.write(writer)?;
4012 None => 0u8.write(writer)?,
4015 self.funding_txo.write(writer)?;
4016 self.funding_tx_confirmed_in.write(writer)?;
4017 self.short_channel_id.write(writer)?;
4019 self.last_block_connected.write(writer)?;
4020 self.funding_tx_confirmations.write(writer)?;
4022 self.their_dust_limit_satoshis.write(writer)?;
4023 self.our_dust_limit_satoshis.write(writer)?;
4024 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4025 self.local_channel_reserve_satoshis.write(writer)?;
4026 self.their_htlc_minimum_msat.write(writer)?;
4027 self.our_htlc_minimum_msat.write(writer)?;
4028 self.their_to_self_delay.write(writer)?;
4029 self.our_to_self_delay.write(writer)?;
4030 self.their_max_accepted_htlcs.write(writer)?;
4031 self.minimum_depth.write(writer)?;
4033 self.their_pubkeys.write(writer)?;
4034 self.their_cur_commitment_point.write(writer)?;
4036 self.their_prev_commitment_point.write(writer)?;
4037 self.their_node_id.write(writer)?;
4039 self.their_shutdown_scriptpubkey.write(writer)?;
4041 self.commitment_secrets.write(writer)?;
4043 self.channel_monitor.as_ref().unwrap().write_for_disk(writer)?;
4048 impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for Channel<ChanSigner> {
4049 fn read<R : ::std::io::Read>(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
4050 let _ver: u8 = Readable::read(reader)?;
4051 let min_ver: u8 = Readable::read(reader)?;
4052 if min_ver > SERIALIZATION_VERSION {
4053 return Err(DecodeError::UnknownVersion);
4056 let user_id = Readable::read(reader)?;
4057 let config: ChannelConfig = Readable::read(reader)?;
4059 let channel_id = Readable::read(reader)?;
4060 let channel_state = Readable::read(reader)?;
4061 let channel_outbound = Readable::read(reader)?;
4062 let channel_value_satoshis = Readable::read(reader)?;
4064 let latest_monitor_update_id = Readable::read(reader)?;
4066 let local_keys = Readable::read(reader)?;
4067 let shutdown_pubkey = Readable::read(reader)?;
4068 let destination_script = Readable::read(reader)?;
4070 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4071 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4072 let value_to_self_msat = Readable::read(reader)?;
4074 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4075 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4076 for _ in 0..pending_inbound_htlc_count {
4077 pending_inbound_htlcs.push(InboundHTLCOutput {
4078 htlc_id: Readable::read(reader)?,
4079 amount_msat: Readable::read(reader)?,
4080 cltv_expiry: Readable::read(reader)?,
4081 payment_hash: Readable::read(reader)?,
4082 state: match <u8 as Readable>::read(reader)? {
4083 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4084 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4085 3 => InboundHTLCState::Committed,
4086 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4087 _ => return Err(DecodeError::InvalidValue),
4092 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4093 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4094 for _ in 0..pending_outbound_htlc_count {
4095 pending_outbound_htlcs.push(OutboundHTLCOutput {
4096 htlc_id: Readable::read(reader)?,
4097 amount_msat: Readable::read(reader)?,
4098 cltv_expiry: Readable::read(reader)?,
4099 payment_hash: Readable::read(reader)?,
4100 source: Readable::read(reader)?,
4101 state: match <u8 as Readable>::read(reader)? {
4102 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4103 1 => OutboundHTLCState::Committed,
4104 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4105 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4106 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4107 _ => return Err(DecodeError::InvalidValue),
4112 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4113 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4114 for _ in 0..holding_cell_htlc_update_count {
4115 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4116 0 => HTLCUpdateAwaitingACK::AddHTLC {
4117 amount_msat: Readable::read(reader)?,
4118 cltv_expiry: Readable::read(reader)?,
4119 payment_hash: Readable::read(reader)?,
4120 source: Readable::read(reader)?,
4121 onion_routing_packet: Readable::read(reader)?,
4123 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4124 payment_preimage: Readable::read(reader)?,
4125 htlc_id: Readable::read(reader)?,
4127 2 => HTLCUpdateAwaitingACK::FailHTLC {
4128 htlc_id: Readable::read(reader)?,
4129 err_packet: Readable::read(reader)?,
4131 _ => return Err(DecodeError::InvalidValue),
4135 let resend_order = match <u8 as Readable>::read(reader)? {
4136 0 => RAACommitmentOrder::CommitmentFirst,
4137 1 => RAACommitmentOrder::RevokeAndACKFirst,
4138 _ => return Err(DecodeError::InvalidValue),
4141 let monitor_pending_funding_locked = Readable::read(reader)?;
4142 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4143 let monitor_pending_commitment_signed = Readable::read(reader)?;
4145 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4146 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4147 for _ in 0..monitor_pending_forwards_count {
4148 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4151 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4152 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4153 for _ in 0..monitor_pending_failures_count {
4154 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4157 let pending_update_fee = Readable::read(reader)?;
4158 let holding_cell_update_fee = Readable::read(reader)?;
4160 let next_local_htlc_id = Readable::read(reader)?;
4161 let next_remote_htlc_id = Readable::read(reader)?;
4162 let update_time_counter = Readable::read(reader)?;
4163 let feerate_per_kw = Readable::read(reader)?;
4165 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4167 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4168 _ => return Err(DecodeError::InvalidValue),
4171 let funding_txo = Readable::read(reader)?;
4172 let funding_tx_confirmed_in = Readable::read(reader)?;
4173 let short_channel_id = Readable::read(reader)?;
4175 let last_block_connected = Readable::read(reader)?;
4176 let funding_tx_confirmations = Readable::read(reader)?;
4178 let their_dust_limit_satoshis = Readable::read(reader)?;
4179 let our_dust_limit_satoshis = Readable::read(reader)?;
4180 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4181 let local_channel_reserve_satoshis = Readable::read(reader)?;
4182 let their_htlc_minimum_msat = Readable::read(reader)?;
4183 let our_htlc_minimum_msat = Readable::read(reader)?;
4184 let their_to_self_delay = Readable::read(reader)?;
4185 let our_to_self_delay = Readable::read(reader)?;
4186 let their_max_accepted_htlcs = Readable::read(reader)?;
4187 let minimum_depth = Readable::read(reader)?;
4189 let their_pubkeys = Readable::read(reader)?;
4190 let their_cur_commitment_point = Readable::read(reader)?;
4192 let their_prev_commitment_point = Readable::read(reader)?;
4193 let their_node_id = Readable::read(reader)?;
4195 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4196 let commitment_secrets = Readable::read(reader)?;
4198 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
4199 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
4200 // doing full block connection operations on the internal ChannelMonitor copies
4201 if monitor_last_block != last_block_connected {
4202 return Err(DecodeError::InvalidValue);
4212 secp_ctx: Secp256k1::new(),
4213 channel_value_satoshis,
4215 latest_monitor_update_id,
4221 cur_local_commitment_transaction_number,
4222 cur_remote_commitment_transaction_number,
4225 pending_inbound_htlcs,
4226 pending_outbound_htlcs,
4227 holding_cell_htlc_updates,
4231 monitor_pending_funding_locked,
4232 monitor_pending_revoke_and_ack,
4233 monitor_pending_commitment_signed,
4234 monitor_pending_forwards,
4235 monitor_pending_failures,
4238 holding_cell_update_fee,
4240 next_remote_htlc_id,
4241 update_time_counter,
4244 #[cfg(debug_assertions)]
4245 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4246 #[cfg(debug_assertions)]
4247 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4249 last_sent_closing_fee,
4252 funding_tx_confirmed_in,
4254 last_block_connected,
4255 funding_tx_confirmations,
4257 their_dust_limit_satoshis,
4258 our_dust_limit_satoshis,
4259 their_max_htlc_value_in_flight_msat,
4260 local_channel_reserve_satoshis,
4261 their_htlc_minimum_msat,
4262 our_htlc_minimum_msat,
4263 their_to_self_delay,
4265 their_max_accepted_htlcs,
4269 their_cur_commitment_point,
4271 their_prev_commitment_point,
4274 their_shutdown_scriptpubkey,
4276 channel_monitor: Some(channel_monitor),
4279 network_sync: UpdateStatus::Fresh,
4288 use bitcoin::BitcoinHash;
4289 use bitcoin::util::bip143;
4290 use bitcoin::consensus::encode::serialize;
4291 use bitcoin::blockdata::script::{Script, Builder};
4292 use bitcoin::blockdata::transaction::{Transaction, TxOut};
4293 use bitcoin::blockdata::constants::genesis_block;
4294 use bitcoin::blockdata::opcodes;
4295 use bitcoin::network::constants::Network;
4296 use bitcoin::hashes::hex::FromHex;
4298 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4299 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4300 use ln::channel::MAX_FUNDING_SATOSHIS;
4301 use ln::features::InitFeatures;
4302 use ln::msgs::{OptionalField, DataLossProtect};
4304 use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4305 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4306 use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4307 use chain::transaction::OutPoint;
4308 use util::config::UserConfig;
4309 use util::enforcing_trait_impls::EnforcingChannelKeys;
4310 use util::test_utils;
4311 use util::logger::Logger;
4312 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4313 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4314 use bitcoin::hashes::sha256::Hash as Sha256;
4315 use bitcoin::hashes::Hash;
4316 use bitcoin::hash_types::{Txid, WPubkeyHash};
4318 use rand::{thread_rng,Rng};
4320 struct TestFeeEstimator {
4323 impl FeeEstimator for TestFeeEstimator {
4324 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4330 fn test_max_funding_satoshis() {
4331 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4332 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4336 chan_keys: InMemoryChannelKeys,
4338 impl KeysInterface for Keys {
4339 type ChanKeySigner = InMemoryChannelKeys;
4341 fn get_node_secret(&self) -> SecretKey { panic!(); }
4342 fn get_destination_script(&self) -> Script {
4343 let secp_ctx = Secp256k1::signing_only();
4344 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4345 let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4346 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4349 fn get_shutdown_pubkey(&self) -> PublicKey {
4350 let secp_ctx = Secp256k1::signing_only();
4351 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4352 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4355 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4356 self.chan_keys.clone()
4358 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) { panic!(); }
4359 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4362 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4363 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4367 fn channel_reestablish_no_updates() {
4368 let feeest = TestFeeEstimator{fee_est: 15000};
4369 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4370 let secp_ctx = Secp256k1::new();
4371 let mut seed = [0; 32];
4372 let mut rng = thread_rng();
4373 rng.fill_bytes(&mut seed);
4374 let network = Network::Testnet;
4375 let keys_provider = test_utils::TestKeysInterface::new(&seed, network, logger.clone() as Arc<Logger>);
4377 // Go through the flow of opening a channel between two nodes.
4379 // Create Node A's channel
4380 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4381 let config = UserConfig::default();
4382 let mut node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&feeest, &&keys_provider, node_a_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap();
4384 // Create Node B's channel by receiving Node A's open_channel message
4385 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash(), &&feeest);
4386 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4387 let mut node_b_chan = Channel::<EnforcingChannelKeys>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, logger, &config).unwrap();
4389 // Node B --> Node A: accept channel
4390 let accept_channel_msg = node_b_chan.get_accept_channel();
4391 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4393 // Node A --> Node B: funding created
4394 let output_script = node_a_chan.get_funding_redeemscript();
4395 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4396 value: 10000000, script_pubkey: output_script.clone(),
4398 let funding_outpoint = OutPoint::new(tx.txid(), 0);
4399 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint).unwrap();
4400 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg).unwrap();
4402 // Node B --> Node A: funding signed
4403 let _ = node_a_chan.funding_signed(&funding_signed_msg);
4405 // Now disconnect the two nodes and check that the commitment point in
4406 // Node B's channel_reestablish message is sane.
4407 node_b_chan.remove_uncommitted_htlcs_and_mark_paused();
4408 let msg = node_b_chan.get_channel_reestablish();
4409 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4410 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4411 match msg.data_loss_protect {
4412 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4413 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4418 // Check that the commitment point in Node A's channel_reestablish message
4420 node_a_chan.remove_uncommitted_htlcs_and_mark_paused();
4421 let msg = node_a_chan.get_channel_reestablish();
4422 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4423 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4424 match msg.data_loss_protect {
4425 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4426 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4433 fn outbound_commitment_test() {
4434 // Test vectors from BOLT 3 Appendix C:
4435 let feeest = TestFeeEstimator{fee_est: 15000};
4436 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4437 let secp_ctx = Secp256k1::new();
4439 let mut chan_keys = InMemoryChannelKeys::new(
4441 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4442 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4443 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4444 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4445 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4447 // These aren't set in the test vectors:
4448 [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],
4452 assert_eq!(PublicKey::from_secret_key(&secp_ctx, chan_keys.funding_key()).serialize()[..],
4453 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4454 let keys_provider = Keys { chan_keys: chan_keys.clone() };
4456 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4457 let mut config = UserConfig::default();
4458 config.channel_options.announced_channel = false;
4459 let mut chan = Channel::<InMemoryChannelKeys>::new_outbound(&&feeest, &&keys_provider, their_node_id, 10_000_000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4460 chan.their_to_self_delay = 144;
4461 chan.our_dust_limit_satoshis = 546;
4463 let funding_info = OutPoint::new(Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4464 chan.funding_txo = Some(funding_info);
4466 let their_pubkeys = ChannelPublicKeys {
4467 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4468 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4469 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4470 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4471 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4473 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
4475 assert_eq!(their_pubkeys.payment_point.serialize()[..],
4476 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4478 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4479 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4481 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4482 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4484 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4485 // derived from a commitment_seed, so instead we copy it here and call
4486 // build_commitment_transaction.
4487 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.delayed_payment_base_key());
4488 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4489 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4490 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.htlc_base_key());
4491 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint).unwrap();
4493 chan.their_pubkeys = Some(their_pubkeys);
4495 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4498 macro_rules! test_commitment {
4499 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr, {
4500 $( { $htlc_idx: expr, $their_htlc_sig_hex: expr, $our_htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
4503 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4504 let htlcs = res.2.drain(..)
4505 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4509 let redeemscript = chan.get_funding_redeemscript();
4510 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4511 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4512 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4514 let mut per_htlc = Vec::new();
4515 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
4517 let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4518 per_htlc.push((unsigned_tx.1[$htlc_idx].clone(), Some(remote_signature)));
4520 assert_eq!(unsigned_tx.1.len(), per_htlc.len());
4522 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);
4523 let local_sig = chan_keys.sign_local_commitment(&localtx, &chan.secp_ctx).unwrap();
4524 assert_eq!(Signature::from_der(&hex::decode($our_sig_hex).unwrap()[..]).unwrap(), local_sig);
4526 assert_eq!(serialize(&localtx.add_local_sig(&redeemscript, local_sig))[..],
4527 hex::decode($tx_hex).unwrap()[..]);
4529 let htlc_sigs = chan_keys.sign_local_commitment_htlc_transactions(&localtx, chan.their_to_self_delay, &chan.secp_ctx).unwrap();
4530 let mut htlc_sig_iter = localtx.per_htlc.iter().zip(htlc_sigs.iter().enumerate());
4533 let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4535 let ref htlc = unsigned_tx.1[$htlc_idx];
4536 let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4537 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4538 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4539 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4541 let mut preimage: Option<PaymentPreimage> = None;
4544 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4545 if out == htlc.payment_hash {
4546 preimage = Some(PaymentPreimage([i; 32]));
4550 assert!(preimage.is_some());
4553 let mut htlc_sig = htlc_sig_iter.next().unwrap();
4554 while (htlc_sig.1).1.is_none() { htlc_sig = htlc_sig_iter.next().unwrap(); }
4555 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx));
4557 let our_signature = Signature::from_der(&hex::decode($our_htlc_sig_hex).unwrap()[..]).unwrap();
4558 assert_eq!(Some(our_signature), *(htlc_sig.1).1);
4559 assert_eq!(serialize(&localtx.get_signed_htlc_tx((htlc_sig.1).0, &(htlc_sig.1).1.unwrap(), &preimage, chan.their_to_self_delay))[..],
4560 hex::decode($htlc_tx_hex).unwrap()[..]);
4563 let htlc_sig = htlc_sig_iter.next();
4564 if htlc_sig.is_none() { break; }
4565 assert!((htlc_sig.unwrap().1).1.is_none());
4570 // simple commitment tx with no HTLCs
4571 chan.value_to_self_msat = 7000000000;
4573 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
4574 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
4575 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4577 chan.pending_inbound_htlcs.push({
4578 let mut out = InboundHTLCOutput{
4580 amount_msat: 1000000,
4582 payment_hash: PaymentHash([0; 32]),
4583 state: InboundHTLCState::Committed,
4585 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4588 chan.pending_inbound_htlcs.push({
4589 let mut out = InboundHTLCOutput{
4591 amount_msat: 2000000,
4593 payment_hash: PaymentHash([0; 32]),
4594 state: InboundHTLCState::Committed,
4596 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4599 chan.pending_outbound_htlcs.push({
4600 let mut out = OutboundHTLCOutput{
4602 amount_msat: 2000000,
4604 payment_hash: PaymentHash([0; 32]),
4605 state: OutboundHTLCState::Committed,
4606 source: HTLCSource::dummy(),
4608 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4611 chan.pending_outbound_htlcs.push({
4612 let mut out = OutboundHTLCOutput{
4614 amount_msat: 3000000,
4616 payment_hash: PaymentHash([0; 32]),
4617 state: OutboundHTLCState::Committed,
4618 source: HTLCSource::dummy(),
4620 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4623 chan.pending_inbound_htlcs.push({
4624 let mut out = InboundHTLCOutput{
4626 amount_msat: 4000000,
4628 payment_hash: PaymentHash([0; 32]),
4629 state: InboundHTLCState::Committed,
4631 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4635 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4636 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4637 chan.feerate_per_kw = 0;
4639 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
4640 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
4641 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4644 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
4645 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
4646 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4649 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
4650 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
4651 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4654 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
4655 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
4656 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4659 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
4660 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
4661 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4664 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
4665 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
4666 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4669 // commitment tx with seven outputs untrimmed (maximum feerate)
4670 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4671 chan.feerate_per_kw = 647;
4673 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
4674 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
4675 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4678 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
4679 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
4680 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4683 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
4684 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
4685 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4688 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
4689 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
4690 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4693 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
4694 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
4695 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4698 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
4699 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
4700 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4703 // commitment tx with six outputs untrimmed (minimum feerate)
4704 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4705 chan.feerate_per_kw = 648;
4707 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
4708 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
4709 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4712 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
4713 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
4714 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4717 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
4718 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
4719 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4722 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
4723 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
4724 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4727 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
4728 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
4729 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4732 // commitment tx with six outputs untrimmed (maximum feerate)
4733 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4734 chan.feerate_per_kw = 2069;
4736 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
4737 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
4738 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4741 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
4742 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
4743 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4746 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
4747 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
4748 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4751 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
4752 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
4753 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4756 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
4757 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
4758 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4761 // commitment tx with five outputs untrimmed (minimum feerate)
4762 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4763 chan.feerate_per_kw = 2070;
4765 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
4766 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
4767 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4770 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
4771 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
4772 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4775 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
4776 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
4777 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4780 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
4781 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
4782 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4785 // commitment tx with five outputs untrimmed (maximum feerate)
4786 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4787 chan.feerate_per_kw = 2194;
4789 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
4790 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
4791 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4794 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
4795 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
4796 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4799 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
4800 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
4801 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4804 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
4805 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
4806 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4809 // commitment tx with four outputs untrimmed (minimum feerate)
4810 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4811 chan.feerate_per_kw = 2195;
4813 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
4814 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
4815 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4818 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
4819 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
4820 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4823 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
4824 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
4825 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4828 // commitment tx with four outputs untrimmed (maximum feerate)
4829 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4830 chan.feerate_per_kw = 3702;
4832 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
4833 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
4834 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4837 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
4838 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
4839 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4842 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
4843 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
4844 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4847 // commitment tx with three outputs untrimmed (minimum feerate)
4848 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4849 chan.feerate_per_kw = 3703;
4851 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
4852 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
4853 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4856 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
4857 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
4858 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4861 // commitment tx with three outputs untrimmed (maximum feerate)
4862 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4863 chan.feerate_per_kw = 4914;
4865 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
4866 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
4867 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4870 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
4871 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
4872 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4875 // commitment tx with two outputs untrimmed (minimum feerate)
4876 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4877 chan.feerate_per_kw = 4915;
4879 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
4880 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
4881 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4883 // commitment tx with two outputs untrimmed (maximum feerate)
4884 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4885 chan.feerate_per_kw = 9651180;
4887 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
4888 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
4889 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4891 // commitment tx with one output untrimmed (minimum feerate)
4892 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4893 chan.feerate_per_kw = 9651181;
4895 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
4896 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
4897 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4899 // commitment tx with fee greater than funder amount
4900 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4901 chan.feerate_per_kw = 9651936;
4903 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
4904 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
4905 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4909 fn test_per_commitment_secret_gen() {
4910 // Test vectors from BOLT 3 Appendix D:
4912 let mut seed = [0; 32];
4913 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4914 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4915 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4917 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4918 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4919 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4921 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
4922 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4924 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
4925 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4927 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4928 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
4929 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4933 fn test_key_derivation() {
4934 // Test vectors from BOLT 3 Appendix E:
4935 let secp_ctx = Secp256k1::new();
4937 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4938 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4940 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4941 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4943 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4944 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4946 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4947 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4949 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4950 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4952 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4953 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4955 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4956 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());