1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
12 use bitcoin::util::bip143;
13 use bitcoin::consensus::encode;
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, InitFeatures};
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::ShutdownScript;
30 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor};
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::transaction_utils;
39 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
40 use util::logger::Logger;
41 use util::errors::APIError;
42 use util::config::{UserConfig,ChannelConfig};
43 use util::scid_utils::scid_from_parts;
47 use core::{cmp,mem,fmt};
48 use core::convert::TryFrom;
50 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
52 use bitcoin::hashes::hex::ToHex;
55 pub struct ChannelValueStat {
56 pub value_to_self_msat: u64,
57 pub channel_value_msat: u64,
58 pub channel_reserve_msat: u64,
59 pub pending_outbound_htlcs_amount_msat: u64,
60 pub pending_inbound_htlcs_amount_msat: u64,
61 pub holding_cell_outbound_amount_msat: u64,
62 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
63 pub counterparty_dust_limit_msat: u64,
66 #[derive(Clone, Copy, PartialEq)]
68 // Inbound states mirroring InboundHTLCState
70 AwaitingRemoteRevokeToAnnounce,
71 // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
72 // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
73 // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
74 // the fee update anywhere, we can simply consider the fee update `Committed` immediately
75 // instead of setting it to AwaitingAnnouncedRemoteRevoke.
77 // Outbound state can only be `LocalAnnounced` or `Committed`
81 enum InboundHTLCRemovalReason {
82 FailRelay(msgs::OnionErrorPacket),
83 FailMalformed(([u8; 32], u16)),
84 Fulfill(PaymentPreimage),
87 enum InboundHTLCState {
88 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
89 /// update_add_htlc message for this HTLC.
90 RemoteAnnounced(PendingHTLCStatus),
91 /// Included in a received commitment_signed message (implying we've
92 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
93 /// state (see the example below). We have not yet included this HTLC in a
94 /// commitment_signed message because we are waiting on the remote's
95 /// aforementioned state revocation. One reason this missing remote RAA
96 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
97 /// is because every time we create a new "state", i.e. every time we sign a
98 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
99 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
100 /// sent provided the per_commitment_point for our current commitment tx.
101 /// The other reason we should not send a commitment_signed without their RAA
102 /// is because their RAA serves to ACK our previous commitment_signed.
104 /// Here's an example of how an HTLC could come to be in this state:
105 /// remote --> update_add_htlc(prev_htlc) --> local
106 /// remote --> commitment_signed(prev_htlc) --> local
107 /// remote <-- revoke_and_ack <-- local
108 /// remote <-- commitment_signed(prev_htlc) <-- local
109 /// [note that here, the remote does not respond with a RAA]
110 /// remote --> update_add_htlc(this_htlc) --> local
111 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
112 /// Now `this_htlc` will be assigned this state. It's unable to be officially
113 /// accepted, i.e. included in a commitment_signed, because we're missing the
114 /// RAA that provides our next per_commitment_point. The per_commitment_point
115 /// is used to derive commitment keys, which are used to construct the
116 /// signatures in a commitment_signed message.
117 /// Implies AwaitingRemoteRevoke.
119 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
120 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
121 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
122 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
123 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
124 /// channel (before it can then get forwarded and/or removed).
125 /// Implies AwaitingRemoteRevoke.
126 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
128 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
129 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
131 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
132 /// commitment transaction without it as otherwise we'll have to force-close the channel to
133 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
134 /// anyway). That said, ChannelMonitor does this for us (see
135 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
136 /// our own local state before then, once we're sure that the next commitment_signed and
137 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
138 LocalRemoved(InboundHTLCRemovalReason),
141 struct InboundHTLCOutput {
145 payment_hash: PaymentHash,
146 state: InboundHTLCState,
149 enum OutboundHTLCState {
150 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
151 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
152 /// we will promote to Committed (note that they may not accept it until the next time we
153 /// revoke, but we don't really care about that:
154 /// * they've revoked, so worst case we can announce an old state and get our (option on)
155 /// money back (though we won't), and,
156 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
157 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
158 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
159 /// we'll never get out of sync).
160 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
161 /// OutboundHTLCOutput's size just for a temporary bit
162 LocalAnnounced(Box<msgs::OnionPacket>),
164 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
165 /// the change (though they'll need to revoke before we fail the payment).
166 RemoteRemoved(Option<HTLCFailReason>),
167 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
168 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
169 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
170 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
171 /// remote revoke_and_ack on a previous state before we can do so.
172 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
173 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
174 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
175 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
176 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
177 /// revoke_and_ack to drop completely.
178 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
181 struct OutboundHTLCOutput {
185 payment_hash: PaymentHash,
186 state: OutboundHTLCState,
190 /// See AwaitingRemoteRevoke ChannelState for more info
191 enum HTLCUpdateAwaitingACK {
192 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
196 payment_hash: PaymentHash,
198 onion_routing_packet: msgs::OnionPacket,
201 payment_preimage: PaymentPreimage,
206 err_packet: msgs::OnionErrorPacket,
210 /// There are a few "states" and then a number of flags which can be applied:
211 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
212 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
213 /// move on to ChannelFunded.
214 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
215 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
216 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
218 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
219 OurInitSent = 1 << 0,
220 /// Implies we have received their open_channel/accept_channel message
221 TheirInitSent = 1 << 1,
222 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
223 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
224 /// upon receipt of funding_created, so simply skip this state.
226 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
227 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
228 /// and our counterparty consider the funding transaction confirmed.
230 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
231 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
232 TheirFundingLocked = 1 << 4,
233 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
234 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
235 OurFundingLocked = 1 << 5,
237 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
238 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
240 PeerDisconnected = 1 << 7,
241 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
242 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
243 /// outbound messages until they've managed to do so.
244 MonitorUpdateFailed = 1 << 8,
245 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
246 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
247 /// messages as then we will be unable to determine which HTLCs they included in their
248 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
250 /// Flag is set on ChannelFunded.
251 AwaitingRemoteRevoke = 1 << 9,
252 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
253 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
254 /// to respond with our own shutdown message when possible.
255 RemoteShutdownSent = 1 << 10,
256 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
257 /// point, we may not add any new HTLCs to the channel.
258 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
259 /// us their shutdown.
260 LocalShutdownSent = 1 << 11,
261 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
262 /// to drop us, but we store this anyway.
263 ShutdownComplete = 4096,
265 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
266 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
268 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
270 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
271 /// our counterparty or not. However, we don't want to announce updates right away to avoid
272 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
273 /// our channel_update message and track the current state here.
274 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
275 #[derive(Clone, Copy, PartialEq)]
276 pub(super) enum ChannelUpdateStatus {
277 /// We've announced the channel as enabled and are connected to our peer.
279 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
281 /// Our channel is live again, but we haven't announced the channel as enabled yet.
283 /// We've announced the channel as disabled.
287 /// An enum indicating whether the local or remote side offered a given HTLC.
293 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
296 pending_htlcs_value_msat: u64,
297 on_counterparty_tx_dust_exposure_msat: u64,
298 on_holder_tx_dust_exposure_msat: u64,
301 /// Used when calculating whether we or the remote can afford an additional HTLC.
302 struct HTLCCandidate {
304 origin: HTLCInitiator,
308 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
316 /// Information needed for constructing an invoice route hint for this channel.
317 #[derive(Clone, Debug, PartialEq)]
318 pub struct CounterpartyForwardingInfo {
319 /// Base routing fee in millisatoshis.
320 pub fee_base_msat: u32,
321 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
322 pub fee_proportional_millionths: u32,
323 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
324 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
325 /// `cltv_expiry_delta` for more details.
326 pub cltv_expiry_delta: u16,
329 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
331 enum UpdateFulfillFetch {
333 monitor_update: ChannelMonitorUpdate,
334 htlc_value_msat: u64,
335 msg: Option<msgs::UpdateFulfillHTLC>,
340 /// The return type of get_update_fulfill_htlc_and_commit.
341 pub enum UpdateFulfillCommitFetch {
342 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
343 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
344 /// previously placed in the holding cell (and has since been removed).
346 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
347 monitor_update: ChannelMonitorUpdate,
348 /// The value of the HTLC which was claimed, in msat.
349 htlc_value_msat: u64,
350 /// The update_fulfill message and commitment_signed message (if the claim was not placed
351 /// in the holding cell).
352 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
354 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
355 /// or has been forgotten (presumably previously claimed).
359 /// If the majority of the channels funds are to the fundee and the initiator holds only just
360 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
361 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
362 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
363 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
364 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
365 /// by this multiple without hitting this case, before sending.
366 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
367 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
368 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
369 /// leave the channel less usable as we hold a bigger reserve.
371 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
373 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
375 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
376 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
377 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
380 // Holder designates channel data owned for the benefice of the user client.
381 // Counterparty designates channel data owned by the another channel participant entity.
382 pub(super) struct Channel<Signer: Sign> {
383 #[cfg(any(test, feature = "_test_utils"))]
384 pub(crate) config: ChannelConfig,
385 #[cfg(not(any(test, feature = "_test_utils")))]
386 config: ChannelConfig,
390 channel_id: [u8; 32],
392 secp_ctx: Secp256k1<secp256k1::All>,
393 channel_value_satoshis: u64,
395 latest_monitor_update_id: u64,
397 holder_signer: Signer,
398 shutdown_scriptpubkey: Option<ShutdownScript>,
399 destination_script: Script,
401 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
402 // generation start at 0 and count up...this simplifies some parts of implementation at the
403 // cost of others, but should really just be changed.
405 cur_holder_commitment_transaction_number: u64,
406 cur_counterparty_commitment_transaction_number: u64,
407 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
408 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
409 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
410 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
412 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
413 /// need to ensure we resend them in the order we originally generated them. Note that because
414 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
415 /// sufficient to simply set this to the opposite of any message we are generating as we
416 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
417 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
419 resend_order: RAACommitmentOrder,
421 monitor_pending_funding_locked: bool,
422 monitor_pending_revoke_and_ack: bool,
423 monitor_pending_commitment_signed: bool,
424 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
425 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
427 // pending_update_fee is filled when sending and receiving update_fee
428 // For outbound channel, feerate_per_kw is updated with the value from
429 // pending_update_fee when revoke_and_ack is received
431 // For inbound channel, feerate_per_kw is updated when it receives
432 // commitment_signed and revoke_and_ack is generated
433 // The pending value is kept when another pair of update_fee and commitment_signed
434 // is received during AwaitingRemoteRevoke and relieved when the expected
435 // revoke_and_ack is received and new commitment_signed is generated to be
436 // sent to the funder. Otherwise, the pending value is removed when receiving
437 // commitment_signed.
438 pending_update_fee: Option<(u32, FeeUpdateState)>,
439 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
440 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
441 // is received. holding_cell_update_fee is updated when there are additional
442 // update_fee() during ChannelState::AwaitingRemoteRevoke.
443 holding_cell_update_fee: Option<u32>,
444 next_holder_htlc_id: u64,
445 next_counterparty_htlc_id: u64,
446 update_time_counter: u32,
449 #[cfg(debug_assertions)]
450 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
451 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
452 #[cfg(debug_assertions)]
453 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
454 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
456 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
458 /// The hash of the block in which the funding transaction was included.
459 funding_tx_confirmed_in: Option<BlockHash>,
460 funding_tx_confirmation_height: u32,
461 short_channel_id: Option<u64>,
463 counterparty_dust_limit_satoshis: u64,
465 pub(super) holder_dust_limit_satoshis: u64,
467 holder_dust_limit_satoshis: u64,
469 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
471 counterparty_max_htlc_value_in_flight_msat: u64,
472 //get_holder_max_htlc_value_in_flight_msat(): u64,
473 /// minimum channel reserve for self to maintain - set by them.
474 counterparty_selected_channel_reserve_satoshis: Option<u64>,
475 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
476 counterparty_htlc_minimum_msat: u64,
477 holder_htlc_minimum_msat: u64,
479 pub counterparty_max_accepted_htlcs: u16,
481 counterparty_max_accepted_htlcs: u16,
482 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
483 minimum_depth: Option<u32>,
485 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
487 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
488 funding_transaction: Option<Transaction>,
490 counterparty_cur_commitment_point: Option<PublicKey>,
491 counterparty_prev_commitment_point: Option<PublicKey>,
492 counterparty_node_id: PublicKey,
494 counterparty_shutdown_scriptpubkey: Option<Script>,
496 commitment_secrets: CounterpartyCommitmentSecrets,
498 channel_update_status: ChannelUpdateStatus,
500 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
501 /// This can be used to rebroadcast the channel_announcement message later.
502 announcement_sigs: Option<(Signature, Signature)>,
504 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
505 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
506 // be, by comparing the cached values to the fee of the tranaction generated by
507 // `build_commitment_transaction`.
508 #[cfg(any(test, feature = "fuzztarget"))]
509 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
510 #[cfg(any(test, feature = "fuzztarget"))]
511 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
513 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
514 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
515 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
516 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
517 /// message until we receive a channel_reestablish.
519 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
520 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
522 #[cfg(any(test, feature = "fuzztarget"))]
523 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
524 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
525 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
526 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
527 // is fine, but as a sanity check in our failure to generate the second claim, we check here
528 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
529 historical_inbound_htlc_fulfills: HashSet<u64>,
532 #[cfg(any(test, feature = "fuzztarget"))]
533 struct CommitmentTxInfoCached {
535 total_pending_htlcs: usize,
536 next_holder_htlc_id: u64,
537 next_counterparty_htlc_id: u64,
541 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
544 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
546 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
548 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
550 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
552 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
554 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
556 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
557 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
558 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
559 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
560 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
561 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
562 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
563 /// upper bound to avoid negotiation conflicts with other implementations.
564 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
566 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
567 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
568 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
569 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
570 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
572 /// Used to return a simple Error back to ChannelManager. Will get converted to a
573 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
574 /// channel_id in ChannelManager.
575 pub(super) enum ChannelError {
579 CloseDelayBroadcast(String),
582 impl fmt::Debug for ChannelError {
583 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
585 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
586 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
587 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
588 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
593 macro_rules! secp_check {
594 ($res: expr, $err: expr) => {
597 Err(_) => return Err(ChannelError::Close($err)),
602 impl<Signer: Sign> Channel<Signer> {
603 // Convert constants + channel value to limits:
604 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
605 channel_value_satoshis * 1000 / 10 //TODO
608 /// Returns a minimum channel reserve value the remote needs to maintain,
611 /// Guaranteed to return a value no larger than channel_value_satoshis
612 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
613 let (q, _) = channel_value_satoshis.overflowing_div(100);
614 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
618 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
619 where K::Target: KeysInterface<Signer = Signer>,
620 F::Target: FeeEstimator,
622 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
623 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
624 let pubkeys = holder_signer.pubkeys().clone();
626 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
627 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
629 let channel_value_msat = channel_value_satoshis * 1000;
630 if push_msat > channel_value_msat {
631 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
633 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
634 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
636 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
637 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
638 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
641 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
643 let mut secp_ctx = Secp256k1::new();
644 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
646 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
647 Some(keys_provider.get_shutdown_scriptpubkey())
650 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
651 if !shutdown_scriptpubkey.is_compatible(&their_features) {
652 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
658 config: config.channel_options.clone(),
660 channel_id: keys_provider.get_secure_random_bytes(),
661 channel_state: ChannelState::OurInitSent as u32,
663 channel_value_satoshis,
665 latest_monitor_update_id: 0,
668 shutdown_scriptpubkey,
669 destination_script: keys_provider.get_destination_script(),
671 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
672 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
673 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
675 pending_inbound_htlcs: Vec::new(),
676 pending_outbound_htlcs: Vec::new(),
677 holding_cell_htlc_updates: Vec::new(),
678 pending_update_fee: None,
679 holding_cell_update_fee: None,
680 next_holder_htlc_id: 0,
681 next_counterparty_htlc_id: 0,
682 update_time_counter: 1,
684 resend_order: RAACommitmentOrder::CommitmentFirst,
686 monitor_pending_funding_locked: false,
687 monitor_pending_revoke_and_ack: false,
688 monitor_pending_commitment_signed: false,
689 monitor_pending_forwards: Vec::new(),
690 monitor_pending_failures: Vec::new(),
692 #[cfg(debug_assertions)]
693 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
694 #[cfg(debug_assertions)]
695 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
697 last_sent_closing_fee: None,
699 funding_tx_confirmed_in: None,
700 funding_tx_confirmation_height: 0,
701 short_channel_id: None,
703 feerate_per_kw: feerate,
704 counterparty_dust_limit_satoshis: 0,
705 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
706 counterparty_max_htlc_value_in_flight_msat: 0,
707 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
708 counterparty_htlc_minimum_msat: 0,
709 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
710 counterparty_max_accepted_htlcs: 0,
711 minimum_depth: None, // Filled in in accept_channel
713 counterparty_forwarding_info: None,
715 channel_transaction_parameters: ChannelTransactionParameters {
716 holder_pubkeys: pubkeys,
717 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
718 is_outbound_from_holder: true,
719 counterparty_parameters: None,
720 funding_outpoint: None
722 funding_transaction: None,
724 counterparty_cur_commitment_point: None,
725 counterparty_prev_commitment_point: None,
726 counterparty_node_id,
728 counterparty_shutdown_scriptpubkey: None,
730 commitment_secrets: CounterpartyCommitmentSecrets::new(),
732 channel_update_status: ChannelUpdateStatus::Enabled,
734 announcement_sigs: None,
736 #[cfg(any(test, feature = "fuzztarget"))]
737 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
738 #[cfg(any(test, feature = "fuzztarget"))]
739 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
741 workaround_lnd_bug_4006: None,
743 #[cfg(any(test, feature = "fuzztarget"))]
744 historical_inbound_htlc_fulfills: HashSet::new(),
748 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
749 where F::Target: FeeEstimator
751 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
752 if feerate_per_kw < lower_limit {
753 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
755 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
756 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
757 // We generally don't care too much if they set the feerate to something very high, but it
758 // could result in the channel being useless due to everything being dust.
759 let upper_limit = cmp::max(250 * 25,
760 fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
761 if feerate_per_kw as u64 > upper_limit {
762 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
767 /// Creates a new channel from a remote sides' request for one.
768 /// Assumes chain_hash has already been checked and corresponds with what we expect!
769 pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, ChannelError>
770 where K::Target: KeysInterface<Signer = Signer>,
771 F::Target: FeeEstimator
773 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
774 let pubkeys = holder_signer.pubkeys().clone();
775 let counterparty_pubkeys = ChannelPublicKeys {
776 funding_pubkey: msg.funding_pubkey,
777 revocation_basepoint: msg.revocation_basepoint,
778 payment_point: msg.payment_point,
779 delayed_payment_basepoint: msg.delayed_payment_basepoint,
780 htlc_basepoint: msg.htlc_basepoint
782 let mut local_config = (*config).channel_options.clone();
784 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
785 return Err(ChannelError::Close(format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks. It must be greater than {}", config.own_channel_config.our_to_self_delay, BREAKDOWN_TIMEOUT)));
788 // Check sanity of message fields:
789 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
790 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
792 if msg.channel_reserve_satoshis > msg.funding_satoshis {
793 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
795 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
796 if msg.push_msat > funding_value {
797 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
799 if msg.dust_limit_satoshis > msg.funding_satoshis {
800 return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than funding_satoshis {}. Peer never wants payout outputs?", msg.dust_limit_satoshis, msg.funding_satoshis)));
802 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
803 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
805 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
806 if msg.htlc_minimum_msat >= full_channel_value_msat {
807 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
809 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
811 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
812 if msg.to_self_delay > max_counterparty_selected_contest_delay {
813 return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_counterparty_selected_contest_delay, msg.to_self_delay)));
815 if msg.max_accepted_htlcs < 1 {
816 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
818 if msg.max_accepted_htlcs > MAX_HTLCS {
819 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
822 // Now check against optional parameters as set by config...
823 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
824 return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", msg.funding_satoshis, config.peer_channel_config_limits.min_funding_satoshis)));
826 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
827 return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, config.peer_channel_config_limits.max_htlc_minimum_msat)));
829 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
830 return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
832 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
833 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
835 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
836 return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
838 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
839 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
841 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
842 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
845 // Convert things into internal flags and prep our state:
847 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
848 if config.peer_channel_config_limits.force_announced_channel_preference {
849 if local_config.announced_channel != announce {
850 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
853 // we either accept their preference or the preferences match
854 local_config.announced_channel = announce;
856 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
858 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
859 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
860 return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
862 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
863 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
865 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
866 return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", msg.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
869 // check if the funder's amount for the initial commitment tx is sufficient
870 // for full fee payment
871 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
872 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
873 if funders_amount_msat < lower_limit {
874 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
877 let to_local_msat = msg.push_msat;
878 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
879 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
880 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
883 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
884 match &msg.shutdown_scriptpubkey {
885 &OptionalField::Present(ref script) => {
886 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
887 if script.len() == 0 {
890 match ShutdownScript::try_from((script.clone(), their_features)) {
891 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
892 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
896 // 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
897 &OptionalField::Absent => {
898 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
903 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
904 Some(keys_provider.get_shutdown_scriptpubkey())
907 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
908 if !shutdown_scriptpubkey.is_compatible(&their_features) {
909 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
913 let mut secp_ctx = Secp256k1::new();
914 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
918 config: local_config,
920 channel_id: msg.temporary_channel_id,
921 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
924 latest_monitor_update_id: 0,
927 shutdown_scriptpubkey,
928 destination_script: keys_provider.get_destination_script(),
930 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
931 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
932 value_to_self_msat: msg.push_msat,
934 pending_inbound_htlcs: Vec::new(),
935 pending_outbound_htlcs: Vec::new(),
936 holding_cell_htlc_updates: Vec::new(),
937 pending_update_fee: None,
938 holding_cell_update_fee: None,
939 next_holder_htlc_id: 0,
940 next_counterparty_htlc_id: 0,
941 update_time_counter: 1,
943 resend_order: RAACommitmentOrder::CommitmentFirst,
945 monitor_pending_funding_locked: false,
946 monitor_pending_revoke_and_ack: false,
947 monitor_pending_commitment_signed: false,
948 monitor_pending_forwards: Vec::new(),
949 monitor_pending_failures: Vec::new(),
951 #[cfg(debug_assertions)]
952 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
953 #[cfg(debug_assertions)]
954 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
956 last_sent_closing_fee: None,
958 funding_tx_confirmed_in: None,
959 funding_tx_confirmation_height: 0,
960 short_channel_id: None,
962 feerate_per_kw: msg.feerate_per_kw,
963 channel_value_satoshis: msg.funding_satoshis,
964 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
965 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
966 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
967 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
968 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
969 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
970 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
971 minimum_depth: Some(config.own_channel_config.minimum_depth),
973 counterparty_forwarding_info: None,
975 channel_transaction_parameters: ChannelTransactionParameters {
976 holder_pubkeys: pubkeys,
977 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
978 is_outbound_from_holder: false,
979 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
980 selected_contest_delay: msg.to_self_delay,
981 pubkeys: counterparty_pubkeys,
983 funding_outpoint: None
985 funding_transaction: None,
987 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
988 counterparty_prev_commitment_point: None,
989 counterparty_node_id,
991 counterparty_shutdown_scriptpubkey,
993 commitment_secrets: CounterpartyCommitmentSecrets::new(),
995 channel_update_status: ChannelUpdateStatus::Enabled,
997 announcement_sigs: None,
999 #[cfg(any(test, feature = "fuzztarget"))]
1000 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1001 #[cfg(any(test, feature = "fuzztarget"))]
1002 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1004 workaround_lnd_bug_4006: None,
1006 #[cfg(any(test, feature = "fuzztarget"))]
1007 historical_inbound_htlc_fulfills: HashSet::new(),
1013 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1014 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1015 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1016 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1017 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1019 /// @local is used only to convert relevant internal structures which refer to remote vs local
1020 /// to decide value of outputs and direction of HTLCs.
1021 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1022 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1023 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1024 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1025 /// which peer generated this transaction and "to whom" this transaction flows.
1026 /// Returns (the transaction info, the number of HTLC outputs which were present in the
1027 /// transaction, the list of HTLCs which were not ignored when building the transaction).
1028 /// Note that below-dust HTLCs are included in the fourth return value, but not the third, and
1029 /// sources are provided only for outbound HTLCs in the fourth return value.
1031 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> (CommitmentTransaction, u32, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
1032 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1033 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1034 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1036 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1037 let mut remote_htlc_total_msat = 0;
1038 let mut local_htlc_total_msat = 0;
1039 let mut value_to_self_msat_offset = 0;
1041 let mut feerate_per_kw = self.feerate_per_kw;
1042 if let Some((feerate, update_state)) = self.pending_update_fee {
1043 if match update_state {
1044 // Note that these match the inclusion criteria when scanning
1045 // pending_inbound_htlcs below.
1046 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1047 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1048 FeeUpdateState::Outbound => { assert!(self.is_outbound()); generated_by_local },
1050 feerate_per_kw = feerate;
1054 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1055 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1056 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1057 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1059 macro_rules! get_htlc_in_commitment {
1060 ($htlc: expr, $offered: expr) => {
1061 HTLCOutputInCommitment {
1063 amount_msat: $htlc.amount_msat,
1064 cltv_expiry: $htlc.cltv_expiry,
1065 payment_hash: $htlc.payment_hash,
1066 transaction_output_index: None
1071 macro_rules! add_htlc_output {
1072 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1073 if $outbound == local { // "offered HTLC output"
1074 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1075 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1076 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1077 included_non_dust_htlcs.push((htlc_in_tx, $source));
1079 log_trace!(logger, " ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1080 included_dust_htlcs.push((htlc_in_tx, $source));
1083 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1084 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1085 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1086 included_non_dust_htlcs.push((htlc_in_tx, $source));
1088 log_trace!(logger, " ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
1089 included_dust_htlcs.push((htlc_in_tx, $source));
1095 for ref htlc in self.pending_inbound_htlcs.iter() {
1096 let (include, state_name) = match htlc.state {
1097 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1098 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1099 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1100 InboundHTLCState::Committed => (true, "Committed"),
1101 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1105 add_htlc_output!(htlc, false, None, state_name);
1106 remote_htlc_total_msat += htlc.amount_msat;
1108 log_trace!(logger, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
1110 &InboundHTLCState::LocalRemoved(ref reason) => {
1111 if generated_by_local {
1112 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1113 value_to_self_msat_offset += htlc.amount_msat as i64;
1122 for ref htlc in self.pending_outbound_htlcs.iter() {
1123 let (include, state_name) = match htlc.state {
1124 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1125 OutboundHTLCState::Committed => (true, "Committed"),
1126 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1127 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1128 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1132 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1133 local_htlc_total_msat += htlc.amount_msat;
1135 log_trace!(logger, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
1137 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1138 value_to_self_msat_offset -= htlc.amount_msat as i64;
1140 OutboundHTLCState::RemoteRemoved(None) => {
1141 if !generated_by_local {
1142 value_to_self_msat_offset -= htlc.amount_msat as i64;
1150 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1151 assert!(value_to_self_msat >= 0);
1152 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1153 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1154 // "violate" their reserve value by couting those against it. Thus, we have to convert
1155 // everything to i64 before subtracting as otherwise we can overflow.
1156 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;
1157 assert!(value_to_remote_msat >= 0);
1159 #[cfg(debug_assertions)]
1161 // Make sure that the to_self/to_remote is always either past the appropriate
1162 // channel_reserve *or* it is making progress towards it.
1163 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1164 self.holder_max_commitment_tx_output.lock().unwrap()
1166 self.counterparty_max_commitment_tx_output.lock().unwrap()
1168 debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis.unwrap() as i64);
1169 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1170 debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
1171 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1174 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (included_non_dust_htlcs.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1175 let (value_to_self, value_to_remote) = if self.is_outbound() {
1176 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1178 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1181 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1182 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1184 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1185 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1190 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1191 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1196 let num_nondust_htlcs = included_non_dust_htlcs.len();
1198 let channel_parameters =
1199 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1200 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1201 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1206 &mut included_non_dust_htlcs,
1209 let mut htlcs_included = included_non_dust_htlcs;
1210 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1211 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1212 htlcs_included.append(&mut included_dust_htlcs);
1214 (tx, feerate_per_kw, num_nondust_htlcs, htlcs_included)
1218 fn get_closing_scriptpubkey(&self) -> Script {
1219 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1220 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1221 // outside of those situations will fail.
1222 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1226 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1231 1 + // script length (0)
1235 )*4 + // * 4 for non-witness parts
1236 2 + // witness marker and flag
1237 1 + // witness element count
1238 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1239 self.get_funding_redeemscript().len() as u64 + // funding witness script
1240 2*(1 + 71); // two signatures + sighash type flags
1241 if let Some(spk) = a_scriptpubkey {
1242 ret += ((8+1) + // output values and script length
1243 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1245 if let Some(spk) = b_scriptpubkey {
1246 ret += ((8+1) + // output values and script length
1247 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1253 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1255 let mut ins: Vec<TxIn> = Vec::new();
1257 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1258 script_sig: Script::new(),
1259 sequence: 0xffffffff,
1260 witness: Vec::new(),
1265 assert!(self.pending_inbound_htlcs.is_empty());
1266 assert!(self.pending_outbound_htlcs.is_empty());
1267 assert!(self.pending_update_fee.is_none());
1268 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1270 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1271 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1272 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1274 if value_to_self < 0 {
1275 assert!(self.is_outbound());
1276 total_fee_satoshis += (-value_to_self) as u64;
1277 } else if value_to_remote < 0 {
1278 assert!(!self.is_outbound());
1279 total_fee_satoshis += (-value_to_remote) as u64;
1282 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1283 txouts.push((TxOut {
1284 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1285 value: value_to_remote as u64
1289 assert!(self.shutdown_scriptpubkey.is_some());
1290 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1291 txouts.push((TxOut {
1292 script_pubkey: self.get_closing_scriptpubkey(),
1293 value: value_to_self as u64
1297 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1299 let mut outputs: Vec<TxOut> = Vec::new();
1300 for out in txouts.drain(..) {
1301 outputs.push(out.0);
1309 }, total_fee_satoshis)
1312 fn funding_outpoint(&self) -> OutPoint {
1313 self.channel_transaction_parameters.funding_outpoint.unwrap()
1317 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1318 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1319 /// our counterparty!)
1320 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1321 /// TODO Some magic rust shit to compile-time check this?
1322 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1323 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1324 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1325 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1326 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1328 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys".to_owned()))
1332 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1333 /// will sign and send to our counterparty.
1334 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1335 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1336 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1337 //may see payments to it!
1338 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1339 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1340 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1342 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &self.counterparty_cur_commitment_point.unwrap(), &counterparty_pubkeys.delayed_payment_basepoint, &counterparty_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint), "Remote tx keys generation got bogus keys".to_owned()))
1345 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1346 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1347 /// Panics if called before accept_channel/new_from_req
1348 pub fn get_funding_redeemscript(&self) -> Script {
1349 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1352 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1353 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1354 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1355 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1357 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1358 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1360 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1362 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1364 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1365 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1366 // these, but for now we just have to treat them as normal.
1368 let mut pending_idx = core::usize::MAX;
1369 let mut htlc_value_msat = 0;
1370 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1371 if htlc.htlc_id == htlc_id_arg {
1372 assert_eq!(htlc.payment_hash, payment_hash_calc);
1374 InboundHTLCState::Committed => {},
1375 InboundHTLCState::LocalRemoved(ref reason) => {
1376 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1378 log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1379 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1381 return UpdateFulfillFetch::DuplicateClaim {};
1384 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1385 // Don't return in release mode here so that we can update channel_monitor
1389 htlc_value_msat = htlc.amount_msat;
1393 if pending_idx == core::usize::MAX {
1394 #[cfg(any(test, feature = "fuzztarget"))]
1395 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1396 // this is simply a duplicate claim, not previously failed and we lost funds.
1397 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1398 return UpdateFulfillFetch::DuplicateClaim {};
1401 // Now update local state:
1403 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1404 // can claim it even if the channel hits the chain before we see their next commitment.
1405 self.latest_monitor_update_id += 1;
1406 let monitor_update = ChannelMonitorUpdate {
1407 update_id: self.latest_monitor_update_id,
1408 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1409 payment_preimage: payment_preimage_arg.clone(),
1413 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1414 for pending_update in self.holding_cell_htlc_updates.iter() {
1415 match pending_update {
1416 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1417 if htlc_id_arg == htlc_id {
1418 // Make sure we don't leave latest_monitor_update_id incremented here:
1419 self.latest_monitor_update_id -= 1;
1420 #[cfg(any(test, feature = "fuzztarget"))]
1421 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1422 return UpdateFulfillFetch::DuplicateClaim {};
1425 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1426 if htlc_id_arg == htlc_id {
1427 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1428 // TODO: We may actually be able to switch to a fulfill here, though its
1429 // rare enough it may not be worth the complexity burden.
1430 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1431 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1437 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1438 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1439 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1441 #[cfg(any(test, feature = "fuzztarget"))]
1442 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1443 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1445 #[cfg(any(test, feature = "fuzztarget"))]
1446 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1449 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1450 if let InboundHTLCState::Committed = htlc.state {
1452 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1453 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1455 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1456 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1459 UpdateFulfillFetch::NewClaim {
1462 msg: Some(msgs::UpdateFulfillHTLC {
1463 channel_id: self.channel_id(),
1464 htlc_id: htlc_id_arg,
1465 payment_preimage: payment_preimage_arg,
1470 pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<UpdateFulfillCommitFetch, (ChannelError, ChannelMonitorUpdate)> where L::Target: Logger {
1471 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1472 UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1473 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1474 Err(e) => return Err((e, monitor_update)),
1477 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1478 // strictly increasing by one, so decrement it here.
1479 self.latest_monitor_update_id = monitor_update.update_id;
1480 monitor_update.updates.append(&mut additional_update.updates);
1481 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1483 UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1484 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1485 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1489 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1490 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1491 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1492 /// before we fail backwards.
1493 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1494 /// Ok(_) if debug assertions are turned on or preconditions are met.
1495 pub fn get_update_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> where L::Target: Logger {
1496 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1497 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1499 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1501 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1502 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1503 // these, but for now we just have to treat them as normal.
1505 let mut pending_idx = core::usize::MAX;
1506 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1507 if htlc.htlc_id == htlc_id_arg {
1509 InboundHTLCState::Committed => {},
1510 InboundHTLCState::LocalRemoved(ref reason) => {
1511 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1513 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1518 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1519 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1525 if pending_idx == core::usize::MAX {
1526 #[cfg(any(test, feature = "fuzztarget"))]
1527 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1528 // is simply a duplicate fail, not previously failed and we failed-back too early.
1529 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1533 // Now update local state:
1534 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1535 for pending_update in self.holding_cell_htlc_updates.iter() {
1536 match pending_update {
1537 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1538 if htlc_id_arg == htlc_id {
1539 #[cfg(any(test, feature = "fuzztarget"))]
1540 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1544 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1545 if htlc_id_arg == htlc_id {
1546 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1547 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1553 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1554 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1555 htlc_id: htlc_id_arg,
1561 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1563 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1564 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1567 Ok(Some(msgs::UpdateFailHTLC {
1568 channel_id: self.channel_id(),
1569 htlc_id: htlc_id_arg,
1574 // Message handlers:
1576 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: &InitFeatures) -> Result<(), ChannelError> {
1577 // Check sanity of message fields:
1578 if !self.is_outbound() {
1579 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1581 if self.channel_state != ChannelState::OurInitSent as u32 {
1582 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1584 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1585 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1587 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1588 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1590 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1591 return Err(ChannelError::Close(format!("Peer never wants payout outputs? channel_reserve_satoshis was ({}). dust_limit is ({})", msg.channel_reserve_satoshis, self.holder_dust_limit_satoshis)));
1593 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1594 if msg.dust_limit_satoshis > remote_reserve {
1595 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1597 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1598 if msg.htlc_minimum_msat >= full_channel_value_msat {
1599 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1601 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1602 if msg.to_self_delay > max_delay_acceptable {
1603 return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.to_self_delay)));
1605 if msg.max_accepted_htlcs < 1 {
1606 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1608 if msg.max_accepted_htlcs > MAX_HTLCS {
1609 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1612 // Now check against optional parameters as set by config...
1613 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1614 return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, config.peer_channel_config_limits.max_htlc_minimum_msat)));
1616 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1617 return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
1619 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1620 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
1622 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1623 return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
1625 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1626 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1628 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1629 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1631 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1632 return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", config.peer_channel_config_limits.max_minimum_depth, msg.minimum_depth)));
1634 if msg.minimum_depth == 0 {
1635 // Note that if this changes we should update the serialization minimum version to
1636 // indicate to older clients that they don't understand some features of the current
1638 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1641 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1642 match &msg.shutdown_scriptpubkey {
1643 &OptionalField::Present(ref script) => {
1644 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1645 if script.len() == 0 {
1648 match ShutdownScript::try_from((script.clone(), their_features)) {
1649 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
1650 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
1654 // 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
1655 &OptionalField::Absent => {
1656 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
1661 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1662 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1663 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1664 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1665 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1666 self.minimum_depth = Some(msg.minimum_depth);
1668 let counterparty_pubkeys = ChannelPublicKeys {
1669 funding_pubkey: msg.funding_pubkey,
1670 revocation_basepoint: msg.revocation_basepoint,
1671 payment_point: msg.payment_point,
1672 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1673 htlc_basepoint: msg.htlc_basepoint
1676 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1677 selected_contest_delay: msg.to_self_delay,
1678 pubkeys: counterparty_pubkeys,
1681 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1682 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1684 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1689 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1690 let funding_script = self.get_funding_redeemscript();
1692 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1693 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).0;
1695 let trusted_tx = initial_commitment_tx.trust();
1696 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1697 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1698 // They sign the holder commitment transaction...
1699 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1700 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1701 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1702 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1703 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1706 let counterparty_keys = self.build_remote_transaction_keys()?;
1707 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1709 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1710 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1711 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1712 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1714 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1715 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1717 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1718 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1721 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1722 &self.get_counterparty_pubkeys().funding_pubkey
1725 pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, best_block: BestBlock, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError> where L::Target: Logger {
1726 if self.is_outbound() {
1727 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1729 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1730 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1731 // remember the channel, so it's safe to just send an error_message here and drop the
1733 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1735 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1736 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1737 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1738 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1741 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1742 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1743 // This is an externally observable change before we finish all our checks. In particular
1744 // funding_created_signature may fail.
1745 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1747 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1749 Err(ChannelError::Close(e)) => {
1750 self.channel_transaction_parameters.funding_outpoint = None;
1751 return Err(ChannelError::Close(e));
1754 // The only error we know how to handle is ChannelError::Close, so we fall over here
1755 // to make sure we don't continue with an inconsistent state.
1756 panic!("unexpected error type from funding_created_signature {:?}", e);
1760 let holder_commitment_tx = HolderCommitmentTransaction::new(
1761 initial_commitment_tx,
1764 &self.get_holder_pubkeys().funding_pubkey,
1765 self.counterparty_funding_pubkey()
1768 // Now that we're past error-generating stuff, update our local state:
1770 let funding_redeemscript = self.get_funding_redeemscript();
1771 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1772 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1773 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1774 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1775 shutdown_script, self.get_holder_selected_contest_delay(),
1776 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1777 &self.channel_transaction_parameters,
1778 funding_redeemscript.clone(), self.channel_value_satoshis,
1780 holder_commitment_tx, best_block);
1782 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_commitment_txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1784 self.channel_state = ChannelState::FundingSent as u32;
1785 self.channel_id = funding_txo.to_channel_id();
1786 self.cur_counterparty_commitment_transaction_number -= 1;
1787 self.cur_holder_commitment_transaction_number -= 1;
1789 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1791 Ok((msgs::FundingSigned {
1792 channel_id: self.channel_id,
1794 }, channel_monitor))
1797 /// Handles a funding_signed message from the remote end.
1798 /// If this call is successful, broadcast the funding transaction (and not before!)
1799 pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, best_block: BestBlock, logger: &L) -> Result<(ChannelMonitor<Signer>, Transaction), ChannelError> where L::Target: Logger {
1800 if !self.is_outbound() {
1801 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1803 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1804 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1806 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1807 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1808 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1809 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1812 let funding_script = self.get_funding_redeemscript();
1814 let counterparty_keys = self.build_remote_transaction_keys()?;
1815 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1816 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1817 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1819 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1820 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1822 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1823 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).0;
1825 let trusted_tx = initial_commitment_tx.trust();
1826 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1827 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1828 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1829 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1830 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1834 let holder_commitment_tx = HolderCommitmentTransaction::new(
1835 initial_commitment_tx,
1838 &self.get_holder_pubkeys().funding_pubkey,
1839 self.counterparty_funding_pubkey()
1843 let funding_redeemscript = self.get_funding_redeemscript();
1844 let funding_txo = self.get_funding_txo().unwrap();
1845 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1846 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1847 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1848 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1849 shutdown_script, self.get_holder_selected_contest_delay(),
1850 &self.destination_script, (funding_txo, funding_txo_script),
1851 &self.channel_transaction_parameters,
1852 funding_redeemscript.clone(), self.channel_value_satoshis,
1854 holder_commitment_tx, best_block);
1856 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_bitcoin_tx.txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1858 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1859 self.channel_state = ChannelState::FundingSent as u32;
1860 self.cur_holder_commitment_transaction_number -= 1;
1861 self.cur_counterparty_commitment_transaction_number -= 1;
1863 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1865 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1868 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1869 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1870 self.workaround_lnd_bug_4006 = Some(msg.clone());
1871 return Err(ChannelError::Ignore("Peer sent funding_locked when we needed a channel_reestablish. The peer is likely lnd, see https://github.com/lightningnetwork/lnd/issues/4006".to_owned()));
1874 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1876 if non_shutdown_state == ChannelState::FundingSent as u32 {
1877 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1878 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1879 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1880 self.update_time_counter += 1;
1881 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1882 // Note that funding_signed/funding_created will have decremented both by 1!
1883 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1884 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1885 // If we reconnected before sending our funding locked they may still resend theirs:
1886 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1887 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1888 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1889 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1891 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1894 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1897 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1898 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1900 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1905 /// Returns a HTLCStats about inbound pending htlcs
1906 fn get_inbound_pending_htlc_stats(&self) -> HTLCStats {
1907 let mut stats = HTLCStats {
1908 pending_htlcs: self.pending_inbound_htlcs.len() as u32,
1909 pending_htlcs_value_msat: 0,
1910 on_counterparty_tx_dust_exposure_msat: 0,
1911 on_holder_tx_dust_exposure_msat: 0,
1914 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1915 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1916 for ref htlc in self.pending_inbound_htlcs.iter() {
1917 stats.pending_htlcs_value_msat += htlc.amount_msat;
1918 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
1919 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1921 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
1922 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1928 /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
1929 fn get_outbound_pending_htlc_stats(&self) -> HTLCStats {
1930 let mut stats = HTLCStats {
1931 pending_htlcs: self.pending_outbound_htlcs.len() as u32,
1932 pending_htlcs_value_msat: 0,
1933 on_counterparty_tx_dust_exposure_msat: 0,
1934 on_holder_tx_dust_exposure_msat: 0,
1937 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1938 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1939 for ref htlc in self.pending_outbound_htlcs.iter() {
1940 stats.pending_htlcs_value_msat += htlc.amount_msat;
1941 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
1942 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1944 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
1945 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1949 for update in self.holding_cell_htlc_updates.iter() {
1950 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1951 stats.pending_htlcs += 1;
1952 stats.pending_htlcs_value_msat += amount_msat;
1953 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
1954 stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
1956 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
1957 stats.on_holder_tx_dust_exposure_msat += amount_msat;
1964 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1965 /// Doesn't bother handling the
1966 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1967 /// corner case properly.
1968 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1969 // Note that we have to handle overflow due to the above case.
1971 cmp::max(self.channel_value_satoshis as i64 * 1000
1972 - self.value_to_self_msat as i64
1973 - self.get_inbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1974 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1976 cmp::max(self.value_to_self_msat as i64
1977 - self.get_outbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1978 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1983 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1984 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1985 self.counterparty_selected_channel_reserve_satoshis)
1988 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1989 // Note that num_htlcs should not include dust HTLCs.
1990 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1991 // Note that we need to divide before multiplying to round properly,
1992 // since the lowest denomination of bitcoin on-chain is the satoshi.
1993 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1996 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1997 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1998 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2000 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2001 assert!(self.is_outbound());
2003 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2004 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2006 let mut addl_htlcs = 0;
2007 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2009 HTLCInitiator::LocalOffered => {
2010 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2014 HTLCInitiator::RemoteOffered => {
2015 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2021 let mut included_htlcs = 0;
2022 for ref htlc in self.pending_inbound_htlcs.iter() {
2023 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2026 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2027 // transaction including this HTLC if it times out before they RAA.
2028 included_htlcs += 1;
2031 for ref htlc in self.pending_outbound_htlcs.iter() {
2032 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2036 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2037 OutboundHTLCState::Committed => included_htlcs += 1,
2038 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2039 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2040 // transaction won't be generated until they send us their next RAA, which will mean
2041 // dropping any HTLCs in this state.
2046 for htlc in self.holding_cell_htlc_updates.iter() {
2048 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2049 if amount_msat / 1000 < real_dust_limit_timeout_sat {
2054 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2055 // ack we're guaranteed to never include them in commitment txs anymore.
2059 let num_htlcs = included_htlcs + addl_htlcs;
2060 let res = self.commit_tx_fee_msat(num_htlcs);
2061 #[cfg(any(test, feature = "fuzztarget"))]
2064 if fee_spike_buffer_htlc.is_some() {
2065 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2067 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2068 + self.holding_cell_htlc_updates.len();
2069 let commitment_tx_info = CommitmentTxInfoCached {
2071 total_pending_htlcs,
2072 next_holder_htlc_id: match htlc.origin {
2073 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2074 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2076 next_counterparty_htlc_id: match htlc.origin {
2077 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2078 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2080 feerate: self.feerate_per_kw,
2082 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2087 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2088 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2089 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2091 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2092 assert!(!self.is_outbound());
2094 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2095 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2097 let mut addl_htlcs = 0;
2098 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2100 HTLCInitiator::LocalOffered => {
2101 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2105 HTLCInitiator::RemoteOffered => {
2106 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2112 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2113 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2114 // committed outbound HTLCs, see below.
2115 let mut included_htlcs = 0;
2116 for ref htlc in self.pending_inbound_htlcs.iter() {
2117 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2120 included_htlcs += 1;
2123 for ref htlc in self.pending_outbound_htlcs.iter() {
2124 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2127 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2128 // i.e. if they've responded to us with an RAA after announcement.
2130 OutboundHTLCState::Committed => included_htlcs += 1,
2131 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2132 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2137 let num_htlcs = included_htlcs + addl_htlcs;
2138 let res = self.commit_tx_fee_msat(num_htlcs);
2139 #[cfg(any(test, feature = "fuzztarget"))]
2142 if fee_spike_buffer_htlc.is_some() {
2143 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2145 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2146 let commitment_tx_info = CommitmentTxInfoCached {
2148 total_pending_htlcs,
2149 next_holder_htlc_id: match htlc.origin {
2150 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2151 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2153 next_counterparty_htlc_id: match htlc.origin {
2154 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2155 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2157 feerate: self.feerate_per_kw,
2159 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2164 pub fn update_add_htlc<F, L: Deref>(&mut self, msg: &msgs::UpdateAddHTLC, mut pending_forward_status: PendingHTLCStatus, create_pending_htlc_status: F, logger: &L) -> Result<(), ChannelError>
2165 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2166 // We can't accept HTLCs sent after we've sent a shutdown.
2167 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2168 if local_sent_shutdown {
2169 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
2171 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2172 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2173 if remote_sent_shutdown {
2174 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2176 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2177 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2179 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2180 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2182 if msg.amount_msat == 0 {
2183 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2185 if msg.amount_msat < self.holder_htlc_minimum_msat {
2186 return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.holder_htlc_minimum_msat, msg.amount_msat)));
2189 let inbound_stats = self.get_inbound_pending_htlc_stats();
2190 let outbound_stats = self.get_outbound_pending_htlc_stats();
2191 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2192 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2194 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2195 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2196 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2198 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2199 // the reserve_satoshis we told them to always have as direct payment so that they lose
2200 // something if we punish them for broadcasting an old state).
2201 // Note that we don't really care about having a small/no to_remote output in our local
2202 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2203 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2204 // present in the next commitment transaction we send them (at least for fulfilled ones,
2205 // failed ones won't modify value_to_self).
2206 // Note that we will send HTLCs which another instance of rust-lightning would think
2207 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2208 // Channel state once they will not be present in the next received commitment
2210 let mut removed_outbound_total_msat = 0;
2211 for ref htlc in self.pending_outbound_htlcs.iter() {
2212 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2213 removed_outbound_total_msat += htlc.amount_msat;
2214 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2215 removed_outbound_total_msat += htlc.amount_msat;
2219 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2220 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2221 let on_counterparty_tx_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + msg.amount_msat;
2222 if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2223 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2224 on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2225 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2229 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2230 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2231 let on_holder_tx_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + msg.amount_msat;
2232 if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2233 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2234 on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2235 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2239 let pending_value_to_self_msat =
2240 self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2241 let pending_remote_value_msat =
2242 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2243 if pending_remote_value_msat < msg.amount_msat {
2244 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2247 // Check that the remote can afford to pay for this HTLC on-chain at the current
2248 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2249 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2250 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2251 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2253 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2254 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2257 let chan_reserve_msat =
2258 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2259 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2260 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2263 if !self.is_outbound() {
2264 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2265 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2266 // receiver's side, only on the sender's.
2267 // Note that when we eventually remove support for fee updates and switch to anchor output
2268 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2269 // the extra htlc when calculating the next remote commitment transaction fee as we should
2270 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2271 // sensitive to fee spikes.
2272 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2273 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2274 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2275 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2276 // the HTLC, i.e. its status is already set to failing.
2277 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2278 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2281 // Check that they won't violate our local required channel reserve by adding this HTLC.
2282 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2283 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2284 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2285 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2288 if self.next_counterparty_htlc_id != msg.htlc_id {
2289 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2291 if msg.cltv_expiry >= 500000000 {
2292 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2295 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2296 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2297 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2301 // Now update local state:
2302 self.next_counterparty_htlc_id += 1;
2303 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2304 htlc_id: msg.htlc_id,
2305 amount_msat: msg.amount_msat,
2306 payment_hash: msg.payment_hash,
2307 cltv_expiry: msg.cltv_expiry,
2308 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2313 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2315 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2316 for htlc in self.pending_outbound_htlcs.iter_mut() {
2317 if htlc.htlc_id == htlc_id {
2318 match check_preimage {
2320 Some(payment_hash) =>
2321 if payment_hash != htlc.payment_hash {
2322 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2326 OutboundHTLCState::LocalAnnounced(_) =>
2327 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2328 OutboundHTLCState::Committed => {
2329 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2331 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2332 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2337 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2340 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2341 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2342 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2344 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2345 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2348 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2349 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2352 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2353 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2354 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2356 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2357 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2360 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2364 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2365 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2366 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2368 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2369 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2372 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2376 pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2377 where F::Target: FeeEstimator,
2380 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2381 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2383 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2384 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2386 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2387 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2390 let funding_script = self.get_funding_redeemscript();
2392 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2394 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid, feerate_per_kw) = {
2395 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2396 let commitment_txid = {
2397 let trusted_tx = commitment_tx.0.trust();
2398 let bitcoin_tx = trusted_tx.built_transaction();
2399 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2401 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2402 log_bytes!(msg.signature.serialize_compact()[..]),
2403 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2404 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2405 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2406 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2410 let htlcs_cloned: Vec<_> = commitment_tx.3.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2411 (commitment_tx.2, htlcs_cloned, commitment_tx.0, commitment_txid, commitment_tx.1)
2414 // If our counterparty updated the channel fee in this commitment transaction, check that
2415 // they can actually afford the new fee now.
2416 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2417 update_state == FeeUpdateState::RemoteAnnounced
2419 if update_fee { debug_assert!(!self.is_outbound()); }
2420 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2422 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2423 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2424 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2427 #[cfg(any(test, feature = "fuzztarget"))]
2429 if self.is_outbound() {
2430 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2431 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2432 if let Some(info) = projected_commit_tx_info {
2433 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2434 + self.holding_cell_htlc_updates.len();
2435 if info.total_pending_htlcs == total_pending_htlcs
2436 && info.next_holder_htlc_id == self.next_holder_htlc_id
2437 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2438 && info.feerate == self.feerate_per_kw {
2439 assert_eq!(total_fee, info.fee / 1000);
2445 if msg.htlc_signatures.len() != num_htlcs {
2446 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2449 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2450 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2451 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2452 if let Some(_) = htlc.transaction_output_index {
2453 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2454 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2455 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2457 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2458 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2459 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2460 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2461 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2462 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2463 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2465 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2467 htlcs_and_sigs.push((htlc, None, source));
2471 let holder_commitment_tx = HolderCommitmentTransaction::new(
2474 msg.htlc_signatures.clone(),
2475 &self.get_holder_pubkeys().funding_pubkey,
2476 self.counterparty_funding_pubkey()
2479 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2480 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2482 // Update state now that we've passed all the can-fail calls...
2483 let mut need_commitment = false;
2484 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2485 if *update_state == FeeUpdateState::RemoteAnnounced {
2486 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2487 need_commitment = true;
2491 self.latest_monitor_update_id += 1;
2492 let mut monitor_update = ChannelMonitorUpdate {
2493 update_id: self.latest_monitor_update_id,
2494 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2495 commitment_tx: holder_commitment_tx,
2496 htlc_outputs: htlcs_and_sigs
2500 for htlc in self.pending_inbound_htlcs.iter_mut() {
2501 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2502 Some(forward_info.clone())
2504 if let Some(forward_info) = new_forward {
2505 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2506 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2507 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2508 need_commitment = true;
2511 for htlc in self.pending_outbound_htlcs.iter_mut() {
2512 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2513 Some(fail_reason.take())
2515 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2516 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2517 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2518 need_commitment = true;
2522 self.cur_holder_commitment_transaction_number -= 1;
2523 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2524 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2525 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2527 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2528 // In case we initially failed monitor updating without requiring a response, we need
2529 // to make sure the RAA gets sent first.
2530 self.monitor_pending_revoke_and_ack = true;
2531 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2532 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2533 // the corresponding HTLC status updates so that get_last_commitment_update
2534 // includes the right HTLCs.
2535 self.monitor_pending_commitment_signed = true;
2536 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2537 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2538 // strictly increasing by one, so decrement it here.
2539 self.latest_monitor_update_id = monitor_update.update_id;
2540 monitor_update.updates.append(&mut additional_update.updates);
2542 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2543 log_bytes!(self.channel_id));
2544 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2545 // re-send the message on restoration)
2546 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2549 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2550 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2551 // we'll send one right away when we get the revoke_and_ack when we
2552 // free_holding_cell_htlcs().
2553 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2554 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2555 // strictly increasing by one, so decrement it here.
2556 self.latest_monitor_update_id = monitor_update.update_id;
2557 monitor_update.updates.append(&mut additional_update.updates);
2559 } else if !need_commitment {
2560 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2561 } else { (None, None) };
2563 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2564 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2566 Ok((msgs::RevokeAndACK {
2567 channel_id: self.channel_id,
2568 per_commitment_secret,
2569 next_per_commitment_point,
2570 }, commitment_signed, closing_signed, monitor_update))
2573 /// Public version of the below, checking relevant preconditions first.
2574 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2575 /// returns `(None, Vec::new())`.
2576 pub fn maybe_free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2577 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2578 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2579 self.free_holding_cell_htlcs(logger)
2580 } else { Ok((None, Vec::new())) }
2583 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2584 /// fulfilling or failing the last pending HTLC)
2585 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2586 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2587 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2588 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2589 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2591 let mut monitor_update = ChannelMonitorUpdate {
2592 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2593 updates: Vec::new(),
2596 let mut htlc_updates = Vec::new();
2597 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2598 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2599 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2600 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2601 let mut htlcs_to_fail = Vec::new();
2602 for htlc_update in htlc_updates.drain(..) {
2603 // Note that this *can* fail, though it should be due to rather-rare conditions on
2604 // fee races with adding too many outputs which push our total payments just over
2605 // the limit. In case it's less rare than I anticipate, we may want to revisit
2606 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2607 // to rebalance channels.
2608 match &htlc_update {
2609 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2610 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2611 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2614 ChannelError::Ignore(ref msg) => {
2615 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2616 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2617 // If we fail to send here, then this HTLC should
2618 // be failed backwards. Failing to send here
2619 // indicates that this HTLC may keep being put back
2620 // into the holding cell without ever being
2621 // successfully forwarded/failed/fulfilled, causing
2622 // our counterparty to eventually close on us.
2623 htlcs_to_fail.push((source.clone(), *payment_hash));
2626 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2632 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2633 // If an HTLC claim was previously added to the holding cell (via
2634 // `get_update_fulfill_htlc`, then generating the claim message itself must
2635 // not fail - any in between attempts to claim the HTLC will have resulted
2636 // in it hitting the holding cell again and we cannot change the state of a
2637 // holding cell HTLC from fulfill to anything else.
2638 let (update_fulfill_msg_option, mut additional_monitor_update) =
2639 if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2640 (msg, monitor_update)
2641 } else { unreachable!() };
2642 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2643 monitor_update.updates.append(&mut additional_monitor_update.updates);
2645 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2646 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2647 Ok(update_fail_msg_option) => {
2648 // If an HTLC failure was previously added to the holding cell (via
2649 // `get_update_fail_htlc`) then generating the fail message itself
2650 // must not fail - we should never end up in a state where we
2651 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2652 // we didn't wait for a full revocation before failing.
2653 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2656 if let ChannelError::Ignore(_) = e {}
2658 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2665 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2666 return Ok((None, htlcs_to_fail));
2668 let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
2669 assert!(self.is_outbound());
2670 self.pending_update_fee = Some((feerate, FeeUpdateState::Outbound));
2671 Some(msgs::UpdateFee {
2672 channel_id: self.channel_id,
2673 feerate_per_kw: feerate as u32,
2679 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2680 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2681 // but we want them to be strictly increasing by one, so reset it here.
2682 self.latest_monitor_update_id = monitor_update.update_id;
2683 monitor_update.updates.append(&mut additional_update.updates);
2685 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2686 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2687 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2689 Ok((Some((msgs::CommitmentUpdate {
2691 update_fulfill_htlcs,
2693 update_fail_malformed_htlcs: Vec::new(),
2696 }, monitor_update)), htlcs_to_fail))
2698 Ok((None, Vec::new()))
2702 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2703 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2704 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2705 /// generating an appropriate error *after* the channel state has been updated based on the
2706 /// revoke_and_ack message.
2707 pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2708 where F::Target: FeeEstimator,
2711 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2712 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2714 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2715 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2717 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2718 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2721 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2722 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned())) != counterparty_prev_commitment_point {
2723 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2727 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2728 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2729 // haven't given them a new commitment transaction to broadcast). We should probably
2730 // take advantage of this by updating our channel monitor, sending them an error, and
2731 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2732 // lot of work, and there's some chance this is all a misunderstanding anyway.
2733 // We have to do *something*, though, since our signer may get mad at us for otherwise
2734 // jumping a remote commitment number, so best to just force-close and move on.
2735 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2738 #[cfg(any(test, feature = "fuzztarget"))]
2740 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2741 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2744 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2745 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2746 self.latest_monitor_update_id += 1;
2747 let mut monitor_update = ChannelMonitorUpdate {
2748 update_id: self.latest_monitor_update_id,
2749 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2750 idx: self.cur_counterparty_commitment_transaction_number + 1,
2751 secret: msg.per_commitment_secret,
2755 // Update state now that we've passed all the can-fail calls...
2756 // (note that we may still fail to generate the new commitment_signed message, but that's
2757 // OK, we step the channel here and *then* if the new generation fails we can fail the
2758 // channel based on that, but stepping stuff here should be safe either way.
2759 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2760 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2761 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2762 self.cur_counterparty_commitment_transaction_number -= 1;
2764 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2765 let mut to_forward_infos = Vec::new();
2766 let mut revoked_htlcs = Vec::new();
2767 let mut update_fail_htlcs = Vec::new();
2768 let mut update_fail_malformed_htlcs = Vec::new();
2769 let mut require_commitment = false;
2770 let mut value_to_self_msat_diff: i64 = 0;
2773 // Take references explicitly so that we can hold multiple references to self.
2774 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2775 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2777 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2778 pending_inbound_htlcs.retain(|htlc| {
2779 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2780 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2781 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2782 value_to_self_msat_diff += htlc.amount_msat as i64;
2787 pending_outbound_htlcs.retain(|htlc| {
2788 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2789 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2790 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2791 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2793 // They fulfilled, so we sent them money
2794 value_to_self_msat_diff -= htlc.amount_msat as i64;
2799 for htlc in pending_inbound_htlcs.iter_mut() {
2800 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2802 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2806 let mut state = InboundHTLCState::Committed;
2807 mem::swap(&mut state, &mut htlc.state);
2809 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2810 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2811 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2812 require_commitment = true;
2813 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2814 match forward_info {
2815 PendingHTLCStatus::Fail(fail_msg) => {
2816 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2817 require_commitment = true;
2819 HTLCFailureMsg::Relay(msg) => {
2820 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2821 update_fail_htlcs.push(msg)
2823 HTLCFailureMsg::Malformed(msg) => {
2824 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2825 update_fail_malformed_htlcs.push(msg)
2829 PendingHTLCStatus::Forward(forward_info) => {
2830 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2831 to_forward_infos.push((forward_info, htlc.htlc_id));
2832 htlc.state = InboundHTLCState::Committed;
2838 for htlc in pending_outbound_htlcs.iter_mut() {
2839 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2840 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2841 htlc.state = OutboundHTLCState::Committed;
2843 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2844 Some(fail_reason.take())
2846 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2847 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2848 require_commitment = true;
2852 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2854 if let Some((feerate, update_state)) = self.pending_update_fee {
2855 match update_state {
2856 FeeUpdateState::Outbound => {
2857 debug_assert!(self.is_outbound());
2858 log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
2859 self.feerate_per_kw = feerate;
2860 self.pending_update_fee = None;
2862 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
2863 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
2864 debug_assert!(!self.is_outbound());
2865 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
2866 require_commitment = true;
2867 self.feerate_per_kw = feerate;
2868 self.pending_update_fee = None;
2873 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2874 // We can't actually generate a new commitment transaction (incl by freeing holding
2875 // cells) while we can't update the monitor, so we just return what we have.
2876 if require_commitment {
2877 self.monitor_pending_commitment_signed = true;
2878 // When the monitor updating is restored we'll call get_last_commitment_update(),
2879 // which does not update state, but we're definitely now awaiting a remote revoke
2880 // before we can step forward any more, so set it here.
2881 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2882 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2883 // strictly increasing by one, so decrement it here.
2884 self.latest_monitor_update_id = monitor_update.update_id;
2885 monitor_update.updates.append(&mut additional_update.updates);
2887 self.monitor_pending_forwards.append(&mut to_forward_infos);
2888 self.monitor_pending_failures.append(&mut revoked_htlcs);
2889 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2890 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2893 match self.free_holding_cell_htlcs(logger)? {
2894 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2895 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2896 for fail_msg in update_fail_htlcs.drain(..) {
2897 commitment_update.update_fail_htlcs.push(fail_msg);
2899 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2900 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2901 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2904 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2905 // strictly increasing by one, so decrement it here.
2906 self.latest_monitor_update_id = monitor_update.update_id;
2907 monitor_update.updates.append(&mut additional_update.updates);
2909 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2911 (None, htlcs_to_fail) => {
2912 if require_commitment {
2913 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2915 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2916 // strictly increasing by one, so decrement it here.
2917 self.latest_monitor_update_id = monitor_update.update_id;
2918 monitor_update.updates.append(&mut additional_update.updates);
2920 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2921 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2922 Ok((Some(msgs::CommitmentUpdate {
2923 update_add_htlcs: Vec::new(),
2924 update_fulfill_htlcs: Vec::new(),
2926 update_fail_malformed_htlcs,
2929 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2931 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2932 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2939 /// Adds a pending update to this channel. See the doc for send_htlc for
2940 /// further details on the optionness of the return value.
2941 /// You MUST call send_commitment prior to any other calls on this Channel
2942 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2943 if !self.is_outbound() {
2944 panic!("Cannot send fee from inbound channel");
2946 if !self.is_usable() {
2947 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2949 if !self.is_live() {
2950 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2953 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
2954 self.holding_cell_update_fee = Some(feerate_per_kw);
2958 debug_assert!(self.pending_update_fee.is_none());
2959 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
2961 Some(msgs::UpdateFee {
2962 channel_id: self.channel_id,
2967 pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2968 match self.send_update_fee(feerate_per_kw) {
2969 Some(update_fee) => {
2970 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2971 Ok(Some((update_fee, commitment_signed, monitor_update)))
2977 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2978 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2980 /// No further message handling calls may be made until a channel_reestablish dance has
2982 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
2983 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2984 if self.channel_state < ChannelState::FundingSent as u32 {
2985 self.channel_state = ChannelState::ShutdownComplete as u32;
2988 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2989 // will be retransmitted.
2990 self.last_sent_closing_fee = None;
2992 let mut inbound_drop_count = 0;
2993 self.pending_inbound_htlcs.retain(|htlc| {
2995 InboundHTLCState::RemoteAnnounced(_) => {
2996 // They sent us an update_add_htlc but we never got the commitment_signed.
2997 // We'll tell them what commitment_signed we're expecting next and they'll drop
2998 // this HTLC accordingly
2999 inbound_drop_count += 1;
3002 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3003 // We received a commitment_signed updating this HTLC and (at least hopefully)
3004 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3005 // in response to it yet, so don't touch it.
3008 InboundHTLCState::Committed => true,
3009 InboundHTLCState::LocalRemoved(_) => {
3010 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3011 // re-transmit if needed) and they may have even sent a revoke_and_ack back
3012 // (that we missed). Keep this around for now and if they tell us they missed
3013 // the commitment_signed we can re-transmit the update then.
3018 self.next_counterparty_htlc_id -= inbound_drop_count;
3020 if let Some((_, update_state)) = self.pending_update_fee {
3021 if update_state == FeeUpdateState::RemoteAnnounced {
3022 debug_assert!(!self.is_outbound());
3023 self.pending_update_fee = None;
3027 for htlc in self.pending_outbound_htlcs.iter_mut() {
3028 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3029 // They sent us an update to remove this but haven't yet sent the corresponding
3030 // commitment_signed, we need to move it back to Committed and they can re-send
3031 // the update upon reconnection.
3032 htlc.state = OutboundHTLCState::Committed;
3036 self.channel_state |= ChannelState::PeerDisconnected as u32;
3037 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3040 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3041 /// updates are partially paused.
3042 /// This must be called immediately after the call which generated the ChannelMonitor update
3043 /// which failed. The messages which were generated from that call which generated the
3044 /// monitor update failure must *not* have been sent to the remote end, and must instead
3045 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3046 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)>) {
3047 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
3048 self.monitor_pending_revoke_and_ack = resend_raa;
3049 self.monitor_pending_commitment_signed = resend_commitment;
3050 assert!(self.monitor_pending_forwards.is_empty());
3051 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
3052 assert!(self.monitor_pending_failures.is_empty());
3053 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
3054 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3057 /// Indicates that the latest ChannelMonitor update has been committed by the client
3058 /// successfully and we should restore normal operation. Returns messages which should be sent
3059 /// to the remote side.
3060 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<Transaction>, Option<msgs::FundingLocked>) where L::Target: Logger {
3061 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3062 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3064 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
3065 self.funding_transaction.take()
3068 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3069 // we assume the user never directly broadcasts the funding transaction and waits for us to
3070 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
3071 // channel which failed to persist the monitor on funding_created, and we got the funding
3072 // transaction confirmed before the monitor was persisted.
3073 let funding_locked = if self.monitor_pending_funding_locked {
3074 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3075 self.monitor_pending_funding_locked = false;
3076 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3077 Some(msgs::FundingLocked {
3078 channel_id: self.channel_id(),
3079 next_per_commitment_point,
3083 let mut forwards = Vec::new();
3084 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
3085 let mut failures = Vec::new();
3086 mem::swap(&mut failures, &mut self.monitor_pending_failures);
3088 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3089 self.monitor_pending_revoke_and_ack = false;
3090 self.monitor_pending_commitment_signed = false;
3091 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
3094 let raa = if self.monitor_pending_revoke_and_ack {
3095 Some(self.get_last_revoke_and_ack())
3097 let commitment_update = if self.monitor_pending_commitment_signed {
3098 Some(self.get_last_commitment_update(logger))
3101 self.monitor_pending_revoke_and_ack = false;
3102 self.monitor_pending_commitment_signed = false;
3103 let order = self.resend_order.clone();
3104 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3105 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3106 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3107 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3108 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
3111 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3112 where F::Target: FeeEstimator
3114 if self.is_outbound() {
3115 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3117 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3118 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3120 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3121 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate();
3123 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3124 self.update_time_counter += 1;
3125 // If the feerate has increased over the previous dust buffer (note that
3126 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3127 // won't be pushed over our dust exposure limit by the feerate increase.
3128 if feerate_over_dust_buffer {
3129 let inbound_stats = self.get_inbound_pending_htlc_stats();
3130 let outbound_stats = self.get_outbound_pending_htlc_stats();
3131 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3132 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3133 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3134 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our own transactions (totaling {} msat)",
3135 msg.feerate_per_kw, holder_tx_dust_exposure)));
3137 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3138 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our counterparty's transactions (totaling {} msat)",
3139 msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3145 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3146 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3147 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3148 msgs::RevokeAndACK {
3149 channel_id: self.channel_id,
3150 per_commitment_secret,
3151 next_per_commitment_point,
3155 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3156 let mut update_add_htlcs = Vec::new();
3157 let mut update_fulfill_htlcs = Vec::new();
3158 let mut update_fail_htlcs = Vec::new();
3159 let mut update_fail_malformed_htlcs = Vec::new();
3161 for htlc in self.pending_outbound_htlcs.iter() {
3162 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3163 update_add_htlcs.push(msgs::UpdateAddHTLC {
3164 channel_id: self.channel_id(),
3165 htlc_id: htlc.htlc_id,
3166 amount_msat: htlc.amount_msat,
3167 payment_hash: htlc.payment_hash,
3168 cltv_expiry: htlc.cltv_expiry,
3169 onion_routing_packet: (**onion_packet).clone(),
3174 for htlc in self.pending_inbound_htlcs.iter() {
3175 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3177 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3178 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3179 channel_id: self.channel_id(),
3180 htlc_id: htlc.htlc_id,
3181 reason: err_packet.clone()
3184 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3185 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3186 channel_id: self.channel_id(),
3187 htlc_id: htlc.htlc_id,
3188 sha256_of_onion: sha256_of_onion.clone(),
3189 failure_code: failure_code.clone(),
3192 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3193 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3194 channel_id: self.channel_id(),
3195 htlc_id: htlc.htlc_id,
3196 payment_preimage: payment_preimage.clone(),
3203 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3204 Some(msgs::UpdateFee {
3205 channel_id: self.channel_id(),
3206 feerate_per_kw: self.pending_update_fee.unwrap().0,
3210 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3211 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3212 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3213 msgs::CommitmentUpdate {
3214 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3215 commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
3219 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3220 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3221 pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Vec<(HTLCSource, PaymentHash)>, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
3222 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3223 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3224 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3225 // just close here instead of trying to recover.
3226 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3229 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3230 msg.next_local_commitment_number == 0 {
3231 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3234 if msg.next_remote_commitment_number > 0 {
3235 match msg.data_loss_protect {
3236 OptionalField::Present(ref data_loss) => {
3237 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3238 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3239 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3240 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3241 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3243 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3244 return Err(ChannelError::CloseDelayBroadcast(
3245 "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".to_owned()
3249 OptionalField::Absent => {}
3253 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3254 // remaining cases either succeed or ErrorMessage-fail).
3255 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3257 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3258 assert!(self.shutdown_scriptpubkey.is_some());
3259 Some(msgs::Shutdown {
3260 channel_id: self.channel_id,
3261 scriptpubkey: self.get_closing_scriptpubkey(),
3265 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3266 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3267 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3268 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3269 if msg.next_remote_commitment_number != 0 {
3270 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3272 // Short circuit the whole handler as there is nothing we can resend them
3273 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3276 // We have OurFundingLocked set!
3277 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3278 return Ok((Some(msgs::FundingLocked {
3279 channel_id: self.channel_id(),
3280 next_per_commitment_point,
3281 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3284 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3285 // Remote isn't waiting on any RevokeAndACK from us!
3286 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3288 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3289 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3290 self.monitor_pending_revoke_and_ack = true;
3293 Some(self.get_last_revoke_and_ack())
3296 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3299 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3300 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3301 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3302 // the corresponding revoke_and_ack back yet.
3303 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
3305 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3306 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3307 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3308 Some(msgs::FundingLocked {
3309 channel_id: self.channel_id(),
3310 next_per_commitment_point,
3314 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3315 if required_revoke.is_some() {
3316 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3318 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3321 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3322 // We're up-to-date and not waiting on a remote revoke (if we are our
3323 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3324 // have received some updates while we were disconnected. Free the holding cell
3326 match self.free_holding_cell_htlcs(logger) {
3327 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3328 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
3329 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3330 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3331 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3333 Ok((None, htlcs_to_fail)) => {
3334 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3338 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3340 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3341 if required_revoke.is_some() {
3342 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3344 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3347 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3348 self.monitor_pending_commitment_signed = true;
3349 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3352 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3354 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3358 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3359 where F::Target: FeeEstimator
3361 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3362 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3363 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3367 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3368 if self.feerate_per_kw > proposed_feerate {
3369 proposed_feerate = self.feerate_per_kw;
3371 assert!(self.shutdown_scriptpubkey.is_some());
3372 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3373 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3375 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3376 let sig = self.holder_signer
3377 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3379 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3380 if sig.is_none() { return None; }
3382 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3383 Some(msgs::ClosingSigned {
3384 channel_id: self.channel_id,
3385 fee_satoshis: total_fee_satoshis,
3386 signature: sig.unwrap(),
3390 pub fn shutdown<F: Deref, K: Deref>(
3391 &mut self, fee_estimator: &F, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3392 ) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3394 F::Target: FeeEstimator,
3395 K::Target: KeysInterface<Signer = Signer>
3397 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3398 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3400 if self.channel_state < ChannelState::FundingSent as u32 {
3401 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3402 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3403 // can do that via error message without getting a connection fail anyway...
3404 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3406 for htlc in self.pending_inbound_htlcs.iter() {
3407 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3408 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3411 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3413 let shutdown_scriptpubkey = match ShutdownScript::try_from((msg.scriptpubkey.clone(), their_features)) {
3414 Ok(script) => script.into_inner(),
3415 Err(_) => return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex()))),
3418 if self.counterparty_shutdown_scriptpubkey.is_some() {
3419 if Some(&shutdown_scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3420 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", shutdown_scriptpubkey.to_bytes().to_hex())));
3423 self.counterparty_shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3426 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
3427 // immediately after the commitment dance, but we can send a Shutdown because we won't send
3428 // any further commitment updates after we set LocalShutdownSent.
3429 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3431 let update_shutdown_script = match self.shutdown_scriptpubkey {
3434 assert!(send_shutdown);
3435 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3436 if !shutdown_scriptpubkey.is_compatible(their_features) {
3437 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
3439 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3444 // From here on out, we may not fail!
3446 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3447 self.update_time_counter += 1;
3449 let monitor_update = if update_shutdown_script {
3450 self.latest_monitor_update_id += 1;
3451 Some(ChannelMonitorUpdate {
3452 update_id: self.latest_monitor_update_id,
3453 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3454 scriptpubkey: self.get_closing_scriptpubkey(),
3458 let shutdown = if send_shutdown {
3459 Some(msgs::Shutdown {
3460 channel_id: self.channel_id,
3461 scriptpubkey: self.get_closing_scriptpubkey(),
3465 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3466 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3467 // cell HTLCs and return them to fail the payment.
3468 self.holding_cell_update_fee = None;
3469 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3470 self.holding_cell_htlc_updates.retain(|htlc_update| {
3472 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3473 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3480 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3481 self.update_time_counter += 1;
3483 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, dropped_outbound_htlcs))
3486 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3487 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3488 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3489 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3491 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3493 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3494 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3495 if funding_key[..] < counterparty_funding_key[..] {
3496 tx.input[0].witness.push(sig.serialize_der().to_vec());
3497 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3499 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3500 tx.input[0].witness.push(sig.serialize_der().to_vec());
3502 tx.input[0].witness[1].push(SigHashType::All as u8);
3503 tx.input[0].witness[2].push(SigHashType::All as u8);
3505 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3508 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3509 where F::Target: FeeEstimator
3511 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3512 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3514 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3515 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3517 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3518 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3520 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3521 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3524 let funding_redeemscript = self.get_funding_redeemscript();
3525 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3526 if used_total_fee != msg.fee_satoshis {
3527 return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee greater than the value they can claim. Fee in message: {}", msg.fee_satoshis)));
3529 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3531 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3534 // The remote end may have decided to revoke their output due to inconsistent dust
3535 // limits, so check for that case by re-checking the signature here.
3536 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3537 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3538 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3542 let closing_tx_max_weight = self.get_closing_transaction_weight(
3543 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3544 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3545 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3546 if last_fee == msg.fee_satoshis {
3547 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3548 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3549 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3550 self.channel_state = ChannelState::ShutdownComplete as u32;
3551 self.update_time_counter += 1;
3552 return Ok((None, Some(closing_tx)));
3556 macro_rules! propose_new_feerate {
3557 ($new_feerate: expr) => {
3558 assert!(self.shutdown_scriptpubkey.is_some());
3559 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3560 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3561 let sig = self.holder_signer
3562 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3563 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3564 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3565 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3566 return Ok((Some(msgs::ClosingSigned {
3567 channel_id: self.channel_id,
3568 fee_satoshis: used_total_fee,
3574 let mut min_feerate = 253;
3575 if self.is_outbound() {
3576 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3577 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3578 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3579 if max_feerate <= last_feerate {
3580 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something higher ({}) than our Normal feerate ({})", last_feerate, max_feerate)));
3583 propose_new_feerate!(max_feerate);
3586 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3588 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3589 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3590 if min_feerate >= last_feerate {
3591 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something lower ({}) than our Background feerate ({}).", last_feerate, min_feerate)));
3594 propose_new_feerate!(min_feerate);
3597 let sig = self.holder_signer
3598 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3599 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3600 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3601 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3602 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3604 self.channel_state = ChannelState::ShutdownComplete as u32;
3605 self.update_time_counter += 1;
3607 Ok((Some(msgs::ClosingSigned {
3608 channel_id: self.channel_id,
3609 fee_satoshis: msg.fee_satoshis,
3611 }), Some(closing_tx)))
3614 // Public utilities:
3616 pub fn channel_id(&self) -> [u8; 32] {
3620 pub fn minimum_depth(&self) -> Option<u32> {
3624 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3625 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3626 pub fn get_user_id(&self) -> u64 {
3630 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3631 /// is_usable() returns true).
3632 /// Allowed in any state (including after shutdown)
3633 pub fn get_short_channel_id(&self) -> Option<u64> {
3634 self.short_channel_id
3637 /// Returns the funding_txo we either got from our peer, or were given by
3638 /// get_outbound_funding_created.
3639 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3640 self.channel_transaction_parameters.funding_outpoint
3643 fn get_holder_selected_contest_delay(&self) -> u16 {
3644 self.channel_transaction_parameters.holder_selected_contest_delay
3647 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3648 &self.channel_transaction_parameters.holder_pubkeys
3651 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3652 self.channel_transaction_parameters.counterparty_parameters
3653 .as_ref().map(|params| params.selected_contest_delay)
3656 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3657 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3660 /// Allowed in any state (including after shutdown)
3661 pub fn get_counterparty_node_id(&self) -> PublicKey {
3662 self.counterparty_node_id
3665 /// Allowed in any state (including after shutdown)
3667 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3668 self.holder_htlc_minimum_msat
3671 /// Allowed in any state (including after shutdown)
3672 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3674 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3675 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3676 // channel might have been used to route very small values (either by honest users or as DoS).
3677 self.channel_value_satoshis * 1000 * 9 / 10,
3679 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3683 /// Allowed in any state (including after shutdown)
3684 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3685 self.counterparty_htlc_minimum_msat
3688 pub fn get_value_satoshis(&self) -> u64 {
3689 self.channel_value_satoshis
3692 pub fn get_fee_proportional_millionths(&self) -> u32 {
3693 self.config.forwarding_fee_proportional_millionths
3696 pub fn get_cltv_expiry_delta(&self) -> u16 {
3697 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3700 pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
3701 self.config.max_dust_htlc_exposure_msat
3704 pub fn get_feerate(&self) -> u32 {
3708 pub fn get_dust_buffer_feerate(&self) -> u32 {
3709 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
3710 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
3711 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
3712 // more dust balance if the feerate increases when we have several HTLCs pending
3713 // which are near the dust limit.
3714 let mut feerate_per_kw = self.feerate_per_kw;
3715 if let Some((feerate, _)) = self.pending_update_fee {
3716 feerate_per_kw = cmp::max(feerate_per_kw, feerate);
3718 cmp::max(2530, feerate_per_kw * 1250 / 1000)
3721 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3722 self.cur_holder_commitment_transaction_number + 1
3725 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3726 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3729 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3730 self.cur_counterparty_commitment_transaction_number + 2
3734 pub fn get_signer(&self) -> &Signer {
3739 pub fn get_value_stat(&self) -> ChannelValueStat {
3741 value_to_self_msat: self.value_to_self_msat,
3742 channel_value_msat: self.channel_value_satoshis * 1000,
3743 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3744 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3745 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3746 holding_cell_outbound_amount_msat: {
3748 for h in self.holding_cell_htlc_updates.iter() {
3750 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3758 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3759 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3763 /// Allowed in any state (including after shutdown)
3764 pub fn get_update_time_counter(&self) -> u32 {
3765 self.update_time_counter
3768 pub fn get_latest_monitor_update_id(&self) -> u64 {
3769 self.latest_monitor_update_id
3772 pub fn should_announce(&self) -> bool {
3773 self.config.announced_channel
3776 pub fn is_outbound(&self) -> bool {
3777 self.channel_transaction_parameters.is_outbound_from_holder
3780 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3781 /// Allowed in any state (including after shutdown)
3782 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3783 self.config.forwarding_fee_base_msat
3786 /// Returns true if we've ever received a message from the remote end for this Channel
3787 pub fn have_received_message(&self) -> bool {
3788 self.channel_state > (ChannelState::OurInitSent as u32)
3791 /// Returns true if this channel is fully established and not known to be closing.
3792 /// Allowed in any state (including after shutdown)
3793 pub fn is_usable(&self) -> bool {
3794 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3795 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3798 /// Returns true if this channel is currently available for use. This is a superset of
3799 /// is_usable() and considers things like the channel being temporarily disabled.
3800 /// Allowed in any state (including after shutdown)
3801 pub fn is_live(&self) -> bool {
3802 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3805 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3806 /// Allowed in any state (including after shutdown)
3807 pub fn is_awaiting_monitor_update(&self) -> bool {
3808 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3811 /// Returns true if funding_created was sent/received.
3812 pub fn is_funding_initiated(&self) -> bool {
3813 self.channel_state >= ChannelState::FundingSent as u32
3816 /// Returns true if this channel is fully shut down. True here implies that no further actions
3817 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3818 /// will be handled appropriately by the chain monitor.
3819 pub fn is_shutdown(&self) -> bool {
3820 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3821 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3826 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3827 self.channel_update_status
3830 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3831 self.channel_update_status = status;
3834 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3835 if self.funding_tx_confirmation_height == 0 {
3839 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3840 if funding_tx_confirmations <= 0 {
3841 self.funding_tx_confirmation_height = 0;
3844 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3848 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3849 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3850 self.channel_state |= ChannelState::OurFundingLocked as u32;
3852 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3853 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3854 self.update_time_counter += 1;
3856 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3857 // We got a reorg but not enough to trigger a force close, just ignore.
3859 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3860 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3862 // We got a reorg but not enough to trigger a force close, just ignore.
3866 if need_commitment_update {
3867 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3868 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3869 return Some(msgs::FundingLocked {
3870 channel_id: self.channel_id,
3871 next_per_commitment_point,
3874 self.monitor_pending_funding_locked = true;
3880 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3881 /// In the first case, we store the confirmation height and calculating the short channel id.
3882 /// In the second, we simply return an Err indicating we need to be force-closed now.
3883 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3884 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3885 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3886 for &(index_in_block, tx) in txdata.iter() {
3887 if let Some(funding_txo) = self.get_funding_txo() {
3888 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3889 // whether they've sent a funding_locked or not), check if we should send one.
3890 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3891 if tx.txid() == funding_txo.txid {
3892 let txo_idx = funding_txo.index as usize;
3893 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3894 tx.output[txo_idx].value != self.channel_value_satoshis {
3895 if self.is_outbound() {
3896 // If we generated the funding transaction and it doesn't match what it
3897 // should, the client is really broken and we should just panic and
3898 // tell them off. That said, because hash collisions happen with high
3899 // probability in fuzztarget mode, if we're fuzzing we just close the
3900 // channel and move on.
3901 #[cfg(not(feature = "fuzztarget"))]
3902 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3904 self.update_time_counter += 1;
3905 return Err(msgs::ErrorMessage {
3906 channel_id: self.channel_id(),
3907 data: "funding tx had wrong script/value or output index".to_owned()
3910 if self.is_outbound() {
3911 for input in tx.input.iter() {
3912 if input.witness.is_empty() {
3913 // We generated a malleable funding transaction, implying we've
3914 // just exposed ourselves to funds loss to our counterparty.
3915 #[cfg(not(feature = "fuzztarget"))]
3916 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3920 self.funding_tx_confirmation_height = height;
3921 self.funding_tx_confirmed_in = Some(*block_hash);
3922 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3923 Ok(scid) => Some(scid),
3924 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3928 // If we allow 1-conf funding, we may need to check for funding_locked here and
3929 // send it immediately instead of waiting for a best_block_updated call (which
3930 // may have already happened for this block).
3931 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3932 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3933 return Ok(Some(funding_locked));
3936 for inp in tx.input.iter() {
3937 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3938 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(self.channel_id()));
3939 return Err(msgs::ErrorMessage {
3940 channel_id: self.channel_id(),
3941 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3950 /// When a new block is connected, we check the height of the block against outbound holding
3951 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3952 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3953 /// handled by the ChannelMonitor.
3955 /// If we return Err, the channel may have been closed, at which point the standard
3956 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3959 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3961 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
3962 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
3963 let mut timed_out_htlcs = Vec::new();
3964 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3965 self.holding_cell_htlc_updates.retain(|htlc_update| {
3967 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3968 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3969 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3977 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3979 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3980 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3981 return Ok((Some(funding_locked), timed_out_htlcs));
3984 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3985 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3986 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3987 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3988 if self.funding_tx_confirmation_height == 0 {
3989 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3990 // zero if it has been reorged out, however in either case, our state flags
3991 // indicate we've already sent a funding_locked
3992 funding_tx_confirmations = 0;
3995 // If we've sent funding_locked (or have both sent and received funding_locked), and
3996 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3997 // close the channel and hope we can get the latest state on chain (because presumably
3998 // the funding transaction is at least still in the mempool of most nodes).
3999 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
4000 return Err(msgs::ErrorMessage {
4001 channel_id: self.channel_id(),
4002 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
4007 Ok((None, timed_out_htlcs))
4010 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4011 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4012 /// before the channel has reached funding_locked and we can just wait for more blocks.
4013 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
4014 if self.funding_tx_confirmation_height != 0 {
4015 // We handle the funding disconnection by calling best_block_updated with a height one
4016 // below where our funding was connected, implying a reorg back to conf_height - 1.
4017 let reorg_height = self.funding_tx_confirmation_height - 1;
4018 // We use the time field to bump the current time we set on channel updates if its
4019 // larger. If we don't know that time has moved forward, we can just set it to the last
4020 // time we saw and it will be ignored.
4021 let best_time = self.update_time_counter;
4022 match self.best_block_updated(reorg_height, best_time, logger) {
4023 Ok((funding_locked, timed_out_htlcs)) => {
4024 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
4025 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4031 // We never learned about the funding confirmation anyway, just ignore
4036 // Methods to get unprompted messages to send to the remote end (or where we already returned
4037 // something in the handler for the message that prompted this message):
4039 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
4040 if !self.is_outbound() {
4041 panic!("Tried to open a channel for an inbound channel?");
4043 if self.channel_state != ChannelState::OurInitSent as u32 {
4044 panic!("Cannot generate an open_channel after we've moved forward");
4047 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4048 panic!("Tried to send an open_channel for a channel that has already advanced");
4051 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4052 let keys = self.get_holder_pubkeys();
4056 temporary_channel_id: self.channel_id,
4057 funding_satoshis: self.channel_value_satoshis,
4058 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
4059 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4060 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4061 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4062 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4063 feerate_per_kw: self.feerate_per_kw as u32,
4064 to_self_delay: self.get_holder_selected_contest_delay(),
4065 max_accepted_htlcs: OUR_MAX_HTLCS,
4066 funding_pubkey: keys.funding_pubkey,
4067 revocation_basepoint: keys.revocation_basepoint,
4068 payment_point: keys.payment_point,
4069 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4070 htlc_basepoint: keys.htlc_basepoint,
4071 first_per_commitment_point,
4072 channel_flags: if self.config.announced_channel {1} else {0},
4073 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4074 Some(script) => script.clone().into_inner(),
4075 None => Builder::new().into_script(),
4080 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
4081 if self.is_outbound() {
4082 panic!("Tried to send accept_channel for an outbound channel?");
4084 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
4085 panic!("Tried to send accept_channel after channel had moved forward");
4087 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4088 panic!("Tried to send an accept_channel for a channel that has already advanced");
4091 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4092 let keys = self.get_holder_pubkeys();
4094 msgs::AcceptChannel {
4095 temporary_channel_id: self.channel_id,
4096 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4097 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4098 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4099 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4100 minimum_depth: self.minimum_depth.unwrap(),
4101 to_self_delay: self.get_holder_selected_contest_delay(),
4102 max_accepted_htlcs: OUR_MAX_HTLCS,
4103 funding_pubkey: keys.funding_pubkey,
4104 revocation_basepoint: keys.revocation_basepoint,
4105 payment_point: keys.payment_point,
4106 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4107 htlc_basepoint: keys.htlc_basepoint,
4108 first_per_commitment_point,
4109 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4110 Some(script) => script.clone().into_inner(),
4111 None => Builder::new().into_script(),
4116 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
4117 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
4118 let counterparty_keys = self.build_remote_transaction_keys()?;
4119 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
4120 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
4121 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
4124 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
4125 /// a funding_created message for the remote peer.
4126 /// Panics if called at some time other than immediately after initial handshake, if called twice,
4127 /// or if called on an inbound channel.
4128 /// Note that channel_id changes during this call!
4129 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
4130 /// If an Err is returned, it is a ChannelError::Close.
4131 pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
4132 if !self.is_outbound() {
4133 panic!("Tried to create outbound funding_created message on an inbound channel!");
4135 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
4136 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)");
4138 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
4139 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
4140 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4141 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
4144 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
4145 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
4147 let signature = match self.get_outbound_funding_created_signature(logger) {
4150 log_error!(logger, "Got bad signatures: {:?}!", e);
4151 self.channel_transaction_parameters.funding_outpoint = None;
4156 let temporary_channel_id = self.channel_id;
4158 // Now that we're past error-generating stuff, update our local state:
4160 self.channel_state = ChannelState::FundingCreated as u32;
4161 self.channel_id = funding_txo.to_channel_id();
4162 self.funding_transaction = Some(funding_transaction);
4164 Ok(msgs::FundingCreated {
4165 temporary_channel_id,
4166 funding_txid: funding_txo.txid,
4167 funding_output_index: funding_txo.index,
4172 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4173 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4174 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4175 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4176 /// Will only fail if we're not in a state where channel_announcement may be sent (including
4178 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4179 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4181 /// This will only return ChannelError::Ignore upon failure.
4182 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4183 if !self.config.announced_channel {
4184 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4186 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4187 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4189 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4190 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4193 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4195 let msg = msgs::UnsignedChannelAnnouncement {
4196 features: ChannelFeatures::known(),
4198 short_channel_id: self.get_short_channel_id().unwrap(),
4199 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4200 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4201 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4202 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4203 excess_data: Vec::new(),
4206 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4207 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4212 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4214 fn sign_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, msghash: secp256k1::Message, announcement: msgs::UnsignedChannelAnnouncement, our_bitcoin_sig: Signature) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4215 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4216 let were_node_one = announcement.node_id_1 == our_node_id;
4218 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4219 Ok(msgs::ChannelAnnouncement {
4220 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4221 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4222 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4223 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4224 contents: announcement,
4227 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4231 /// Processes an incoming announcement_signatures message, providing a fully-signed
4232 /// channel_announcement message which we can broadcast and storing our counterparty's
4233 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4234 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4235 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4237 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4239 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4240 return Err(ChannelError::Close(format!(
4241 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4242 &announcement, self.get_counterparty_node_id())));
4244 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4245 return Err(ChannelError::Close(format!(
4246 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4247 &announcement, self.counterparty_funding_pubkey())));
4250 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4252 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4255 /// Gets a signed channel_announcement for this channel, if we previously received an
4256 /// announcement_signatures from our counterparty.
4257 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4258 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4260 Err(_) => return None,
4262 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4263 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4264 Ok(res) => Some(res),
4269 /// May panic if called on a channel that wasn't immediately-previously
4270 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4271 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4272 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4273 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4274 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4275 // current to_remote balances. However, it no longer has any use, and thus is now simply
4276 // set to a dummy (but valid, as required by the spec) public key.
4277 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4278 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4279 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4280 let mut pk = [2; 33]; pk[1] = 0xff;
4281 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4282 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4283 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4284 log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), log_bytes!(self.channel_id()));
4285 OptionalField::Present(DataLossProtect {
4286 your_last_per_commitment_secret: remote_last_secret,
4287 my_current_per_commitment_point: dummy_pubkey
4290 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4291 OptionalField::Present(DataLossProtect {
4292 your_last_per_commitment_secret: [0;32],
4293 my_current_per_commitment_point: dummy_pubkey,
4296 msgs::ChannelReestablish {
4297 channel_id: self.channel_id(),
4298 // The protocol has two different commitment number concepts - the "commitment
4299 // transaction number", which starts from 0 and counts up, and the "revocation key
4300 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4301 // commitment transaction numbers by the index which will be used to reveal the
4302 // revocation key for that commitment transaction, which means we have to convert them
4303 // to protocol-level commitment numbers here...
4305 // next_local_commitment_number is the next commitment_signed number we expect to
4306 // receive (indicating if they need to resend one that we missed).
4307 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4308 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4309 // receive, however we track it by the next commitment number for a remote transaction
4310 // (which is one further, as they always revoke previous commitment transaction, not
4311 // the one we send) so we have to decrement by 1. Note that if
4312 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4313 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4315 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4321 // Send stuff to our remote peers:
4323 /// Adds a pending outbound HTLC to this channel, note that you probably want
4324 /// send_htlc_and_commit instead cause you'll want both messages at once.
4326 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4328 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4329 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4331 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4332 /// may not yet have sent the previous commitment update messages and will need to regenerate
4335 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4337 /// If an Err is returned, it's a ChannelError::Ignore!
4338 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> {
4339 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4340 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4342 let channel_total_msat = self.channel_value_satoshis * 1000;
4343 if amount_msat > channel_total_msat {
4344 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4347 if amount_msat == 0 {
4348 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4351 if amount_msat < self.counterparty_htlc_minimum_msat {
4352 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4355 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4356 // Note that this should never really happen, if we're !is_live() on receipt of an
4357 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4358 // the user to send directly into a !is_live() channel. However, if we
4359 // disconnected during the time the previous hop was doing the commitment dance we may
4360 // end up getting here after the forwarding delay. In any case, returning an
4361 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4362 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4365 let inbound_stats = self.get_inbound_pending_htlc_stats();
4366 let outbound_stats = self.get_outbound_pending_htlc_stats();
4367 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
4368 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4370 // Check their_max_htlc_value_in_flight_msat
4371 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4372 return Err(ChannelError::Ignore(format!("Cannot send value that would put us over the max HTLC value in flight our peer will accept ({})", self.counterparty_max_htlc_value_in_flight_msat)));
4375 if !self.is_outbound() {
4376 // Check that we won't violate the remote channel reserve by adding this HTLC.
4377 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4378 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4379 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4380 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4381 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4382 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4386 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
4387 if amount_msat / 1000 < exposure_dust_limit_success_sats {
4388 let on_counterparty_dust_htlc_exposure_msat = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat + amount_msat;
4389 if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4390 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
4391 on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4395 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
4396 if amount_msat / 1000 < exposure_dust_limit_timeout_sats {
4397 let on_holder_dust_htlc_exposure_msat = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat + amount_msat;
4398 if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4399 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
4400 on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4404 let pending_value_to_self_msat = self.value_to_self_msat - outbound_stats.pending_htlcs_value_msat;
4405 if pending_value_to_self_msat < amount_msat {
4406 return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, pending_value_to_self_msat)));
4409 // `2 *` and extra HTLC are for the fee spike buffer.
4410 let commit_tx_fee_msat = if self.is_outbound() {
4411 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4412 FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4414 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4415 return Err(ChannelError::Ignore(format!("Cannot send value that would not leave enough to pay for fees. Pending value to self: {}. local_commit_tx_fee {}", pending_value_to_self_msat, commit_tx_fee_msat)));
4418 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4419 // reserve for the remote to have something to claim if we misbehave)
4420 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4421 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4422 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4425 // Now update local state:
4426 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4427 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4432 onion_routing_packet,
4437 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4438 htlc_id: self.next_holder_htlc_id,
4440 payment_hash: payment_hash.clone(),
4442 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4446 let res = msgs::UpdateAddHTLC {
4447 channel_id: self.channel_id,
4448 htlc_id: self.next_holder_htlc_id,
4452 onion_routing_packet,
4454 self.next_holder_htlc_id += 1;
4459 /// Creates a signed commitment transaction to send to the remote peer.
4460 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4461 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4462 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4463 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4464 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4465 panic!("Cannot create commitment tx until channel is fully established");
4467 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4468 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4470 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4471 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4473 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4474 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");
4476 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
4477 for htlc in self.pending_outbound_htlcs.iter() {
4478 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4479 have_updates = true;
4481 if have_updates { break; }
4483 for htlc in self.pending_inbound_htlcs.iter() {
4484 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4485 have_updates = true;
4487 if have_updates { break; }
4490 panic!("Cannot create commitment tx until we have some updates to send");
4492 self.send_commitment_no_status_check(logger)
4494 /// Only fails in case of bad keys
4495 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4496 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
4497 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4498 // fail to generate this, we still are at least at a position where upgrading their status
4500 for htlc in self.pending_inbound_htlcs.iter_mut() {
4501 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4502 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4504 if let Some(state) = new_state {
4505 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4509 for htlc in self.pending_outbound_htlcs.iter_mut() {
4510 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4511 Some(fail_reason.take())
4513 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4514 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4517 if let Some((feerate, update_state)) = self.pending_update_fee {
4518 if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
4519 debug_assert!(!self.is_outbound());
4520 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4521 self.feerate_per_kw = feerate;
4522 self.pending_update_fee = None;
4525 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4527 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4528 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4529 // Update state now that we've passed all the can-fail calls...
4530 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4531 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4532 (res, counterparty_commitment_tx, htlcs_no_ref)
4534 Err(e) => return Err(e),
4537 self.latest_monitor_update_id += 1;
4538 let monitor_update = ChannelMonitorUpdate {
4539 update_id: self.latest_monitor_update_id,
4540 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4541 commitment_txid: counterparty_commitment_txid,
4542 htlc_outputs: htlcs.clone(),
4543 commitment_number: self.cur_counterparty_commitment_transaction_number,
4544 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4547 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4548 Ok((res, monitor_update))
4551 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4552 /// when we shouldn't change HTLC/channel state.
4553 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4554 let counterparty_keys = self.build_remote_transaction_keys()?;
4555 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
4556 let feerate_per_kw = counterparty_commitment_tx.1;
4557 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4558 let (signature, htlc_signatures);
4560 #[cfg(any(test, feature = "fuzztarget"))]
4562 if !self.is_outbound() {
4563 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4564 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4565 if let Some(info) = projected_commit_tx_info {
4566 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4567 if info.total_pending_htlcs == total_pending_htlcs
4568 && info.next_holder_htlc_id == self.next_holder_htlc_id
4569 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4570 && info.feerate == self.feerate_per_kw {
4571 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.2);
4572 assert_eq!(actual_fee, info.fee);
4579 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.3.len());
4580 for &(ref htlc, _) in counterparty_commitment_tx.3.iter() {
4584 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4585 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4587 htlc_signatures = res.1;
4589 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4590 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4591 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4592 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4594 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4595 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4596 encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
4597 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4598 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4599 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4603 Ok((msgs::CommitmentSigned {
4604 channel_id: self.channel_id,
4607 }, (counterparty_commitment_txid, counterparty_commitment_tx.3)))
4610 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4611 /// to send to the remote peer in one go.
4612 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4614 pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
4615 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4616 Some(update_add_htlc) => {
4617 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4618 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4624 /// Get forwarding information for the counterparty.
4625 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4626 self.counterparty_forwarding_info.clone()
4629 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4630 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4631 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4633 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4634 fee_base_msat: msg.contents.fee_base_msat,
4635 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4636 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4642 /// Begins the shutdown process, getting a message for the remote peer and returning all
4643 /// holding cell HTLCs for payment failure.
4644 pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures) -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
4645 where K::Target: KeysInterface<Signer = Signer> {
4646 for htlc in self.pending_outbound_htlcs.iter() {
4647 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4648 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4651 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4652 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4653 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4655 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4656 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4659 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4660 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4661 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?".to_owned()});
4664 let update_shutdown_script = match self.shutdown_scriptpubkey {
4667 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
4668 if !shutdown_scriptpubkey.is_compatible(their_features) {
4669 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
4671 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4676 // From here on out, we may not fail!
4677 if self.channel_state < ChannelState::FundingSent as u32 {
4678 self.channel_state = ChannelState::ShutdownComplete as u32;
4680 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4682 self.update_time_counter += 1;
4684 let monitor_update = if update_shutdown_script {
4685 self.latest_monitor_update_id += 1;
4686 Some(ChannelMonitorUpdate {
4687 update_id: self.latest_monitor_update_id,
4688 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4689 scriptpubkey: self.get_closing_scriptpubkey(),
4693 let shutdown = msgs::Shutdown {
4694 channel_id: self.channel_id,
4695 scriptpubkey: self.get_closing_scriptpubkey(),
4698 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4699 // our shutdown until we've committed all of the pending changes.
4700 self.holding_cell_update_fee = None;
4701 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4702 self.holding_cell_htlc_updates.retain(|htlc_update| {
4704 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4705 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4712 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4715 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4716 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4717 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4718 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4719 /// immediately (others we will have to allow to time out).
4720 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4721 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4722 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4723 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4724 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4725 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4727 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4728 // return them to fail the payment.
4729 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4730 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4732 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4733 dropped_outbound_htlcs.push((source, payment_hash));
4738 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4739 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4740 // returning a channel monitor update here would imply a channel monitor update before
4741 // we even registered the channel monitor to begin with, which is invalid.
4742 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4743 // funding transaction, don't return a funding txo (which prevents providing the
4744 // monitor update to the user, even if we return one).
4745 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4746 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4747 self.latest_monitor_update_id += 1;
4748 Some((funding_txo, ChannelMonitorUpdate {
4749 update_id: self.latest_monitor_update_id,
4750 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4755 self.channel_state = ChannelState::ShutdownComplete as u32;
4756 self.update_time_counter += 1;
4757 (monitor_update, dropped_outbound_htlcs)
4761 const SERIALIZATION_VERSION: u8 = 2;
4762 const MIN_SERIALIZATION_VERSION: u8 = 1;
4764 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4770 impl Writeable for ChannelUpdateStatus {
4771 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4772 // We only care about writing out the current state as it was announced, ie only either
4773 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4774 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4776 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4777 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4778 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4779 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4785 impl Readable for ChannelUpdateStatus {
4786 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4787 Ok(match <u8 as Readable>::read(reader)? {
4788 0 => ChannelUpdateStatus::Enabled,
4789 1 => ChannelUpdateStatus::Disabled,
4790 _ => return Err(DecodeError::InvalidValue),
4795 impl<Signer: Sign> Writeable for Channel<Signer> {
4796 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4797 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4800 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4802 self.user_id.write(writer)?;
4804 // Write out the old serialization for the config object. This is read by version-1
4805 // deserializers, but we will read the version in the TLV at the end instead.
4806 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4807 self.config.cltv_expiry_delta.write(writer)?;
4808 self.config.announced_channel.write(writer)?;
4809 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4811 self.channel_id.write(writer)?;
4812 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4813 self.channel_value_satoshis.write(writer)?;
4815 self.latest_monitor_update_id.write(writer)?;
4817 let mut key_data = VecWriter(Vec::new());
4818 self.holder_signer.write(&mut key_data)?;
4819 assert!(key_data.0.len() < core::usize::MAX);
4820 assert!(key_data.0.len() < core::u32::MAX as usize);
4821 (key_data.0.len() as u32).write(writer)?;
4822 writer.write_all(&key_data.0[..])?;
4824 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4825 // deserialized from that format.
4826 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4827 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4828 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4830 self.destination_script.write(writer)?;
4832 self.cur_holder_commitment_transaction_number.write(writer)?;
4833 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4834 self.value_to_self_msat.write(writer)?;
4836 let mut dropped_inbound_htlcs = 0;
4837 for htlc in self.pending_inbound_htlcs.iter() {
4838 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4839 dropped_inbound_htlcs += 1;
4842 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4843 for htlc in self.pending_inbound_htlcs.iter() {
4844 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4847 htlc.htlc_id.write(writer)?;
4848 htlc.amount_msat.write(writer)?;
4849 htlc.cltv_expiry.write(writer)?;
4850 htlc.payment_hash.write(writer)?;
4852 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4853 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4855 htlc_state.write(writer)?;
4857 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4859 htlc_state.write(writer)?;
4861 &InboundHTLCState::Committed => {
4864 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4866 removal_reason.write(writer)?;
4871 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4872 for htlc in self.pending_outbound_htlcs.iter() {
4873 htlc.htlc_id.write(writer)?;
4874 htlc.amount_msat.write(writer)?;
4875 htlc.cltv_expiry.write(writer)?;
4876 htlc.payment_hash.write(writer)?;
4877 htlc.source.write(writer)?;
4879 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4881 onion_packet.write(writer)?;
4883 &OutboundHTLCState::Committed => {
4886 &OutboundHTLCState::RemoteRemoved(_) => {
4887 // Treat this as a Committed because we haven't received the CS - they'll
4888 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
4891 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4893 fail_reason.write(writer)?;
4895 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4897 fail_reason.write(writer)?;
4902 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4903 for update in self.holding_cell_htlc_updates.iter() {
4905 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4907 amount_msat.write(writer)?;
4908 cltv_expiry.write(writer)?;
4909 payment_hash.write(writer)?;
4910 source.write(writer)?;
4911 onion_routing_packet.write(writer)?;
4913 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4915 payment_preimage.write(writer)?;
4916 htlc_id.write(writer)?;
4918 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4920 htlc_id.write(writer)?;
4921 err_packet.write(writer)?;
4926 match self.resend_order {
4927 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4928 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4931 self.monitor_pending_funding_locked.write(writer)?;
4932 self.monitor_pending_revoke_and_ack.write(writer)?;
4933 self.monitor_pending_commitment_signed.write(writer)?;
4935 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4936 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4937 pending_forward.write(writer)?;
4938 htlc_id.write(writer)?;
4941 (self.monitor_pending_failures.len() as u64).write(writer)?;
4942 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4943 htlc_source.write(writer)?;
4944 payment_hash.write(writer)?;
4945 fail_reason.write(writer)?;
4948 if self.is_outbound() {
4949 self.pending_update_fee.map(|(a, _)| a).write(writer)?;
4950 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
4951 // As for inbound HTLCs, if the update was only announced and never committed, drop it.
4952 Some(feerate).write(writer)?;
4954 None::<u32>.write(writer)?;
4956 self.holding_cell_update_fee.write(writer)?;
4958 self.next_holder_htlc_id.write(writer)?;
4959 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4960 self.update_time_counter.write(writer)?;
4961 self.feerate_per_kw.write(writer)?;
4963 match self.last_sent_closing_fee {
4964 Some((feerate, fee, sig)) => {
4966 feerate.write(writer)?;
4970 None => 0u8.write(writer)?,
4973 self.funding_tx_confirmed_in.write(writer)?;
4974 self.funding_tx_confirmation_height.write(writer)?;
4975 self.short_channel_id.write(writer)?;
4977 self.counterparty_dust_limit_satoshis.write(writer)?;
4978 self.holder_dust_limit_satoshis.write(writer)?;
4979 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4981 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4982 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
4984 self.counterparty_htlc_minimum_msat.write(writer)?;
4985 self.holder_htlc_minimum_msat.write(writer)?;
4986 self.counterparty_max_accepted_htlcs.write(writer)?;
4988 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4989 self.minimum_depth.unwrap_or(0).write(writer)?;
4991 match &self.counterparty_forwarding_info {
4994 info.fee_base_msat.write(writer)?;
4995 info.fee_proportional_millionths.write(writer)?;
4996 info.cltv_expiry_delta.write(writer)?;
4998 None => 0u8.write(writer)?
5001 self.channel_transaction_parameters.write(writer)?;
5002 self.funding_transaction.write(writer)?;
5004 self.counterparty_cur_commitment_point.write(writer)?;
5005 self.counterparty_prev_commitment_point.write(writer)?;
5006 self.counterparty_node_id.write(writer)?;
5008 self.counterparty_shutdown_scriptpubkey.write(writer)?;
5010 self.commitment_secrets.write(writer)?;
5012 self.channel_update_status.write(writer)?;
5014 #[cfg(any(test, feature = "fuzztarget"))]
5015 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
5016 #[cfg(any(test, feature = "fuzztarget"))]
5017 for htlc in self.historical_inbound_htlc_fulfills.iter() {
5018 htlc.write(writer)?;
5021 write_tlv_fields!(writer, {
5022 (0, self.announcement_sigs, option),
5023 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
5024 // default value instead of being Option<>al. Thus, to maintain compatibility we write
5025 // them twice, once with their original default values above, and once as an option
5026 // here. On the read side, old versions will simply ignore the odd-type entries here,
5027 // and new versions map the default values to None and allow the TLV entries here to
5029 (1, self.minimum_depth, option),
5030 (3, self.counterparty_selected_channel_reserve_satoshis, option),
5031 (5, self.config, required),
5032 (7, self.shutdown_scriptpubkey, option),
5039 const MAX_ALLOC_SIZE: usize = 64*1024;
5040 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
5041 where K::Target: KeysInterface<Signer = Signer> {
5042 fn read<R : io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
5043 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5045 let user_id = Readable::read(reader)?;
5047 let mut config = Some(ChannelConfig::default());
5049 // Read the old serialization of the ChannelConfig from version 0.0.98.
5050 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
5051 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
5052 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5053 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5055 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
5056 let mut _val: u64 = Readable::read(reader)?;
5059 let channel_id = Readable::read(reader)?;
5060 let channel_state = Readable::read(reader)?;
5061 let channel_value_satoshis = Readable::read(reader)?;
5063 let latest_monitor_update_id = Readable::read(reader)?;
5065 let keys_len: u32 = Readable::read(reader)?;
5066 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
5067 while keys_data.len() != keys_len as usize {
5068 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
5069 let mut data = [0; 1024];
5070 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
5071 reader.read_exact(read_slice)?;
5072 keys_data.extend_from_slice(read_slice);
5074 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
5076 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
5077 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
5078 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
5081 let destination_script = Readable::read(reader)?;
5083 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
5084 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
5085 let value_to_self_msat = Readable::read(reader)?;
5087 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
5088 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5089 for _ in 0..pending_inbound_htlc_count {
5090 pending_inbound_htlcs.push(InboundHTLCOutput {
5091 htlc_id: Readable::read(reader)?,
5092 amount_msat: Readable::read(reader)?,
5093 cltv_expiry: Readable::read(reader)?,
5094 payment_hash: Readable::read(reader)?,
5095 state: match <u8 as Readable>::read(reader)? {
5096 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
5097 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
5098 3 => InboundHTLCState::Committed,
5099 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
5100 _ => return Err(DecodeError::InvalidValue),
5105 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
5106 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5107 for _ in 0..pending_outbound_htlc_count {
5108 pending_outbound_htlcs.push(OutboundHTLCOutput {
5109 htlc_id: Readable::read(reader)?,
5110 amount_msat: Readable::read(reader)?,
5111 cltv_expiry: Readable::read(reader)?,
5112 payment_hash: Readable::read(reader)?,
5113 source: Readable::read(reader)?,
5114 state: match <u8 as Readable>::read(reader)? {
5115 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
5116 1 => OutboundHTLCState::Committed,
5117 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
5118 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
5119 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
5120 _ => return Err(DecodeError::InvalidValue),
5125 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
5126 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
5127 for _ in 0..holding_cell_htlc_update_count {
5128 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
5129 0 => HTLCUpdateAwaitingACK::AddHTLC {
5130 amount_msat: Readable::read(reader)?,
5131 cltv_expiry: Readable::read(reader)?,
5132 payment_hash: Readable::read(reader)?,
5133 source: Readable::read(reader)?,
5134 onion_routing_packet: Readable::read(reader)?,
5136 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
5137 payment_preimage: Readable::read(reader)?,
5138 htlc_id: Readable::read(reader)?,
5140 2 => HTLCUpdateAwaitingACK::FailHTLC {
5141 htlc_id: Readable::read(reader)?,
5142 err_packet: Readable::read(reader)?,
5144 _ => return Err(DecodeError::InvalidValue),
5148 let resend_order = match <u8 as Readable>::read(reader)? {
5149 0 => RAACommitmentOrder::CommitmentFirst,
5150 1 => RAACommitmentOrder::RevokeAndACKFirst,
5151 _ => return Err(DecodeError::InvalidValue),
5154 let monitor_pending_funding_locked = Readable::read(reader)?;
5155 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
5156 let monitor_pending_commitment_signed = Readable::read(reader)?;
5158 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
5159 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
5160 for _ in 0..monitor_pending_forwards_count {
5161 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
5164 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
5165 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
5166 for _ in 0..monitor_pending_failures_count {
5167 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
5170 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
5172 let holding_cell_update_fee = Readable::read(reader)?;
5174 let next_holder_htlc_id = Readable::read(reader)?;
5175 let next_counterparty_htlc_id = Readable::read(reader)?;
5176 let update_time_counter = Readable::read(reader)?;
5177 let feerate_per_kw = Readable::read(reader)?;
5179 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
5181 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
5182 _ => return Err(DecodeError::InvalidValue),
5185 let funding_tx_confirmed_in = Readable::read(reader)?;
5186 let funding_tx_confirmation_height = Readable::read(reader)?;
5187 let short_channel_id = Readable::read(reader)?;
5189 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
5190 let holder_dust_limit_satoshis = Readable::read(reader)?;
5191 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
5192 let mut counterparty_selected_channel_reserve_satoshis = None;
5194 // Read the old serialization from version 0.0.98.
5195 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
5197 // Read the 8 bytes of backwards-compatibility data.
5198 let _dummy: u64 = Readable::read(reader)?;
5200 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
5201 let holder_htlc_minimum_msat = Readable::read(reader)?;
5202 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
5204 let mut minimum_depth = None;
5206 // Read the old serialization from version 0.0.98.
5207 minimum_depth = Some(Readable::read(reader)?);
5209 // Read the 4 bytes of backwards-compatibility data.
5210 let _dummy: u32 = Readable::read(reader)?;
5213 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5215 1 => Some(CounterpartyForwardingInfo {
5216 fee_base_msat: Readable::read(reader)?,
5217 fee_proportional_millionths: Readable::read(reader)?,
5218 cltv_expiry_delta: Readable::read(reader)?,
5220 _ => return Err(DecodeError::InvalidValue),
5223 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
5224 let funding_transaction = Readable::read(reader)?;
5226 let counterparty_cur_commitment_point = Readable::read(reader)?;
5228 let counterparty_prev_commitment_point = Readable::read(reader)?;
5229 let counterparty_node_id = Readable::read(reader)?;
5231 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5232 let commitment_secrets = Readable::read(reader)?;
5234 let channel_update_status = Readable::read(reader)?;
5236 #[cfg(any(test, feature = "fuzztarget"))]
5237 let mut historical_inbound_htlc_fulfills = HashSet::new();
5238 #[cfg(any(test, feature = "fuzztarget"))]
5240 let htlc_fulfills_len: u64 = Readable::read(reader)?;
5241 for _ in 0..htlc_fulfills_len {
5242 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5246 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
5247 Some((feerate, if channel_parameters.is_outbound_from_holder {
5248 FeeUpdateState::Outbound
5250 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
5256 let mut announcement_sigs = None;
5257 read_tlv_fields!(reader, {
5258 (0, announcement_sigs, option),
5259 (1, minimum_depth, option),
5260 (3, counterparty_selected_channel_reserve_satoshis, option),
5261 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5262 (7, shutdown_scriptpubkey, option),
5265 let mut secp_ctx = Secp256k1::new();
5266 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5271 config: config.unwrap(),
5275 channel_value_satoshis,
5277 latest_monitor_update_id,
5280 shutdown_scriptpubkey,
5283 cur_holder_commitment_transaction_number,
5284 cur_counterparty_commitment_transaction_number,
5287 pending_inbound_htlcs,
5288 pending_outbound_htlcs,
5289 holding_cell_htlc_updates,
5293 monitor_pending_funding_locked,
5294 monitor_pending_revoke_and_ack,
5295 monitor_pending_commitment_signed,
5296 monitor_pending_forwards,
5297 monitor_pending_failures,
5300 holding_cell_update_fee,
5301 next_holder_htlc_id,
5302 next_counterparty_htlc_id,
5303 update_time_counter,
5306 #[cfg(debug_assertions)]
5307 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5308 #[cfg(debug_assertions)]
5309 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5311 last_sent_closing_fee,
5313 funding_tx_confirmed_in,
5314 funding_tx_confirmation_height,
5317 counterparty_dust_limit_satoshis,
5318 holder_dust_limit_satoshis,
5319 counterparty_max_htlc_value_in_flight_msat,
5320 counterparty_selected_channel_reserve_satoshis,
5321 counterparty_htlc_minimum_msat,
5322 holder_htlc_minimum_msat,
5323 counterparty_max_accepted_htlcs,
5326 counterparty_forwarding_info,
5328 channel_transaction_parameters: channel_parameters,
5329 funding_transaction,
5331 counterparty_cur_commitment_point,
5332 counterparty_prev_commitment_point,
5333 counterparty_node_id,
5335 counterparty_shutdown_scriptpubkey,
5339 channel_update_status,
5343 #[cfg(any(test, feature = "fuzztarget"))]
5344 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5345 #[cfg(any(test, feature = "fuzztarget"))]
5346 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5348 workaround_lnd_bug_4006: None,
5350 #[cfg(any(test, feature = "fuzztarget"))]
5351 historical_inbound_htlc_fulfills,
5358 use bitcoin::util::bip143;
5359 use bitcoin::consensus::encode::serialize;
5360 use bitcoin::blockdata::script::{Script, Builder};
5361 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5362 use bitcoin::blockdata::constants::genesis_block;
5363 use bitcoin::blockdata::opcodes;
5364 use bitcoin::network::constants::Network;
5365 use bitcoin::hashes::hex::FromHex;
5367 use ln::{PaymentPreimage, PaymentHash};
5368 use ln::channelmanager::HTLCSource;
5369 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5370 use ln::channel::MAX_FUNDING_SATOSHIS;
5371 use ln::features::InitFeatures;
5372 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5373 use ln::script::ShutdownScript;
5375 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5376 use chain::BestBlock;
5377 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5378 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5379 use chain::transaction::OutPoint;
5380 use util::config::UserConfig;
5381 use util::enforcing_trait_impls::EnforcingSigner;
5382 use util::errors::APIError;
5383 use util::test_utils;
5384 use util::test_utils::OnGetShutdownScriptpubkey;
5385 use util::logger::Logger;
5386 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5387 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5388 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5389 use bitcoin::secp256k1::recovery::RecoverableSignature;
5390 use bitcoin::hashes::sha256::Hash as Sha256;
5391 use bitcoin::hashes::Hash;
5392 use bitcoin::hash_types::{Txid, WPubkeyHash};
5393 use core::num::NonZeroU8;
5397 struct TestFeeEstimator {
5400 impl FeeEstimator for TestFeeEstimator {
5401 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5407 fn test_max_funding_satoshis() {
5408 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5409 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5413 signer: InMemorySigner,
5415 impl KeysInterface for Keys {
5416 type Signer = InMemorySigner;
5418 fn get_node_secret(&self) -> SecretKey { panic!(); }
5419 fn get_destination_script(&self) -> Script {
5420 let secp_ctx = Secp256k1::signing_only();
5421 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5422 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5423 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5426 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5427 let secp_ctx = Secp256k1::signing_only();
5428 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5429 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5432 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5435 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5436 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5437 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5440 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5441 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5445 fn upfront_shutdown_script_incompatibility() {
5446 let features = InitFeatures::known().clear_shutdown_anysegwit();
5447 let non_v0_segwit_shutdown_script =
5448 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
5450 let seed = [42; 32];
5451 let network = Network::Testnet;
5452 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5453 keys_provider.expect(OnGetShutdownScriptpubkey {
5454 returns: non_v0_segwit_shutdown_script.clone(),
5457 let fee_estimator = TestFeeEstimator { fee_est: 253 };
5458 let secp_ctx = Secp256k1::new();
5459 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5460 let config = UserConfig::default();
5461 match Channel::<EnforcingSigner>::new_outbound(&&fee_estimator, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config) {
5462 Err(APIError::IncompatibleShutdownScript { script }) => {
5463 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
5465 Err(e) => panic!("Unexpected error: {:?}", e),
5466 Ok(_) => panic!("Expected error"),
5470 // Check that, during channel creation, we use the same feerate in the open channel message
5471 // as we do in the Channel object creation itself.
5473 fn test_open_channel_msg_fee() {
5474 let original_fee = 253;
5475 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5476 let secp_ctx = Secp256k1::new();
5477 let seed = [42; 32];
5478 let network = Network::Testnet;
5479 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5481 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5482 let config = UserConfig::default();
5483 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5485 // Now change the fee so we can check that the fee in the open_channel message is the
5486 // same as the old fee.
5487 fee_est.fee_est = 500;
5488 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5489 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5493 fn test_holder_vs_counterparty_dust_limit() {
5494 // Test that when calculating the local and remote commitment transaction fees, the correct
5495 // dust limits are used.
5496 let feeest = TestFeeEstimator{fee_est: 15000};
5497 let secp_ctx = Secp256k1::new();
5498 let seed = [42; 32];
5499 let network = Network::Testnet;
5500 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5502 // Go through the flow of opening a channel between two nodes, making sure
5503 // they have different dust limits.
5505 // Create Node A's channel pointing to Node B's pubkey
5506 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5507 let config = UserConfig::default();
5508 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5510 // Create Node B's channel by receiving Node A's open_channel message
5511 // Make sure A's dust limit is as we expect.
5512 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5513 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5514 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5516 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5517 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5518 accept_channel_msg.dust_limit_satoshis = 546;
5519 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5520 node_a_chan.holder_dust_limit_satoshis = 1560;
5522 // Put some inbound and outbound HTLCs in A's channel.
5523 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5524 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5526 amount_msat: htlc_amount_msat,
5527 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5528 cltv_expiry: 300000000,
5529 state: InboundHTLCState::Committed,
5532 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5534 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5535 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5536 cltv_expiry: 200000000,
5537 state: OutboundHTLCState::Committed,
5538 source: HTLCSource::OutboundRoute {
5540 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5541 first_hop_htlc_msat: 548,
5545 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5546 // the dust limit check.
5547 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5548 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5549 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5550 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5552 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5553 // of the HTLCs are seen to be above the dust limit.
5554 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5555 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5556 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5557 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5558 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5562 fn test_timeout_vs_success_htlc_dust_limit() {
5563 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5564 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5565 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5566 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5567 let fee_est = TestFeeEstimator{fee_est: 253 };
5568 let secp_ctx = Secp256k1::new();
5569 let seed = [42; 32];
5570 let network = Network::Testnet;
5571 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5573 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5574 let config = UserConfig::default();
5575 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5577 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5578 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5580 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5581 // counted as dust when it shouldn't be.
5582 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5583 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5584 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5585 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5587 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5588 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5589 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5590 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5591 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5593 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5595 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5596 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5597 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5598 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5599 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5601 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5602 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5603 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5604 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5605 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5609 fn channel_reestablish_no_updates() {
5610 let feeest = TestFeeEstimator{fee_est: 15000};
5611 let logger = test_utils::TestLogger::new();
5612 let secp_ctx = Secp256k1::new();
5613 let seed = [42; 32];
5614 let network = Network::Testnet;
5615 let best_block = BestBlock::from_genesis(network);
5616 let chain_hash = best_block.block_hash();
5617 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5619 // Go through the flow of opening a channel between two nodes.
5621 // Create Node A's channel pointing to Node B's pubkey
5622 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5623 let config = UserConfig::default();
5624 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5626 // Create Node B's channel by receiving Node A's open_channel message
5627 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5628 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5629 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5631 // Node B --> Node A: accept channel
5632 let accept_channel_msg = node_b_chan.get_accept_channel();
5633 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5635 // Node A --> Node B: funding created
5636 let output_script = node_a_chan.get_funding_redeemscript();
5637 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5638 value: 10000000, script_pubkey: output_script.clone(),
5640 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5641 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5642 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5644 // Node B --> Node A: funding signed
5645 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5647 // Now disconnect the two nodes and check that the commitment point in
5648 // Node B's channel_reestablish message is sane.
5649 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5650 let msg = node_b_chan.get_channel_reestablish(&&logger);
5651 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5652 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5653 match msg.data_loss_protect {
5654 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5655 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5660 // Check that the commitment point in Node A's channel_reestablish message
5662 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5663 let msg = node_a_chan.get_channel_reestablish(&&logger);
5664 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5665 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5666 match msg.data_loss_protect {
5667 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5668 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5675 fn channel_update() {
5676 let feeest = TestFeeEstimator{fee_est: 15000};
5677 let secp_ctx = Secp256k1::new();
5678 let seed = [42; 32];
5679 let network = Network::Testnet;
5680 let chain_hash = genesis_block(network).header.block_hash();
5681 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5683 // Create a channel.
5684 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5685 let config = UserConfig::default();
5686 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5687 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5688 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5689 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5691 // Make sure that receiving a channel update will update the Channel as expected.
5692 let update = ChannelUpdate {
5693 contents: UnsignedChannelUpdate {
5695 short_channel_id: 0,
5698 cltv_expiry_delta: 100,
5699 htlc_minimum_msat: 5,
5700 htlc_maximum_msat: OptionalField::Absent,
5702 fee_proportional_millionths: 11,
5703 excess_data: Vec::new(),
5705 signature: Signature::from(unsafe { FFISignature::new() })
5707 node_a_chan.channel_update(&update).unwrap();
5709 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5710 // change our official htlc_minimum_msat.
5711 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5712 match node_a_chan.counterparty_forwarding_info() {
5714 assert_eq!(info.cltv_expiry_delta, 100);
5715 assert_eq!(info.fee_base_msat, 110);
5716 assert_eq!(info.fee_proportional_millionths, 11);
5718 None => panic!("expected counterparty forwarding info to be Some")
5723 fn outbound_commitment_test() {
5724 // Test vectors from BOLT 3 Appendix C:
5725 let feeest = TestFeeEstimator{fee_est: 15000};
5726 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5727 let secp_ctx = Secp256k1::new();
5729 let mut signer = InMemorySigner::new(
5731 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5732 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5733 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5734 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5735 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5737 // These aren't set in the test vectors:
5738 [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],
5743 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5744 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5745 let keys_provider = Keys { signer: signer.clone() };
5747 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5748 let mut config = UserConfig::default();
5749 config.channel_options.announced_channel = false;
5750 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, &InitFeatures::known(), 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5751 chan.holder_dust_limit_satoshis = 546;
5752 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5754 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5756 let counterparty_pubkeys = ChannelPublicKeys {
5757 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5758 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5759 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5760 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5761 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5763 chan.channel_transaction_parameters.counterparty_parameters = Some(
5764 CounterpartyChannelTransactionParameters {
5765 pubkeys: counterparty_pubkeys.clone(),
5766 selected_contest_delay: 144
5768 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5769 signer.ready_channel(&chan.channel_transaction_parameters);
5771 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5772 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5774 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5775 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5777 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5778 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5780 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5781 // derived from a commitment_seed, so instead we copy it here and call
5782 // build_commitment_transaction.
5783 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5784 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5785 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5786 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5787 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5789 macro_rules! test_commitment {
5790 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5791 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5793 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5794 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
5796 let htlcs = res.3.drain(..)
5797 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5801 let trusted_tx = commitment_tx.trust();
5802 let unsigned_tx = trusted_tx.built_transaction();
5803 let redeemscript = chan.get_funding_redeemscript();
5804 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5805 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5806 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5808 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5809 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5810 let mut counterparty_htlc_sigs = Vec::new();
5811 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5813 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5814 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5815 counterparty_htlc_sigs.push(remote_signature);
5817 assert_eq!(htlcs.len(), per_htlc.len());
5819 let holder_commitment_tx = HolderCommitmentTransaction::new(
5820 commitment_tx.clone(),
5821 counterparty_signature,
5822 counterparty_htlc_sigs,
5823 &chan.holder_signer.pubkeys().funding_pubkey,
5824 chan.counterparty_funding_pubkey()
5826 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5827 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5829 let funding_redeemscript = chan.get_funding_redeemscript();
5830 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5831 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5833 // ((htlc, counterparty_sig), (index, holder_sig))
5834 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5837 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5839 let ref htlc = htlcs[$htlc_idx];
5840 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5841 chan.get_counterparty_selected_contest_delay().unwrap(),
5842 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5843 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5844 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5845 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5847 let mut preimage: Option<PaymentPreimage> = None;
5850 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5851 if out == htlc.payment_hash {
5852 preimage = Some(PaymentPreimage([i; 32]));
5856 assert!(preimage.is_some());
5859 let htlc_sig = htlc_sig_iter.next().unwrap();
5860 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5862 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5863 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5864 let index = (htlc_sig.1).0;
5865 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5866 let trusted_tx = holder_commitment_tx.trust();
5867 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5868 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5870 assert!(htlc_sig_iter.next().is_none());
5874 // simple commitment tx with no HTLCs
5875 chan.value_to_self_msat = 7000000000;
5877 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5878 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5879 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5881 chan.pending_inbound_htlcs.push({
5882 let mut out = InboundHTLCOutput{
5884 amount_msat: 1000000,
5886 payment_hash: PaymentHash([0; 32]),
5887 state: InboundHTLCState::Committed,
5889 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5892 chan.pending_inbound_htlcs.push({
5893 let mut out = InboundHTLCOutput{
5895 amount_msat: 2000000,
5897 payment_hash: PaymentHash([0; 32]),
5898 state: InboundHTLCState::Committed,
5900 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5903 chan.pending_outbound_htlcs.push({
5904 let mut out = OutboundHTLCOutput{
5906 amount_msat: 2000000,
5908 payment_hash: PaymentHash([0; 32]),
5909 state: OutboundHTLCState::Committed,
5910 source: HTLCSource::dummy(),
5912 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5915 chan.pending_outbound_htlcs.push({
5916 let mut out = OutboundHTLCOutput{
5918 amount_msat: 3000000,
5920 payment_hash: PaymentHash([0; 32]),
5921 state: OutboundHTLCState::Committed,
5922 source: HTLCSource::dummy(),
5924 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5927 chan.pending_inbound_htlcs.push({
5928 let mut out = InboundHTLCOutput{
5930 amount_msat: 4000000,
5932 payment_hash: PaymentHash([0; 32]),
5933 state: InboundHTLCState::Committed,
5935 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5939 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5940 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5941 chan.feerate_per_kw = 0;
5943 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5944 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5945 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5948 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5949 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5950 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5953 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5954 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5955 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5958 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5959 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5960 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5963 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5964 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5965 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5968 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5969 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5970 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5973 // commitment tx with seven outputs untrimmed (maximum feerate)
5974 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5975 chan.feerate_per_kw = 647;
5977 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5978 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5979 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5982 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5983 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5984 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5987 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5988 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5989 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5992 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5993 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5994 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5997 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5998 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5999 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6002 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
6003 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
6004 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6007 // commitment tx with six outputs untrimmed (minimum feerate)
6008 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6009 chan.feerate_per_kw = 648;
6011 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
6012 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
6013 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6016 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
6017 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
6018 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6021 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
6022 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
6023 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6026 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
6027 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
6028 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6031 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
6032 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
6033 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6036 // commitment tx with six outputs untrimmed (maximum feerate)
6037 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6038 chan.feerate_per_kw = 2069;
6040 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
6041 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
6042 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6045 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
6046 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
6047 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6050 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
6051 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
6052 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6055 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
6056 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
6057 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6060 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
6061 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
6062 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6065 // commitment tx with five outputs untrimmed (minimum feerate)
6066 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6067 chan.feerate_per_kw = 2070;
6069 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
6070 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
6071 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6074 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
6075 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
6076 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6079 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
6080 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
6081 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6084 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
6085 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
6086 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6089 // commitment tx with five outputs untrimmed (maximum feerate)
6090 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6091 chan.feerate_per_kw = 2194;
6093 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
6094 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
6095 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6098 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
6099 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
6100 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6103 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
6104 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
6105 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6108 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
6109 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
6110 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6113 // commitment tx with four outputs untrimmed (minimum feerate)
6114 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6115 chan.feerate_per_kw = 2195;
6117 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
6118 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
6119 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6122 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
6123 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
6124 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6127 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
6128 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
6129 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6132 // commitment tx with four outputs untrimmed (maximum feerate)
6133 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6134 chan.feerate_per_kw = 3702;
6136 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
6137 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
6138 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6141 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
6142 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
6143 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6146 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
6147 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
6148 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6151 // commitment tx with three outputs untrimmed (minimum feerate)
6152 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6153 chan.feerate_per_kw = 3703;
6155 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
6156 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
6157 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6160 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
6161 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
6162 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6165 // commitment tx with three outputs untrimmed (maximum feerate)
6166 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6167 chan.feerate_per_kw = 4914;
6169 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
6170 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
6171 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6174 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
6175 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
6176 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6179 // commitment tx with two outputs untrimmed (minimum feerate)
6180 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6181 chan.feerate_per_kw = 4915;
6183 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
6184 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
6185 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6187 // commitment tx with two outputs untrimmed (maximum feerate)
6188 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6189 chan.feerate_per_kw = 9651180;
6191 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
6192 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
6193 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6195 // commitment tx with one output untrimmed (minimum feerate)
6196 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6197 chan.feerate_per_kw = 9651181;
6199 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6200 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6201 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6203 // commitment tx with fee greater than funder amount
6204 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6205 chan.feerate_per_kw = 9651936;
6207 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6208 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6209 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6211 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
6212 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
6213 chan.feerate_per_kw = 253;
6214 chan.pending_inbound_htlcs.clear();
6215 chan.pending_inbound_htlcs.push({
6216 let mut out = InboundHTLCOutput{
6218 amount_msat: 2000000,
6220 payment_hash: PaymentHash([0; 32]),
6221 state: InboundHTLCState::Committed,
6223 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6226 chan.pending_outbound_htlcs.clear();
6227 chan.pending_outbound_htlcs.push({
6228 let mut out = OutboundHTLCOutput{
6230 amount_msat: 5000000,
6232 payment_hash: PaymentHash([0; 32]),
6233 state: OutboundHTLCState::Committed,
6234 source: HTLCSource::dummy(),
6236 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6239 chan.pending_outbound_htlcs.push({
6240 let mut out = OutboundHTLCOutput{
6242 amount_msat: 5000000,
6244 payment_hash: PaymentHash([0; 32]),
6245 state: OutboundHTLCState::Committed,
6246 source: HTLCSource::dummy(),
6248 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6252 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6253 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6254 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6257 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6258 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6259 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6261 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6262 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6263 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6265 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6266 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6267 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6272 fn test_per_commitment_secret_gen() {
6273 // Test vectors from BOLT 3 Appendix D:
6275 let mut seed = [0; 32];
6276 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6277 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6278 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6280 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6281 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6282 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6284 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6285 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6287 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6288 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6290 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6291 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6292 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6296 fn test_key_derivation() {
6297 // Test vectors from BOLT 3 Appendix E:
6298 let secp_ctx = Secp256k1::new();
6300 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6301 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6303 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6304 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6306 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6307 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6309 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6310 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6312 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6313 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6315 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6316 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6318 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6319 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());