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::{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, ChannelTypeFeatures, InitFeatures};
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::{self, ShutdownScript};
30 use ln::channelmanager::{CounterpartyForwardingInfo, 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, ClosingTransaction};
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, LATENCY_GRACE_PERIOD_BLOCKS};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::events::ClosureReason;
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};
49 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
51 use bitcoin::hashes::hex::ToHex;
54 pub struct ChannelValueStat {
55 pub value_to_self_msat: u64,
56 pub channel_value_msat: u64,
57 pub channel_reserve_msat: u64,
58 pub pending_outbound_htlcs_amount_msat: u64,
59 pub pending_inbound_htlcs_amount_msat: u64,
60 pub holding_cell_outbound_amount_msat: u64,
61 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
62 pub counterparty_dust_limit_msat: u64,
65 #[derive(Debug, Clone, Copy, PartialEq)]
67 // Inbound states mirroring InboundHTLCState
69 AwaitingRemoteRevokeToAnnounce,
70 // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
71 // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
72 // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
73 // the fee update anywhere, we can simply consider the fee update `Committed` immediately
74 // instead of setting it to AwaitingAnnouncedRemoteRevoke.
76 // Outbound state can only be `LocalAnnounced` or `Committed`
80 enum InboundHTLCRemovalReason {
81 FailRelay(msgs::OnionErrorPacket),
82 FailMalformed(([u8; 32], u16)),
83 Fulfill(PaymentPreimage),
86 enum InboundHTLCState {
87 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
88 /// update_add_htlc message for this HTLC.
89 RemoteAnnounced(PendingHTLCStatus),
90 /// Included in a received commitment_signed message (implying we've
91 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
92 /// state (see the example below). We have not yet included this HTLC in a
93 /// commitment_signed message because we are waiting on the remote's
94 /// aforementioned state revocation. One reason this missing remote RAA
95 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
96 /// is because every time we create a new "state", i.e. every time we sign a
97 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
98 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
99 /// sent provided the per_commitment_point for our current commitment tx.
100 /// The other reason we should not send a commitment_signed without their RAA
101 /// is because their RAA serves to ACK our previous commitment_signed.
103 /// Here's an example of how an HTLC could come to be in this state:
104 /// remote --> update_add_htlc(prev_htlc) --> local
105 /// remote --> commitment_signed(prev_htlc) --> local
106 /// remote <-- revoke_and_ack <-- local
107 /// remote <-- commitment_signed(prev_htlc) <-- local
108 /// [note that here, the remote does not respond with a RAA]
109 /// remote --> update_add_htlc(this_htlc) --> local
110 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
111 /// Now `this_htlc` will be assigned this state. It's unable to be officially
112 /// accepted, i.e. included in a commitment_signed, because we're missing the
113 /// RAA that provides our next per_commitment_point. The per_commitment_point
114 /// is used to derive commitment keys, which are used to construct the
115 /// signatures in a commitment_signed message.
116 /// Implies AwaitingRemoteRevoke.
118 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
119 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
120 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
121 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
122 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
123 /// channel (before it can then get forwarded and/or removed).
124 /// Implies AwaitingRemoteRevoke.
125 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
127 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
128 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
130 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
131 /// commitment transaction without it as otherwise we'll have to force-close the channel to
132 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
133 /// anyway). That said, ChannelMonitor does this for us (see
134 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
135 /// our own local state before then, once we're sure that the next commitment_signed and
136 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
137 LocalRemoved(InboundHTLCRemovalReason),
140 struct InboundHTLCOutput {
144 payment_hash: PaymentHash,
145 state: InboundHTLCState,
148 enum OutboundHTLCState {
149 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
150 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
151 /// we will promote to Committed (note that they may not accept it until the next time we
152 /// revoke, but we don't really care about that:
153 /// * they've revoked, so worst case we can announce an old state and get our (option on)
154 /// money back (though we won't), and,
155 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
156 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
157 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
158 /// we'll never get out of sync).
159 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
160 /// OutboundHTLCOutput's size just for a temporary bit
161 LocalAnnounced(Box<msgs::OnionPacket>),
163 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
164 /// the change (though they'll need to revoke before we fail the payment).
165 RemoteRemoved(Option<HTLCFailReason>),
166 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
167 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
168 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
169 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
170 /// remote revoke_and_ack on a previous state before we can do so.
171 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
172 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
173 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
174 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
175 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
176 /// revoke_and_ack to drop completely.
177 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
180 struct OutboundHTLCOutput {
184 payment_hash: PaymentHash,
185 state: OutboundHTLCState,
189 /// See AwaitingRemoteRevoke ChannelState for more info
190 enum HTLCUpdateAwaitingACK {
191 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
195 payment_hash: PaymentHash,
197 onion_routing_packet: msgs::OnionPacket,
200 payment_preimage: PaymentPreimage,
205 err_packet: msgs::OnionErrorPacket,
209 /// There are a few "states" and then a number of flags which can be applied:
210 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
211 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
212 /// move on to ChannelFunded.
213 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
214 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
215 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
217 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
218 OurInitSent = 1 << 0,
219 /// Implies we have received their open_channel/accept_channel message
220 TheirInitSent = 1 << 1,
221 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
222 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
223 /// upon receipt of funding_created, so simply skip this state.
225 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
226 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
227 /// and our counterparty consider the funding transaction confirmed.
229 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
230 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
231 TheirFundingLocked = 1 << 4,
232 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
233 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
234 OurFundingLocked = 1 << 5,
236 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
237 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
239 PeerDisconnected = 1 << 7,
240 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
241 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
242 /// outbound messages until they've managed to do so.
243 MonitorUpdateFailed = 1 << 8,
244 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
245 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
246 /// messages as then we will be unable to determine which HTLCs they included in their
247 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
249 /// Flag is set on ChannelFunded.
250 AwaitingRemoteRevoke = 1 << 9,
251 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
252 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
253 /// to respond with our own shutdown message when possible.
254 RemoteShutdownSent = 1 << 10,
255 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
256 /// point, we may not add any new HTLCs to the channel.
257 LocalShutdownSent = 1 << 11,
258 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
259 /// to drop us, but we store this anyway.
260 ShutdownComplete = 4096,
262 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
263 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
265 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
267 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
268 /// our counterparty or not. However, we don't want to announce updates right away to avoid
269 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
270 /// our channel_update message and track the current state here.
271 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
272 #[derive(Clone, Copy, PartialEq)]
273 pub(super) enum ChannelUpdateStatus {
274 /// We've announced the channel as enabled and are connected to our peer.
276 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
278 /// Our channel is live again, but we haven't announced the channel as enabled yet.
280 /// We've announced the channel as disabled.
284 /// An enum indicating whether the local or remote side offered a given HTLC.
290 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
293 pending_htlcs_value_msat: u64,
294 on_counterparty_tx_dust_exposure_msat: u64,
295 on_holder_tx_dust_exposure_msat: u64,
296 holding_cell_msat: u64,
297 on_holder_tx_holding_cell_htlcs_count: u32, // dust HTLCs *non*-included
300 /// An enum gathering stats on commitment transaction, either local or remote.
301 struct CommitmentStats<'a> {
302 tx: CommitmentTransaction, // the transaction info
303 feerate_per_kw: u32, // the feerate included to build the transaction
304 total_fee_sat: u64, // the total fee included in the transaction
305 num_nondust_htlcs: usize, // the number of HTLC outputs (dust HTLCs *non*-included)
306 htlcs_included: Vec<(HTLCOutputInCommitment, Option<&'a HTLCSource>)>, // the list of HTLCs (dust HTLCs *included*) which were not ignored when building the transaction
307 local_balance_msat: u64, // local balance before fees but considering dust limits
308 remote_balance_msat: u64, // remote balance before fees but considering dust limits
311 /// Used when calculating whether we or the remote can afford an additional HTLC.
312 struct HTLCCandidate {
314 origin: HTLCInitiator,
318 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
326 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
328 enum UpdateFulfillFetch {
330 monitor_update: ChannelMonitorUpdate,
331 htlc_value_msat: u64,
332 msg: Option<msgs::UpdateFulfillHTLC>,
337 /// The return type of get_update_fulfill_htlc_and_commit.
338 pub enum UpdateFulfillCommitFetch {
339 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
340 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
341 /// previously placed in the holding cell (and has since been removed).
343 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
344 monitor_update: ChannelMonitorUpdate,
345 /// The value of the HTLC which was claimed, in msat.
346 htlc_value_msat: u64,
347 /// The update_fulfill message and commitment_signed message (if the claim was not placed
348 /// in the holding cell).
349 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
351 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
352 /// or has been forgotten (presumably previously claimed).
356 /// The return value of `revoke_and_ack` on success, primarily updates to other channels or HTLC
358 pub(super) struct RAAUpdates {
359 pub commitment_update: Option<msgs::CommitmentUpdate>,
360 pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
361 pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
362 pub finalized_claimed_htlcs: Vec<HTLCSource>,
363 pub monitor_update: ChannelMonitorUpdate,
364 pub holding_cell_failed_htlcs: Vec<(HTLCSource, PaymentHash)>,
367 /// The return value of `monitor_updating_restored`
368 pub(super) struct MonitorRestoreUpdates {
369 pub raa: Option<msgs::RevokeAndACK>,
370 pub commitment_update: Option<msgs::CommitmentUpdate>,
371 pub order: RAACommitmentOrder,
372 pub accepted_htlcs: Vec<(PendingHTLCInfo, u64)>,
373 pub failed_htlcs: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
374 pub finalized_claimed_htlcs: Vec<HTLCSource>,
375 pub funding_broadcastable: Option<Transaction>,
376 pub funding_locked: Option<msgs::FundingLocked>,
379 /// If the majority of the channels funds are to the fundee and the initiator holds only just
380 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
381 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
382 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
383 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
384 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
385 /// by this multiple without hitting this case, before sending.
386 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
387 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
388 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
389 /// leave the channel less usable as we hold a bigger reserve.
390 #[cfg(any(fuzzing, test))]
391 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
392 #[cfg(not(any(fuzzing, test)))]
393 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
395 /// If we fail to see a funding transaction confirmed on-chain within this many blocks after the
396 /// channel creation on an inbound channel, we simply force-close and move on.
397 /// This constant is the one suggested in BOLT 2.
398 pub(crate) const FUNDING_CONF_DEADLINE_BLOCKS: u32 = 2016;
400 /// In case of a concurrent update_add_htlc proposed by our counterparty, we might
401 /// not have enough balance value remaining to cover the onchain cost of this new
402 /// HTLC weight. If this happens, our counterparty fails the reception of our
403 /// commitment_signed including this new HTLC due to infringement on the channel
405 /// To prevent this case, we compute our outbound update_fee with an HTLC buffer of
406 /// size 2. However, if the number of concurrent update_add_htlc is higher, this still
407 /// leads to a channel force-close. Ultimately, this is an issue coming from the
408 /// design of LN state machines, allowing asynchronous updates.
409 pub(crate) const CONCURRENT_INBOUND_HTLC_FEE_BUFFER: u32 = 2;
411 /// When a channel is opened, we check that the funding amount is enough to pay for relevant
412 /// commitment transaction fees, with at least this many HTLCs present on the commitment
413 /// transaction (not counting the value of the HTLCs themselves).
414 pub(crate) const MIN_AFFORDABLE_HTLC_COUNT: usize = 4;
416 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
417 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
418 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
421 // Holder designates channel data owned for the benefice of the user client.
422 // Counterparty designates channel data owned by the another channel participant entity.
423 pub(super) struct Channel<Signer: Sign> {
424 #[cfg(any(test, feature = "_test_utils"))]
425 pub(crate) config: ChannelConfig,
426 #[cfg(not(any(test, feature = "_test_utils")))]
427 config: ChannelConfig,
431 channel_id: [u8; 32],
433 secp_ctx: Secp256k1<secp256k1::All>,
434 channel_value_satoshis: u64,
436 latest_monitor_update_id: u64,
438 holder_signer: Signer,
439 shutdown_scriptpubkey: Option<ShutdownScript>,
440 destination_script: Script,
442 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
443 // generation start at 0 and count up...this simplifies some parts of implementation at the
444 // cost of others, but should really just be changed.
446 cur_holder_commitment_transaction_number: u64,
447 cur_counterparty_commitment_transaction_number: u64,
448 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
449 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
450 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
451 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
453 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
454 /// need to ensure we resend them in the order we originally generated them. Note that because
455 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
456 /// sufficient to simply set this to the opposite of any message we are generating as we
457 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
458 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
460 resend_order: RAACommitmentOrder,
462 monitor_pending_funding_locked: bool,
463 monitor_pending_revoke_and_ack: bool,
464 monitor_pending_commitment_signed: bool,
465 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
466 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
467 monitor_pending_finalized_fulfills: Vec<HTLCSource>,
469 // pending_update_fee is filled when sending and receiving update_fee.
471 // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
472 // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
473 // generating new commitment transactions with exactly the same criteria as inbound/outbound
474 // HTLCs with similar state.
475 pending_update_fee: Option<(u32, FeeUpdateState)>,
476 // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
477 // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
478 // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
479 // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
480 // further `send_update_fee` calls, dropping the previous holding cell update entirely.
481 holding_cell_update_fee: Option<u32>,
482 next_holder_htlc_id: u64,
483 next_counterparty_htlc_id: u64,
486 /// The timestamp set on our latest `channel_update` message for this channel. It is updated
487 /// when the channel is updated in ways which may impact the `channel_update` message or when a
488 /// new block is received, ensuring it's always at least moderately close to the current real
490 update_time_counter: u32,
492 #[cfg(debug_assertions)]
493 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
494 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
495 #[cfg(debug_assertions)]
496 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
497 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
499 last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
500 target_closing_feerate_sats_per_kw: Option<u32>,
502 /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
503 /// update, we need to delay processing it until later. We do that here by simply storing the
504 /// closing_signed message and handling it in `maybe_propose_closing_signed`.
505 pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
507 /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
508 /// transaction. These are set once we reach `closing_negotiation_ready`.
510 pub(crate) closing_fee_limits: Option<(u64, u64)>,
512 closing_fee_limits: Option<(u64, u64)>,
514 /// The hash of the block in which the funding transaction was included.
515 funding_tx_confirmed_in: Option<BlockHash>,
516 funding_tx_confirmation_height: u32,
517 short_channel_id: Option<u64>,
518 /// Either the height at which this channel was created or the height at which it was last
519 /// serialized if it was serialized by versions prior to 0.0.103.
520 /// We use this to close if funding is never broadcasted.
521 channel_creation_height: u32,
523 counterparty_dust_limit_satoshis: u64,
526 pub(super) holder_dust_limit_satoshis: u64,
528 holder_dust_limit_satoshis: u64,
531 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
533 counterparty_max_htlc_value_in_flight_msat: u64,
536 pub(super) holder_max_htlc_value_in_flight_msat: u64,
538 holder_max_htlc_value_in_flight_msat: u64,
540 /// minimum channel reserve for self to maintain - set by them.
541 counterparty_selected_channel_reserve_satoshis: Option<u64>,
544 pub(super) holder_selected_channel_reserve_satoshis: u64,
546 holder_selected_channel_reserve_satoshis: u64,
548 counterparty_htlc_minimum_msat: u64,
549 holder_htlc_minimum_msat: u64,
551 pub counterparty_max_accepted_htlcs: u16,
553 counterparty_max_accepted_htlcs: u16,
554 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
555 minimum_depth: Option<u32>,
557 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
559 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
560 funding_transaction: Option<Transaction>,
562 counterparty_cur_commitment_point: Option<PublicKey>,
563 counterparty_prev_commitment_point: Option<PublicKey>,
564 counterparty_node_id: PublicKey,
566 counterparty_shutdown_scriptpubkey: Option<Script>,
568 commitment_secrets: CounterpartyCommitmentSecrets,
570 channel_update_status: ChannelUpdateStatus,
571 /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
572 /// not complete within a single timer tick (one minute), we should force-close the channel.
573 /// This prevents us from keeping unusable channels around forever if our counterparty wishes
575 /// Note that this field is reset to false on deserialization to give us a chance to connect to
576 /// our peer and start the closing_signed negotiation fresh.
577 closing_signed_in_flight: bool,
579 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
580 /// This can be used to rebroadcast the channel_announcement message later.
581 announcement_sigs: Option<(Signature, Signature)>,
583 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
584 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
585 // be, by comparing the cached values to the fee of the tranaction generated by
586 // `build_commitment_transaction`.
587 #[cfg(any(test, feature = "fuzztarget"))]
588 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
589 #[cfg(any(test, feature = "fuzztarget"))]
590 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
592 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
593 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
594 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
595 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
596 /// message until we receive a channel_reestablish.
598 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
599 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
601 #[cfg(any(test, feature = "fuzztarget"))]
602 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
603 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
604 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
605 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
606 // is fine, but as a sanity check in our failure to generate the second claim, we check here
607 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
608 historical_inbound_htlc_fulfills: HashSet<u64>,
610 /// This channel's type, as negotiated during channel open
611 channel_type: ChannelTypeFeatures,
614 #[cfg(any(test, feature = "fuzztarget"))]
615 struct CommitmentTxInfoCached {
617 total_pending_htlcs: usize,
618 next_holder_htlc_id: u64,
619 next_counterparty_htlc_id: u64,
623 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
625 pub(crate) fn commitment_tx_base_weight(opt_anchors: bool) -> u64 {
626 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
627 const COMMITMENT_TX_BASE_ANCHOR_WEIGHT: u64 = 1124;
628 if opt_anchors { COMMITMENT_TX_BASE_ANCHOR_WEIGHT } else { COMMITMENT_TX_BASE_WEIGHT }
632 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
634 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
636 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
638 /// Maximum `funding_satoshis` value, according to the BOLT #2 specification
640 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
642 /// The maximum network dust limit for standard script formats. This currently represents the
643 /// minimum output value for a P2SH output before Bitcoin Core 22 considers the entire
644 /// transaction non-standard and thus refuses to relay it.
645 /// We also use this as the maximum counterparty `dust_limit_satoshis` allowed, given many
646 /// implementations use this value for their dust limit today.
647 pub const MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS: u64 = 546;
649 /// The maximum channel dust limit we will accept from our counterparty.
650 pub const MAX_CHAN_DUST_LIMIT_SATOSHIS: u64 = MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS;
652 /// The dust limit is used for both the commitment transaction outputs as well as the closing
653 /// transactions. For cooperative closing transactions, we require segwit outputs, though accept
654 /// *any* segwit scripts, which are allowed to be up to 42 bytes in length.
655 /// In order to avoid having to concern ourselves with standardness during the closing process, we
656 /// simply require our counterparty to use a dust limit which will leave any segwit output
658 /// See https://github.com/lightningnetwork/lightning-rfc/issues/905 for more details.
659 pub const MIN_CHAN_DUST_LIMIT_SATOSHIS: u64 = 354;
661 /// Used to return a simple Error back to ChannelManager. Will get converted to a
662 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
663 /// channel_id in ChannelManager.
664 pub(super) enum ChannelError {
668 CloseDelayBroadcast(String),
671 impl fmt::Debug for ChannelError {
672 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
674 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
675 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
676 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
677 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
682 macro_rules! secp_check {
683 ($res: expr, $err: expr) => {
686 Err(_) => return Err(ChannelError::Close($err)),
691 impl<Signer: Sign> Channel<Signer> {
692 // Convert constants + channel value to limits:
693 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
694 channel_value_satoshis * 1000 / 10 //TODO
697 /// Returns a minimum channel reserve value the remote needs to maintain,
700 /// Guaranteed to return a value no larger than channel_value_satoshis
702 /// This is used both for new channels and to figure out what reserve value we sent to peers
703 /// for channels serialized before we included our selected reserve value in the serialized
705 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
706 let (q, _) = channel_value_satoshis.overflowing_div(100);
707 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
710 pub(crate) fn opt_anchors(&self) -> bool {
711 self.channel_transaction_parameters.opt_anchors.is_some()
715 pub fn new_outbound<K: Deref, F: Deref>(
716 fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures,
717 channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig, current_chain_height: u32
718 ) -> Result<Channel<Signer>, APIError>
719 where K::Target: KeysInterface<Signer = Signer>,
720 F::Target: FeeEstimator,
722 let opt_anchors = false; // TODO - should be based on features
724 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
725 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
726 let pubkeys = holder_signer.pubkeys().clone();
728 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
729 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
731 let channel_value_msat = channel_value_satoshis * 1000;
732 if push_msat > channel_value_msat {
733 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
735 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
736 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
738 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
739 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
740 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
743 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
745 let value_to_self_msat = channel_value_satoshis * 1000 - push_msat;
746 let commitment_tx_fee = Self::commit_tx_fee_msat(feerate, MIN_AFFORDABLE_HTLC_COUNT, opt_anchors);
747 if value_to_self_msat < commitment_tx_fee {
748 return Err(APIError::APIMisuseError{ err: format!("Funding amount ({}) can't even pay fee for initial commitment transaction fee of {}.", value_to_self_msat / 1000, commitment_tx_fee / 1000) });
751 let mut secp_ctx = Secp256k1::new();
752 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
754 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
755 Some(keys_provider.get_shutdown_scriptpubkey())
758 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
759 if !shutdown_scriptpubkey.is_compatible(&their_features) {
760 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
766 config: config.channel_options.clone(),
768 channel_id: keys_provider.get_secure_random_bytes(),
769 channel_state: ChannelState::OurInitSent as u32,
771 channel_value_satoshis,
773 latest_monitor_update_id: 0,
776 shutdown_scriptpubkey,
777 destination_script: keys_provider.get_destination_script(),
779 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
780 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
783 pending_inbound_htlcs: Vec::new(),
784 pending_outbound_htlcs: Vec::new(),
785 holding_cell_htlc_updates: Vec::new(),
786 pending_update_fee: None,
787 holding_cell_update_fee: None,
788 next_holder_htlc_id: 0,
789 next_counterparty_htlc_id: 0,
790 update_time_counter: 1,
792 resend_order: RAACommitmentOrder::CommitmentFirst,
794 monitor_pending_funding_locked: false,
795 monitor_pending_revoke_and_ack: false,
796 monitor_pending_commitment_signed: false,
797 monitor_pending_forwards: Vec::new(),
798 monitor_pending_failures: Vec::new(),
799 monitor_pending_finalized_fulfills: Vec::new(),
801 #[cfg(debug_assertions)]
802 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
803 #[cfg(debug_assertions)]
804 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
806 last_sent_closing_fee: None,
807 pending_counterparty_closing_signed: None,
808 closing_fee_limits: None,
809 target_closing_feerate_sats_per_kw: None,
811 funding_tx_confirmed_in: None,
812 funding_tx_confirmation_height: 0,
813 short_channel_id: None,
814 channel_creation_height: current_chain_height,
816 feerate_per_kw: feerate,
817 counterparty_dust_limit_satoshis: 0,
818 holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
819 counterparty_max_htlc_value_in_flight_msat: 0,
820 holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis),
821 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
822 holder_selected_channel_reserve_satoshis,
823 counterparty_htlc_minimum_msat: 0,
824 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
825 counterparty_max_accepted_htlcs: 0,
826 minimum_depth: None, // Filled in in accept_channel
828 counterparty_forwarding_info: None,
830 channel_transaction_parameters: ChannelTransactionParameters {
831 holder_pubkeys: pubkeys,
832 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
833 is_outbound_from_holder: true,
834 counterparty_parameters: None,
835 funding_outpoint: None,
836 opt_anchors: if opt_anchors { Some(()) } else { None },
838 funding_transaction: None,
840 counterparty_cur_commitment_point: None,
841 counterparty_prev_commitment_point: None,
842 counterparty_node_id,
844 counterparty_shutdown_scriptpubkey: None,
846 commitment_secrets: CounterpartyCommitmentSecrets::new(),
848 channel_update_status: ChannelUpdateStatus::Enabled,
849 closing_signed_in_flight: false,
851 announcement_sigs: None,
853 #[cfg(any(test, feature = "fuzztarget"))]
854 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
855 #[cfg(any(test, feature = "fuzztarget"))]
856 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
858 workaround_lnd_bug_4006: None,
860 #[cfg(any(test, feature = "fuzztarget"))]
861 historical_inbound_htlc_fulfills: HashSet::new(),
863 // We currently only actually support one channel type, so don't retry with new types
864 // on error messages. When we support more we'll need fallback support (assuming we
865 // want to support old types).
866 channel_type: ChannelTypeFeatures::only_static_remote_key(),
870 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
871 where F::Target: FeeEstimator
873 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
874 // Some fee estimators round up to the next full sat/vbyte (ie 250 sats per kw), causing
875 // occasional issues with feerate disagreements between an initiator that wants a feerate
876 // of 1.1 sat/vbyte and a receiver that wants 1.1 rounded up to 2. Thus, we always add 250
877 // sat/kw before the comparison here.
878 if feerate_per_kw + 250 < lower_limit {
879 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {} (- 250)", feerate_per_kw, lower_limit)));
881 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
882 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
883 // We generally don't care too much if they set the feerate to something very high, but it
884 // could result in the channel being useless due to everything being dust.
885 let upper_limit = cmp::max(250 * 25,
886 fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
887 if feerate_per_kw as u64 > upper_limit {
888 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
893 /// Creates a new channel from a remote sides' request for one.
894 /// Assumes chain_hash has already been checked and corresponds with what we expect!
895 pub fn new_from_req<K: Deref, F: Deref, L: Deref>(
896 fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures,
897 msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig, current_chain_height: u32, logger: &L
898 ) -> Result<Channel<Signer>, ChannelError>
899 where K::Target: KeysInterface<Signer = Signer>,
900 F::Target: FeeEstimator,
903 let opt_anchors = false; // TODO - should be based on features
905 // First check the channel type is known, failing before we do anything else if we don't
906 // support this channel type.
907 let channel_type = if let Some(channel_type) = &msg.channel_type {
908 if channel_type.supports_any_optional_bits() {
909 return Err(ChannelError::Close("Channel Type field contained optional bits - this is not allowed".to_owned()));
911 if *channel_type != ChannelTypeFeatures::only_static_remote_key() {
912 return Err(ChannelError::Close("Channel Type was not understood".to_owned()));
916 ChannelTypeFeatures::from_counterparty_init(&their_features)
918 if !channel_type.supports_static_remote_key() {
919 return Err(ChannelError::Close("Channel Type was not understood - we require static remote key".to_owned()));
922 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
923 let pubkeys = holder_signer.pubkeys().clone();
924 let counterparty_pubkeys = ChannelPublicKeys {
925 funding_pubkey: msg.funding_pubkey,
926 revocation_basepoint: msg.revocation_basepoint,
927 payment_point: msg.payment_point,
928 delayed_payment_basepoint: msg.delayed_payment_basepoint,
929 htlc_basepoint: msg.htlc_basepoint
931 let mut local_config = (*config).channel_options.clone();
933 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
934 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)));
937 // Check sanity of message fields:
938 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
939 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
941 if msg.channel_reserve_satoshis > msg.funding_satoshis {
942 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
944 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
945 if msg.push_msat > funding_value {
946 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
948 if msg.dust_limit_satoshis > msg.funding_satoshis {
949 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)));
951 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
952 if msg.htlc_minimum_msat >= full_channel_value_msat {
953 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
955 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
957 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
958 if msg.to_self_delay > max_counterparty_selected_contest_delay {
959 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)));
961 if msg.max_accepted_htlcs < 1 {
962 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
964 if msg.max_accepted_htlcs > MAX_HTLCS {
965 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
968 // Now check against optional parameters as set by config...
969 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
970 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)));
972 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
973 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)));
975 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
976 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)));
978 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
979 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)));
981 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
982 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)));
984 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
985 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
987 if msg.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
988 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
991 // Convert things into internal flags and prep our state:
993 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
994 if config.peer_channel_config_limits.force_announced_channel_preference {
995 if local_config.announced_channel != announce {
996 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
999 // we either accept their preference or the preferences match
1000 local_config.announced_channel = announce;
1002 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
1003 if holder_selected_channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1004 return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1006 if msg.channel_reserve_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1007 log_debug!(logger, "channel_reserve_satoshis ({}) is smaller than our dust limit ({}). We can broadcast stale states without any risk, implying this channel is very insecure for our counterparty.",
1008 msg.channel_reserve_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS);
1010 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
1011 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)));
1014 // check if the funder's amount for the initial commitment tx is sufficient
1015 // for full fee payment plus a few HTLCs to ensure the channel will be useful.
1016 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
1017 let commitment_tx_fee = Self::commit_tx_fee_msat(msg.feerate_per_kw, MIN_AFFORDABLE_HTLC_COUNT, opt_anchors) / 1000;
1018 if funders_amount_msat / 1000 < commitment_tx_fee {
1019 return Err(ChannelError::Close(format!("Funding amount ({} sats) can't even pay fee for initial commitment transaction fee of {} sats.", funders_amount_msat / 1000, commitment_tx_fee)));
1022 let to_remote_satoshis = funders_amount_msat / 1000 - commitment_tx_fee;
1023 // While it's reasonable for us to not meet the channel reserve initially (if they don't
1024 // want to push much to us), our counterparty should always have more than our reserve.
1025 if to_remote_satoshis < holder_selected_channel_reserve_satoshis {
1026 return Err(ChannelError::Close("Insufficient funding amount for initial reserve".to_owned()));
1029 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1030 match &msg.shutdown_scriptpubkey {
1031 &OptionalField::Present(ref script) => {
1032 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1033 if script.len() == 0 {
1036 if !script::is_bolt2_compliant(&script, their_features) {
1037 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)))
1039 Some(script.clone())
1042 // 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
1043 &OptionalField::Absent => {
1044 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()));
1049 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
1050 Some(keys_provider.get_shutdown_scriptpubkey())
1053 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
1054 if !shutdown_scriptpubkey.is_compatible(&their_features) {
1055 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
1059 let mut secp_ctx = Secp256k1::new();
1060 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
1062 let chan = Channel {
1064 config: local_config,
1066 channel_id: msg.temporary_channel_id,
1067 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
1070 latest_monitor_update_id: 0,
1073 shutdown_scriptpubkey,
1074 destination_script: keys_provider.get_destination_script(),
1076 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1077 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
1078 value_to_self_msat: msg.push_msat,
1080 pending_inbound_htlcs: Vec::new(),
1081 pending_outbound_htlcs: Vec::new(),
1082 holding_cell_htlc_updates: Vec::new(),
1083 pending_update_fee: None,
1084 holding_cell_update_fee: None,
1085 next_holder_htlc_id: 0,
1086 next_counterparty_htlc_id: 0,
1087 update_time_counter: 1,
1089 resend_order: RAACommitmentOrder::CommitmentFirst,
1091 monitor_pending_funding_locked: false,
1092 monitor_pending_revoke_and_ack: false,
1093 monitor_pending_commitment_signed: false,
1094 monitor_pending_forwards: Vec::new(),
1095 monitor_pending_failures: Vec::new(),
1096 monitor_pending_finalized_fulfills: Vec::new(),
1098 #[cfg(debug_assertions)]
1099 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1100 #[cfg(debug_assertions)]
1101 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
1103 last_sent_closing_fee: None,
1104 pending_counterparty_closing_signed: None,
1105 closing_fee_limits: None,
1106 target_closing_feerate_sats_per_kw: None,
1108 funding_tx_confirmed_in: None,
1109 funding_tx_confirmation_height: 0,
1110 short_channel_id: None,
1111 channel_creation_height: current_chain_height,
1113 feerate_per_kw: msg.feerate_per_kw,
1114 channel_value_satoshis: msg.funding_satoshis,
1115 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
1116 holder_dust_limit_satoshis: MIN_CHAN_DUST_LIMIT_SATOSHIS,
1117 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
1118 holder_max_htlc_value_in_flight_msat: Self::get_holder_max_htlc_value_in_flight_msat(msg.funding_satoshis),
1119 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
1120 holder_selected_channel_reserve_satoshis,
1121 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
1122 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
1123 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
1124 minimum_depth: Some(config.own_channel_config.minimum_depth),
1126 counterparty_forwarding_info: None,
1128 channel_transaction_parameters: ChannelTransactionParameters {
1129 holder_pubkeys: pubkeys,
1130 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
1131 is_outbound_from_holder: false,
1132 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1133 selected_contest_delay: msg.to_self_delay,
1134 pubkeys: counterparty_pubkeys,
1136 funding_outpoint: None,
1137 opt_anchors: if opt_anchors { Some(()) } else { None },
1139 funding_transaction: None,
1141 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
1142 counterparty_prev_commitment_point: None,
1143 counterparty_node_id,
1145 counterparty_shutdown_scriptpubkey,
1147 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1149 channel_update_status: ChannelUpdateStatus::Enabled,
1150 closing_signed_in_flight: false,
1152 announcement_sigs: None,
1154 #[cfg(any(test, feature = "fuzztarget"))]
1155 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1156 #[cfg(any(test, feature = "fuzztarget"))]
1157 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1159 workaround_lnd_bug_4006: None,
1161 #[cfg(any(test, feature = "fuzztarget"))]
1162 historical_inbound_htlc_fulfills: HashSet::new(),
1170 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1171 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1172 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1173 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1174 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1176 /// @local is used only to convert relevant internal structures which refer to remote vs local
1177 /// to decide value of outputs and direction of HTLCs.
1178 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1179 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1180 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1181 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1182 /// which peer generated this transaction and "to whom" this transaction flows.
1184 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> CommitmentStats
1185 where L::Target: Logger
1187 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1188 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1189 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1191 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1192 let mut remote_htlc_total_msat = 0;
1193 let mut local_htlc_total_msat = 0;
1194 let mut value_to_self_msat_offset = 0;
1196 let mut feerate_per_kw = self.feerate_per_kw;
1197 if let Some((feerate, update_state)) = self.pending_update_fee {
1198 if match update_state {
1199 // Note that these match the inclusion criteria when scanning
1200 // pending_inbound_htlcs below.
1201 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1202 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1203 FeeUpdateState::Outbound => { assert!(self.is_outbound()); generated_by_local },
1205 feerate_per_kw = feerate;
1209 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1210 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1211 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1212 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1214 macro_rules! get_htlc_in_commitment {
1215 ($htlc: expr, $offered: expr) => {
1216 HTLCOutputInCommitment {
1218 amount_msat: $htlc.amount_msat,
1219 cltv_expiry: $htlc.cltv_expiry,
1220 payment_hash: $htlc.payment_hash,
1221 transaction_output_index: None
1226 macro_rules! add_htlc_output {
1227 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1228 if $outbound == local { // "offered HTLC output"
1229 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1230 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1231 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);
1232 included_non_dust_htlcs.push((htlc_in_tx, $source));
1234 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);
1235 included_dust_htlcs.push((htlc_in_tx, $source));
1238 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1239 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1240 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);
1241 included_non_dust_htlcs.push((htlc_in_tx, $source));
1243 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);
1244 included_dust_htlcs.push((htlc_in_tx, $source));
1250 for ref htlc in self.pending_inbound_htlcs.iter() {
1251 let (include, state_name) = match htlc.state {
1252 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1253 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1254 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1255 InboundHTLCState::Committed => (true, "Committed"),
1256 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1260 add_htlc_output!(htlc, false, None, state_name);
1261 remote_htlc_total_msat += htlc.amount_msat;
1263 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);
1265 &InboundHTLCState::LocalRemoved(ref reason) => {
1266 if generated_by_local {
1267 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1268 value_to_self_msat_offset += htlc.amount_msat as i64;
1277 for ref htlc in self.pending_outbound_htlcs.iter() {
1278 let (include, state_name) = match htlc.state {
1279 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1280 OutboundHTLCState::Committed => (true, "Committed"),
1281 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1282 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1283 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1287 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1288 local_htlc_total_msat += htlc.amount_msat;
1290 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);
1292 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1293 value_to_self_msat_offset -= htlc.amount_msat as i64;
1295 OutboundHTLCState::RemoteRemoved(None) => {
1296 if !generated_by_local {
1297 value_to_self_msat_offset -= htlc.amount_msat as i64;
1305 let mut value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1306 assert!(value_to_self_msat >= 0);
1307 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1308 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1309 // "violate" their reserve value by couting those against it. Thus, we have to convert
1310 // everything to i64 before subtracting as otherwise we can overflow.
1311 let mut 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;
1312 assert!(value_to_remote_msat >= 0);
1314 #[cfg(debug_assertions)]
1316 // Make sure that the to_self/to_remote is always either past the appropriate
1317 // channel_reserve *or* it is making progress towards it.
1318 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1319 self.holder_max_commitment_tx_output.lock().unwrap()
1321 self.counterparty_max_commitment_tx_output.lock().unwrap()
1323 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);
1324 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1325 debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= self.holder_selected_channel_reserve_satoshis as i64);
1326 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1329 let total_fee_sat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, included_non_dust_htlcs.len(), self.channel_transaction_parameters.opt_anchors.is_some());
1330 let (value_to_self, value_to_remote) = if self.is_outbound() {
1331 (value_to_self_msat / 1000 - total_fee_sat as i64, value_to_remote_msat / 1000)
1333 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee_sat as i64)
1336 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1337 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1338 let (funding_pubkey_a, funding_pubkey_b) = if local {
1339 (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
1341 (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
1344 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1345 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1350 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1351 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1356 let num_nondust_htlcs = included_non_dust_htlcs.len();
1358 let channel_parameters =
1359 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1360 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1361 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1364 self.channel_transaction_parameters.opt_anchors.is_some(),
1369 &mut included_non_dust_htlcs,
1372 let mut htlcs_included = included_non_dust_htlcs;
1373 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1374 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1375 htlcs_included.append(&mut included_dust_htlcs);
1377 // For the stats, trimmed-to-0 the value in msats accordingly
1378 value_to_self_msat = if (value_to_self_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_self_msat };
1379 value_to_remote_msat = if (value_to_remote_msat * 1000) < broadcaster_dust_limit_satoshis as i64 { 0 } else { value_to_remote_msat };
1387 local_balance_msat: value_to_self_msat as u64,
1388 remote_balance_msat: value_to_remote_msat as u64,
1393 fn get_closing_scriptpubkey(&self) -> Script {
1394 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1395 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1396 // outside of those situations will fail.
1397 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1401 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1406 1 + // script length (0)
1410 )*4 + // * 4 for non-witness parts
1411 2 + // witness marker and flag
1412 1 + // witness element count
1413 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1414 self.get_funding_redeemscript().len() as u64 + // funding witness script
1415 2*(1 + 71); // two signatures + sighash type flags
1416 if let Some(spk) = a_scriptpubkey {
1417 ret += ((8+1) + // output values and script length
1418 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1420 if let Some(spk) = b_scriptpubkey {
1421 ret += ((8+1) + // output values and script length
1422 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1428 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
1429 assert!(self.pending_inbound_htlcs.is_empty());
1430 assert!(self.pending_outbound_htlcs.is_empty());
1431 assert!(self.pending_update_fee.is_none());
1433 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1434 let mut value_to_holder: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1435 let mut value_to_counterparty: 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 };
1437 if value_to_holder < 0 {
1438 assert!(self.is_outbound());
1439 total_fee_satoshis += (-value_to_holder) as u64;
1440 } else if value_to_counterparty < 0 {
1441 assert!(!self.is_outbound());
1442 total_fee_satoshis += (-value_to_counterparty) as u64;
1445 if skip_remote_output || value_to_counterparty as u64 <= self.holder_dust_limit_satoshis {
1446 value_to_counterparty = 0;
1449 if value_to_holder as u64 <= self.holder_dust_limit_satoshis {
1450 value_to_holder = 0;
1453 assert!(self.shutdown_scriptpubkey.is_some());
1454 let holder_shutdown_script = self.get_closing_scriptpubkey();
1455 let counterparty_shutdown_script = self.counterparty_shutdown_scriptpubkey.clone().unwrap();
1456 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
1458 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
1459 (closing_transaction, total_fee_satoshis)
1462 fn funding_outpoint(&self) -> OutPoint {
1463 self.channel_transaction_parameters.funding_outpoint.unwrap()
1467 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1468 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1469 /// our counterparty!)
1470 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1471 /// TODO Some magic rust shit to compile-time check this?
1472 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1473 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1474 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1475 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1476 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1478 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()))
1482 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1483 /// will sign and send to our counterparty.
1484 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1485 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1486 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1487 //may see payments to it!
1488 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1489 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1490 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1492 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()))
1495 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1496 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1497 /// Panics if called before accept_channel/new_from_req
1498 pub fn get_funding_redeemscript(&self) -> Script {
1499 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1502 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1503 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1504 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1505 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1507 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1508 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1510 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1512 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1514 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1515 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1516 // these, but for now we just have to treat them as normal.
1518 let mut pending_idx = core::usize::MAX;
1519 let mut htlc_value_msat = 0;
1520 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1521 if htlc.htlc_id == htlc_id_arg {
1522 assert_eq!(htlc.payment_hash, payment_hash_calc);
1524 InboundHTLCState::Committed => {},
1525 InboundHTLCState::LocalRemoved(ref reason) => {
1526 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1528 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()));
1529 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1531 return UpdateFulfillFetch::DuplicateClaim {};
1534 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1535 // Don't return in release mode here so that we can update channel_monitor
1539 htlc_value_msat = htlc.amount_msat;
1543 if pending_idx == core::usize::MAX {
1544 #[cfg(any(test, feature = "fuzztarget"))]
1545 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1546 // this is simply a duplicate claim, not previously failed and we lost funds.
1547 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1548 return UpdateFulfillFetch::DuplicateClaim {};
1551 // Now update local state:
1553 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1554 // can claim it even if the channel hits the chain before we see their next commitment.
1555 self.latest_monitor_update_id += 1;
1556 let monitor_update = ChannelMonitorUpdate {
1557 update_id: self.latest_monitor_update_id,
1558 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1559 payment_preimage: payment_preimage_arg.clone(),
1563 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1564 for pending_update in self.holding_cell_htlc_updates.iter() {
1565 match pending_update {
1566 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1567 if htlc_id_arg == htlc_id {
1568 // Make sure we don't leave latest_monitor_update_id incremented here:
1569 self.latest_monitor_update_id -= 1;
1570 #[cfg(any(test, feature = "fuzztarget"))]
1571 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1572 return UpdateFulfillFetch::DuplicateClaim {};
1575 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1576 if htlc_id_arg == htlc_id {
1577 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1578 // TODO: We may actually be able to switch to a fulfill here, though its
1579 // rare enough it may not be worth the complexity burden.
1580 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1581 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1587 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1588 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1589 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1591 #[cfg(any(test, feature = "fuzztarget"))]
1592 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1593 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1595 #[cfg(any(test, feature = "fuzztarget"))]
1596 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1599 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1600 if let InboundHTLCState::Committed = htlc.state {
1602 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1603 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1605 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1606 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1609 UpdateFulfillFetch::NewClaim {
1612 msg: Some(msgs::UpdateFulfillHTLC {
1613 channel_id: self.channel_id(),
1614 htlc_id: htlc_id_arg,
1615 payment_preimage: payment_preimage_arg,
1620 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 {
1621 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1622 UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1623 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1624 Err(e) => return Err((e, monitor_update)),
1627 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1628 // strictly increasing by one, so decrement it here.
1629 self.latest_monitor_update_id = monitor_update.update_id;
1630 monitor_update.updates.append(&mut additional_update.updates);
1631 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1633 UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1634 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1635 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1639 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1640 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1641 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1642 /// before we fail backwards.
1643 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1644 /// Ok(_) if debug assertions are turned on or preconditions are met.
1645 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 {
1646 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1647 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1649 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1651 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1652 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1653 // these, but for now we just have to treat them as normal.
1655 let mut pending_idx = core::usize::MAX;
1656 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1657 if htlc.htlc_id == htlc_id_arg {
1659 InboundHTLCState::Committed => {},
1660 InboundHTLCState::LocalRemoved(ref reason) => {
1661 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1663 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1668 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1669 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1675 if pending_idx == core::usize::MAX {
1676 #[cfg(any(test, feature = "fuzztarget"))]
1677 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1678 // is simply a duplicate fail, not previously failed and we failed-back too early.
1679 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1683 // Now update local state:
1684 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1685 for pending_update in self.holding_cell_htlc_updates.iter() {
1686 match pending_update {
1687 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1688 if htlc_id_arg == htlc_id {
1689 #[cfg(any(test, feature = "fuzztarget"))]
1690 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1694 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1695 if htlc_id_arg == htlc_id {
1696 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1697 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1703 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1704 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1705 htlc_id: htlc_id_arg,
1711 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1713 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1714 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1717 Ok(Some(msgs::UpdateFailHTLC {
1718 channel_id: self.channel_id(),
1719 htlc_id: htlc_id_arg,
1724 // Message handlers:
1726 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: &InitFeatures) -> Result<(), ChannelError> {
1727 // Check sanity of message fields:
1728 if !self.is_outbound() {
1729 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1731 if self.channel_state != ChannelState::OurInitSent as u32 {
1732 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1734 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1735 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1737 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1738 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1740 if msg.dust_limit_satoshis > self.holder_selected_channel_reserve_satoshis {
1741 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, self.holder_selected_channel_reserve_satoshis)));
1743 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1744 if msg.htlc_minimum_msat >= full_channel_value_msat {
1745 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1747 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1748 if msg.to_self_delay > max_delay_acceptable {
1749 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)));
1751 if msg.max_accepted_htlcs < 1 {
1752 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1754 if msg.max_accepted_htlcs > MAX_HTLCS {
1755 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1758 // Now check against optional parameters as set by config...
1759 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1760 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)));
1762 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1763 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)));
1765 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1766 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)));
1768 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1769 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)));
1771 if msg.dust_limit_satoshis < MIN_CHAN_DUST_LIMIT_SATOSHIS {
1772 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_CHAN_DUST_LIMIT_SATOSHIS)));
1774 if msg.dust_limit_satoshis > MAX_CHAN_DUST_LIMIT_SATOSHIS {
1775 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_CHAN_DUST_LIMIT_SATOSHIS)));
1777 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1778 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)));
1780 if msg.minimum_depth == 0 {
1781 // Note that if this changes we should update the serialization minimum version to
1782 // indicate to older clients that they don't understand some features of the current
1784 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1787 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1788 match &msg.shutdown_scriptpubkey {
1789 &OptionalField::Present(ref script) => {
1790 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1791 if script.len() == 0 {
1794 if !script::is_bolt2_compliant(&script, their_features) {
1795 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script)));
1797 Some(script.clone())
1800 // 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
1801 &OptionalField::Absent => {
1802 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()));
1807 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1808 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1809 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1810 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1811 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1812 self.minimum_depth = Some(msg.minimum_depth);
1814 let counterparty_pubkeys = ChannelPublicKeys {
1815 funding_pubkey: msg.funding_pubkey,
1816 revocation_basepoint: msg.revocation_basepoint,
1817 payment_point: msg.payment_point,
1818 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1819 htlc_basepoint: msg.htlc_basepoint
1822 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1823 selected_contest_delay: msg.to_self_delay,
1824 pubkeys: counterparty_pubkeys,
1827 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1828 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1830 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1835 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1836 let funding_script = self.get_funding_redeemscript();
1838 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1839 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).tx;
1841 let trusted_tx = initial_commitment_tx.trust();
1842 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1843 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1844 // They sign the holder commitment transaction...
1845 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1846 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1847 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1848 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1849 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1852 let counterparty_keys = self.build_remote_transaction_keys()?;
1853 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
1855 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1856 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1857 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1858 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1860 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1861 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1863 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1864 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1867 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1868 &self.get_counterparty_pubkeys().funding_pubkey
1871 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 {
1872 if self.is_outbound() {
1873 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1875 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1876 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1877 // remember the channel, so it's safe to just send an error_message here and drop the
1879 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1881 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1882 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1883 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1884 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1887 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1888 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1889 // This is an externally observable change before we finish all our checks. In particular
1890 // funding_created_signature may fail.
1891 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1893 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1895 Err(ChannelError::Close(e)) => {
1896 self.channel_transaction_parameters.funding_outpoint = None;
1897 return Err(ChannelError::Close(e));
1900 // The only error we know how to handle is ChannelError::Close, so we fall over here
1901 // to make sure we don't continue with an inconsistent state.
1902 panic!("unexpected error type from funding_created_signature {:?}", e);
1906 let holder_commitment_tx = HolderCommitmentTransaction::new(
1907 initial_commitment_tx,
1910 &self.get_holder_pubkeys().funding_pubkey,
1911 self.counterparty_funding_pubkey()
1914 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1915 .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1917 // Now that we're past error-generating stuff, update our local state:
1919 let funding_redeemscript = self.get_funding_redeemscript();
1920 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1921 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1922 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1923 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1924 shutdown_script, self.get_holder_selected_contest_delay(),
1925 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1926 &self.channel_transaction_parameters,
1927 funding_redeemscript.clone(), self.channel_value_satoshis,
1929 holder_commitment_tx, best_block);
1931 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);
1933 self.channel_state = ChannelState::FundingSent as u32;
1934 self.channel_id = funding_txo.to_channel_id();
1935 self.cur_counterparty_commitment_transaction_number -= 1;
1936 self.cur_holder_commitment_transaction_number -= 1;
1938 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1940 Ok((msgs::FundingSigned {
1941 channel_id: self.channel_id,
1943 }, channel_monitor))
1946 /// Handles a funding_signed message from the remote end.
1947 /// If this call is successful, broadcast the funding transaction (and not before!)
1948 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 {
1949 if !self.is_outbound() {
1950 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1952 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1953 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1955 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1956 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1957 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1958 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1961 let funding_script = self.get_funding_redeemscript();
1963 let counterparty_keys = self.build_remote_transaction_keys()?;
1964 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
1965 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1966 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1968 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1969 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1971 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1972 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).tx;
1974 let trusted_tx = initial_commitment_tx.trust();
1975 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1976 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1977 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1978 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1979 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1983 let holder_commitment_tx = HolderCommitmentTransaction::new(
1984 initial_commitment_tx,
1987 &self.get_holder_pubkeys().funding_pubkey,
1988 self.counterparty_funding_pubkey()
1991 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1992 .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1995 let funding_redeemscript = self.get_funding_redeemscript();
1996 let funding_txo = self.get_funding_txo().unwrap();
1997 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1998 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1999 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
2000 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
2001 shutdown_script, self.get_holder_selected_contest_delay(),
2002 &self.destination_script, (funding_txo, funding_txo_script),
2003 &self.channel_transaction_parameters,
2004 funding_redeemscript.clone(), self.channel_value_satoshis,
2006 holder_commitment_tx, best_block);
2008 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);
2010 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
2011 self.channel_state = ChannelState::FundingSent as u32;
2012 self.cur_holder_commitment_transaction_number -= 1;
2013 self.cur_counterparty_commitment_transaction_number -= 1;
2015 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
2017 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
2020 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
2021 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2022 self.workaround_lnd_bug_4006 = Some(msg.clone());
2023 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()));
2026 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2028 if non_shutdown_state == ChannelState::FundingSent as u32 {
2029 self.channel_state |= ChannelState::TheirFundingLocked as u32;
2030 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2031 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2032 self.update_time_counter += 1;
2033 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
2034 // Note that funding_signed/funding_created will have decremented both by 1!
2035 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
2036 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
2037 // If we reconnected before sending our funding locked they may still resend theirs:
2038 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
2039 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
2040 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
2041 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
2043 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
2046 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
2049 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2050 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2052 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
2057 /// Returns transaction if there is pending funding transaction that is yet to broadcast
2058 pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
2059 if self.channel_state & (ChannelState::FundingCreated as u32) != 0 {
2060 self.funding_transaction.clone()
2066 /// Returns a HTLCStats about inbound pending htlcs
2067 fn get_inbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2068 let mut stats = HTLCStats {
2069 pending_htlcs: self.pending_inbound_htlcs.len() as u32,
2070 pending_htlcs_value_msat: 0,
2071 on_counterparty_tx_dust_exposure_msat: 0,
2072 on_holder_tx_dust_exposure_msat: 0,
2073 holding_cell_msat: 0,
2074 on_holder_tx_holding_cell_htlcs_count: 0,
2077 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2078 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2079 for ref htlc in self.pending_inbound_htlcs.iter() {
2080 stats.pending_htlcs_value_msat += htlc.amount_msat;
2081 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
2082 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2084 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
2085 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2091 /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
2092 fn get_outbound_pending_htlc_stats(&self, outbound_feerate_update: Option<u32>) -> HTLCStats {
2093 let mut stats = HTLCStats {
2094 pending_htlcs: self.pending_outbound_htlcs.len() as u32,
2095 pending_htlcs_value_msat: 0,
2096 on_counterparty_tx_dust_exposure_msat: 0,
2097 on_holder_tx_dust_exposure_msat: 0,
2098 holding_cell_msat: 0,
2099 on_holder_tx_holding_cell_htlcs_count: 0,
2102 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2103 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate(outbound_feerate_update) as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2104 for ref htlc in self.pending_outbound_htlcs.iter() {
2105 stats.pending_htlcs_value_msat += htlc.amount_msat;
2106 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
2107 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
2109 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
2110 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
2114 for update in self.holding_cell_htlc_updates.iter() {
2115 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
2116 stats.pending_htlcs += 1;
2117 stats.pending_htlcs_value_msat += amount_msat;
2118 stats.holding_cell_msat += amount_msat;
2119 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
2120 stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
2122 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
2123 stats.on_holder_tx_dust_exposure_msat += amount_msat;
2125 stats.on_holder_tx_holding_cell_htlcs_count += 1;
2132 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
2133 /// Doesn't bother handling the
2134 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
2135 /// corner case properly.
2136 /// The channel reserve is subtracted from each balance.
2137 /// See also [`Channel::get_balance_msat`]
2138 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
2139 // Note that we have to handle overflow due to the above case.
2141 cmp::max(self.channel_value_satoshis as i64 * 1000
2142 - self.value_to_self_msat as i64
2143 - self.get_inbound_pending_htlc_stats(None).pending_htlcs_value_msat as i64
2144 - self.holder_selected_channel_reserve_satoshis as i64 * 1000,
2146 cmp::max(self.value_to_self_msat as i64
2147 - self.get_outbound_pending_htlc_stats(None).pending_htlcs_value_msat as i64
2148 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
2153 /// Get our total balance in msat.
2154 /// This is the amount that would go to us if we close the channel, ignoring any on-chain fees.
2155 /// See also [`Channel::get_inbound_outbound_available_balance_msat`]
2156 pub fn get_balance_msat(&self) -> u64 {
2157 self.value_to_self_msat
2158 - self.get_outbound_pending_htlc_stats(None).pending_htlcs_value_msat
2161 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
2162 (self.holder_selected_channel_reserve_satoshis, self.counterparty_selected_channel_reserve_satoshis)
2165 // Get the fee cost in MSATS of a commitment tx with a given number of HTLC outputs.
2166 // Note that num_htlcs should not include dust HTLCs.
2167 fn commit_tx_fee_msat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2168 // Note that we need to divide before multiplying to round properly,
2169 // since the lowest denomination of bitcoin on-chain is the satoshi.
2170 (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate_per_kw as u64 / 1000 * 1000
2173 // Get the fee cost in SATS of a commitment tx with a given number of HTLC outputs.
2174 // Note that num_htlcs should not include dust HTLCs.
2176 fn commit_tx_fee_sat(feerate_per_kw: u32, num_htlcs: usize, opt_anchors: bool) -> u64 {
2177 feerate_per_kw as u64 * (commitment_tx_base_weight(opt_anchors) + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000
2180 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
2181 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
2182 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2184 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2185 assert!(self.is_outbound());
2187 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2188 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2190 let mut addl_htlcs = 0;
2191 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2193 HTLCInitiator::LocalOffered => {
2194 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2198 HTLCInitiator::RemoteOffered => {
2199 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2205 let mut included_htlcs = 0;
2206 for ref htlc in self.pending_inbound_htlcs.iter() {
2207 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2210 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2211 // transaction including this HTLC if it times out before they RAA.
2212 included_htlcs += 1;
2215 for ref htlc in self.pending_outbound_htlcs.iter() {
2216 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2220 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2221 OutboundHTLCState::Committed => included_htlcs += 1,
2222 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2223 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2224 // transaction won't be generated until they send us their next RAA, which will mean
2225 // dropping any HTLCs in this state.
2230 for htlc in self.holding_cell_htlc_updates.iter() {
2232 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2233 if amount_msat / 1000 < real_dust_limit_timeout_sat {
2238 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2239 // ack we're guaranteed to never include them in commitment txs anymore.
2243 let num_htlcs = included_htlcs + addl_htlcs;
2244 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2245 #[cfg(any(test, feature = "fuzztarget"))]
2248 if fee_spike_buffer_htlc.is_some() {
2249 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2251 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2252 + self.holding_cell_htlc_updates.len();
2253 let commitment_tx_info = CommitmentTxInfoCached {
2255 total_pending_htlcs,
2256 next_holder_htlc_id: match htlc.origin {
2257 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2258 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2260 next_counterparty_htlc_id: match htlc.origin {
2261 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2262 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2264 feerate: self.feerate_per_kw,
2266 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2271 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2272 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2273 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2275 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2276 assert!(!self.is_outbound());
2278 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2279 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2281 let mut addl_htlcs = 0;
2282 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2284 HTLCInitiator::LocalOffered => {
2285 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2289 HTLCInitiator::RemoteOffered => {
2290 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2296 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2297 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2298 // committed outbound HTLCs, see below.
2299 let mut included_htlcs = 0;
2300 for ref htlc in self.pending_inbound_htlcs.iter() {
2301 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2304 included_htlcs += 1;
2307 for ref htlc in self.pending_outbound_htlcs.iter() {
2308 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2311 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2312 // i.e. if they've responded to us with an RAA after announcement.
2314 OutboundHTLCState::Committed => included_htlcs += 1,
2315 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2316 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2321 let num_htlcs = included_htlcs + addl_htlcs;
2322 let res = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs, self.opt_anchors());
2323 #[cfg(any(test, feature = "fuzztarget"))]
2326 if fee_spike_buffer_htlc.is_some() {
2327 fee = Self::commit_tx_fee_msat(self.feerate_per_kw, num_htlcs - 1, self.opt_anchors());
2329 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2330 let commitment_tx_info = CommitmentTxInfoCached {
2332 total_pending_htlcs,
2333 next_holder_htlc_id: match htlc.origin {
2334 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2335 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2337 next_counterparty_htlc_id: match htlc.origin {
2338 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2339 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2341 feerate: self.feerate_per_kw,
2343 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2348 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>
2349 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2350 // We can't accept HTLCs sent after we've sent a shutdown.
2351 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2352 if local_sent_shutdown {
2353 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x4000|8);
2355 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2356 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2357 if remote_sent_shutdown {
2358 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2360 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2361 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2363 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2364 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2366 if msg.amount_msat == 0 {
2367 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2369 if msg.amount_msat < self.holder_htlc_minimum_msat {
2370 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)));
2373 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
2374 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
2375 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2376 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2378 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > self.holder_max_htlc_value_in_flight_msat {
2379 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", self.holder_max_htlc_value_in_flight_msat)));
2381 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2382 // the reserve_satoshis we told them to always have as direct payment so that they lose
2383 // something if we punish them for broadcasting an old state).
2384 // Note that we don't really care about having a small/no to_remote output in our local
2385 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2386 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2387 // present in the next commitment transaction we send them (at least for fulfilled ones,
2388 // failed ones won't modify value_to_self).
2389 // Note that we will send HTLCs which another instance of rust-lightning would think
2390 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2391 // Channel state once they will not be present in the next received commitment
2393 let mut removed_outbound_total_msat = 0;
2394 for ref htlc in self.pending_outbound_htlcs.iter() {
2395 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2396 removed_outbound_total_msat += htlc.amount_msat;
2397 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2398 removed_outbound_total_msat += htlc.amount_msat;
2402 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate(None) as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2403 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2404 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;
2405 if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2406 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2407 on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2408 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2412 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate(None) as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2413 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2414 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;
2415 if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2416 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2417 on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2418 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2422 let pending_value_to_self_msat =
2423 self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2424 let pending_remote_value_msat =
2425 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2426 if pending_remote_value_msat < msg.amount_msat {
2427 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2430 // Check that the remote can afford to pay for this HTLC on-chain at the current
2431 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2432 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2433 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2434 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2436 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2437 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2440 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < self.holder_selected_channel_reserve_satoshis * 1000 {
2441 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2444 if !self.is_outbound() {
2445 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2446 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2447 // receiver's side, only on the sender's.
2448 // Note that when we eventually remove support for fee updates and switch to anchor output
2449 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2450 // the extra htlc when calculating the next remote commitment transaction fee as we should
2451 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2452 // sensitive to fee spikes.
2453 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2454 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2455 if pending_remote_value_msat - msg.amount_msat - self.holder_selected_channel_reserve_satoshis * 1000 < remote_fee_cost_incl_stuck_buffer_msat {
2456 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2457 // the HTLC, i.e. its status is already set to failing.
2458 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2459 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2462 // Check that they won't violate our local required channel reserve by adding this HTLC.
2463 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2464 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2465 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2466 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2469 if self.next_counterparty_htlc_id != msg.htlc_id {
2470 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2472 if msg.cltv_expiry >= 500000000 {
2473 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2476 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2477 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2478 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2482 // Now update local state:
2483 self.next_counterparty_htlc_id += 1;
2484 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2485 htlc_id: msg.htlc_id,
2486 amount_msat: msg.amount_msat,
2487 payment_hash: msg.payment_hash,
2488 cltv_expiry: msg.cltv_expiry,
2489 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2494 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2496 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2497 for htlc in self.pending_outbound_htlcs.iter_mut() {
2498 if htlc.htlc_id == htlc_id {
2499 match check_preimage {
2501 Some(payment_hash) =>
2502 if payment_hash != htlc.payment_hash {
2503 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2507 OutboundHTLCState::LocalAnnounced(_) =>
2508 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2509 OutboundHTLCState::Committed => {
2510 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2512 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2513 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2518 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2521 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2522 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2523 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2525 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2526 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2529 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2530 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2533 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2534 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2535 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2537 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2538 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2541 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2545 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2546 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2547 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2549 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2550 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2553 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2557 pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2558 where L::Target: Logger
2560 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2561 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2563 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2564 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2566 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2567 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2570 let funding_script = self.get_funding_redeemscript();
2572 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2574 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2575 let commitment_txid = {
2576 let trusted_tx = commitment_stats.tx.trust();
2577 let bitcoin_tx = trusted_tx.built_transaction();
2578 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2580 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2581 log_bytes!(msg.signature.serialize_compact()[..]),
2582 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2583 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2584 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2585 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2589 let mut htlcs_cloned: Vec<_> = commitment_stats.htlcs_included.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2591 // If our counterparty updated the channel fee in this commitment transaction, check that
2592 // they can actually afford the new fee now.
2593 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2594 update_state == FeeUpdateState::RemoteAnnounced
2597 debug_assert!(!self.is_outbound());
2598 let counterparty_reserve_we_require_msat = self.holder_selected_channel_reserve_satoshis * 1000;
2599 if commitment_stats.remote_balance_msat < commitment_stats.total_fee_sat * 1000 + counterparty_reserve_we_require_msat {
2600 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2603 #[cfg(any(test, feature = "fuzztarget"))]
2605 if self.is_outbound() {
2606 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2607 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2608 if let Some(info) = projected_commit_tx_info {
2609 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2610 + self.holding_cell_htlc_updates.len();
2611 if info.total_pending_htlcs == total_pending_htlcs
2612 && info.next_holder_htlc_id == self.next_holder_htlc_id
2613 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2614 && info.feerate == self.feerate_per_kw {
2615 assert_eq!(commitment_stats.total_fee_sat, info.fee / 1000);
2621 if msg.htlc_signatures.len() != commitment_stats.num_nondust_htlcs {
2622 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), commitment_stats.num_nondust_htlcs))));
2625 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2626 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2627 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2628 if let Some(_) = htlc.transaction_output_index {
2629 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_stats.feerate_per_kw,
2630 self.get_counterparty_selected_contest_delay().unwrap(), &htlc, self.opt_anchors(),
2631 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2633 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &keys);
2634 let htlc_sighashtype = if self.opt_anchors() { SigHashType::SinglePlusAnyoneCanPay } else { SigHashType::All };
2635 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype)[..]);
2636 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2637 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2638 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2639 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2640 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2642 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2644 htlcs_and_sigs.push((htlc, None, source));
2648 let holder_commitment_tx = HolderCommitmentTransaction::new(
2649 commitment_stats.tx,
2651 msg.htlc_signatures.clone(),
2652 &self.get_holder_pubkeys().funding_pubkey,
2653 self.counterparty_funding_pubkey()
2656 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2657 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
2658 .map_err(|_| (None, ChannelError::Close("Failed to validate our commitment".to_owned())))?;
2659 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2661 // Update state now that we've passed all the can-fail calls...
2662 let mut need_commitment = false;
2663 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2664 if *update_state == FeeUpdateState::RemoteAnnounced {
2665 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2666 need_commitment = true;
2670 self.latest_monitor_update_id += 1;
2671 let mut monitor_update = ChannelMonitorUpdate {
2672 update_id: self.latest_monitor_update_id,
2673 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2674 commitment_tx: holder_commitment_tx,
2675 htlc_outputs: htlcs_and_sigs
2679 for htlc in self.pending_inbound_htlcs.iter_mut() {
2680 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2681 Some(forward_info.clone())
2683 if let Some(forward_info) = new_forward {
2684 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2685 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2686 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2687 need_commitment = true;
2690 for htlc in self.pending_outbound_htlcs.iter_mut() {
2691 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2692 Some(fail_reason.take())
2694 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2695 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2696 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2697 need_commitment = true;
2701 self.cur_holder_commitment_transaction_number -= 1;
2702 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2703 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2704 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2706 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2707 // In case we initially failed monitor updating without requiring a response, we need
2708 // to make sure the RAA gets sent first.
2709 self.monitor_pending_revoke_and_ack = true;
2710 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2711 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2712 // the corresponding HTLC status updates so that get_last_commitment_update
2713 // includes the right HTLCs.
2714 self.monitor_pending_commitment_signed = true;
2715 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2716 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2717 // strictly increasing by one, so decrement it here.
2718 self.latest_monitor_update_id = monitor_update.update_id;
2719 monitor_update.updates.append(&mut additional_update.updates);
2721 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2722 log_bytes!(self.channel_id));
2723 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2726 let commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2727 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2728 // we'll send one right away when we get the revoke_and_ack when we
2729 // free_holding_cell_htlcs().
2730 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2731 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2732 // strictly increasing by one, so decrement it here.
2733 self.latest_monitor_update_id = monitor_update.update_id;
2734 monitor_update.updates.append(&mut additional_update.updates);
2738 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2739 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2741 Ok((msgs::RevokeAndACK {
2742 channel_id: self.channel_id,
2743 per_commitment_secret,
2744 next_per_commitment_point,
2745 }, commitment_signed, monitor_update))
2748 /// Public version of the below, checking relevant preconditions first.
2749 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2750 /// returns `(None, Vec::new())`.
2751 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 {
2752 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2753 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2754 self.free_holding_cell_htlcs(logger)
2755 } else { Ok((None, Vec::new())) }
2758 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2759 /// fulfilling or failing the last pending HTLC)
2760 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2761 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2762 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2763 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2764 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2766 let mut monitor_update = ChannelMonitorUpdate {
2767 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2768 updates: Vec::new(),
2771 let mut htlc_updates = Vec::new();
2772 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2773 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2774 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2775 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2776 let mut htlcs_to_fail = Vec::new();
2777 for htlc_update in htlc_updates.drain(..) {
2778 // Note that this *can* fail, though it should be due to rather-rare conditions on
2779 // fee races with adding too many outputs which push our total payments just over
2780 // the limit. In case it's less rare than I anticipate, we may want to revisit
2781 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2782 // to rebalance channels.
2783 match &htlc_update {
2784 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2785 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone(), logger) {
2786 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2789 ChannelError::Ignore(ref msg) => {
2790 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2791 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2792 // If we fail to send here, then this HTLC should
2793 // be failed backwards. Failing to send here
2794 // indicates that this HTLC may keep being put back
2795 // into the holding cell without ever being
2796 // successfully forwarded/failed/fulfilled, causing
2797 // our counterparty to eventually close on us.
2798 htlcs_to_fail.push((source.clone(), *payment_hash));
2801 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2807 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2808 // If an HTLC claim was previously added to the holding cell (via
2809 // `get_update_fulfill_htlc`, then generating the claim message itself must
2810 // not fail - any in between attempts to claim the HTLC will have resulted
2811 // in it hitting the holding cell again and we cannot change the state of a
2812 // holding cell HTLC from fulfill to anything else.
2813 let (update_fulfill_msg_option, mut additional_monitor_update) =
2814 if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2815 (msg, monitor_update)
2816 } else { unreachable!() };
2817 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2818 monitor_update.updates.append(&mut additional_monitor_update.updates);
2820 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2821 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2822 Ok(update_fail_msg_option) => {
2823 // If an HTLC failure was previously added to the holding cell (via
2824 // `get_update_fail_htlc`) then generating the fail message itself
2825 // must not fail - we should never end up in a state where we
2826 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2827 // we didn't wait for a full revocation before failing.
2828 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2831 if let ChannelError::Ignore(_) = e {}
2833 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2840 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2841 return Ok((None, htlcs_to_fail));
2843 let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
2844 self.send_update_fee(feerate, logger)
2849 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2850 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2851 // but we want them to be strictly increasing by one, so reset it here.
2852 self.latest_monitor_update_id = monitor_update.update_id;
2853 monitor_update.updates.append(&mut additional_update.updates);
2855 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2856 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2857 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2859 Ok((Some((msgs::CommitmentUpdate {
2861 update_fulfill_htlcs,
2863 update_fail_malformed_htlcs: Vec::new(),
2866 }, monitor_update)), htlcs_to_fail))
2868 Ok((None, Vec::new()))
2872 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2873 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2874 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2875 /// generating an appropriate error *after* the channel state has been updated based on the
2876 /// revoke_and_ack message.
2877 pub fn revoke_and_ack<L: Deref>(&mut self, msg: &msgs::RevokeAndACK, logger: &L) -> Result<RAAUpdates, ChannelError>
2878 where L::Target: Logger,
2880 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2881 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2883 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2884 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2886 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2887 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2890 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
2892 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2893 if PublicKey::from_secret_key(&self.secp_ctx, &secret) != counterparty_prev_commitment_point {
2894 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2898 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2899 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2900 // haven't given them a new commitment transaction to broadcast). We should probably
2901 // take advantage of this by updating our channel monitor, sending them an error, and
2902 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2903 // lot of work, and there's some chance this is all a misunderstanding anyway.
2904 // We have to do *something*, though, since our signer may get mad at us for otherwise
2905 // jumping a remote commitment number, so best to just force-close and move on.
2906 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2909 #[cfg(any(test, feature = "fuzztarget"))]
2911 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2912 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2915 self.holder_signer.validate_counterparty_revocation(
2916 self.cur_counterparty_commitment_transaction_number + 1,
2918 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
2920 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2921 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2922 self.latest_monitor_update_id += 1;
2923 let mut monitor_update = ChannelMonitorUpdate {
2924 update_id: self.latest_monitor_update_id,
2925 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2926 idx: self.cur_counterparty_commitment_transaction_number + 1,
2927 secret: msg.per_commitment_secret,
2931 // Update state now that we've passed all the can-fail calls...
2932 // (note that we may still fail to generate the new commitment_signed message, but that's
2933 // OK, we step the channel here and *then* if the new generation fails we can fail the
2934 // channel based on that, but stepping stuff here should be safe either way.
2935 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2936 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2937 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2938 self.cur_counterparty_commitment_transaction_number -= 1;
2940 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2941 let mut to_forward_infos = Vec::new();
2942 let mut revoked_htlcs = Vec::new();
2943 let mut finalized_claimed_htlcs = Vec::new();
2944 let mut update_fail_htlcs = Vec::new();
2945 let mut update_fail_malformed_htlcs = Vec::new();
2946 let mut require_commitment = false;
2947 let mut value_to_self_msat_diff: i64 = 0;
2950 // Take references explicitly so that we can hold multiple references to self.
2951 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2952 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2954 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2955 pending_inbound_htlcs.retain(|htlc| {
2956 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2957 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2958 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2959 value_to_self_msat_diff += htlc.amount_msat as i64;
2964 pending_outbound_htlcs.retain(|htlc| {
2965 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2966 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2967 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2968 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2970 finalized_claimed_htlcs.push(htlc.source.clone());
2971 // They fulfilled, so we sent them money
2972 value_to_self_msat_diff -= htlc.amount_msat as i64;
2977 for htlc in pending_inbound_htlcs.iter_mut() {
2978 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2980 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2984 let mut state = InboundHTLCState::Committed;
2985 mem::swap(&mut state, &mut htlc.state);
2987 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2988 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2989 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2990 require_commitment = true;
2991 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2992 match forward_info {
2993 PendingHTLCStatus::Fail(fail_msg) => {
2994 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2995 require_commitment = true;
2997 HTLCFailureMsg::Relay(msg) => {
2998 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2999 update_fail_htlcs.push(msg)
3001 HTLCFailureMsg::Malformed(msg) => {
3002 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
3003 update_fail_malformed_htlcs.push(msg)
3007 PendingHTLCStatus::Forward(forward_info) => {
3008 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
3009 to_forward_infos.push((forward_info, htlc.htlc_id));
3010 htlc.state = InboundHTLCState::Committed;
3016 for htlc in pending_outbound_htlcs.iter_mut() {
3017 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3018 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
3019 htlc.state = OutboundHTLCState::Committed;
3021 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3022 Some(fail_reason.take())
3024 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
3025 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3026 require_commitment = true;
3030 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
3032 if let Some((feerate, update_state)) = self.pending_update_fee {
3033 match update_state {
3034 FeeUpdateState::Outbound => {
3035 debug_assert!(self.is_outbound());
3036 log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
3037 self.feerate_per_kw = feerate;
3038 self.pending_update_fee = None;
3040 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
3041 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
3042 debug_assert!(!self.is_outbound());
3043 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
3044 require_commitment = true;
3045 self.feerate_per_kw = feerate;
3046 self.pending_update_fee = None;
3051 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
3052 // We can't actually generate a new commitment transaction (incl by freeing holding
3053 // cells) while we can't update the monitor, so we just return what we have.
3054 if require_commitment {
3055 self.monitor_pending_commitment_signed = true;
3056 // When the monitor updating is restored we'll call get_last_commitment_update(),
3057 // which does not update state, but we're definitely now awaiting a remote revoke
3058 // before we can step forward any more, so set it here.
3059 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
3060 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3061 // strictly increasing by one, so decrement it here.
3062 self.latest_monitor_update_id = monitor_update.update_id;
3063 monitor_update.updates.append(&mut additional_update.updates);
3065 self.monitor_pending_forwards.append(&mut to_forward_infos);
3066 self.monitor_pending_failures.append(&mut revoked_htlcs);
3067 self.monitor_pending_finalized_fulfills.append(&mut finalized_claimed_htlcs);
3068 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
3069 return Ok(RAAUpdates {
3070 commitment_update: None, finalized_claimed_htlcs: Vec::new(),
3071 accepted_htlcs: Vec::new(), failed_htlcs: Vec::new(),
3073 holding_cell_failed_htlcs: Vec::new()
3077 match self.free_holding_cell_htlcs(logger)? {
3078 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
3079 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
3080 for fail_msg in update_fail_htlcs.drain(..) {
3081 commitment_update.update_fail_htlcs.push(fail_msg);
3083 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
3084 for fail_msg in update_fail_malformed_htlcs.drain(..) {
3085 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
3088 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
3089 // strictly increasing by one, so decrement it here.
3090 self.latest_monitor_update_id = monitor_update.update_id;
3091 monitor_update.updates.append(&mut additional_update.updates);
3094 commitment_update: Some(commitment_update),
3095 finalized_claimed_htlcs,
3096 accepted_htlcs: to_forward_infos,
3097 failed_htlcs: revoked_htlcs,
3099 holding_cell_failed_htlcs: htlcs_to_fail
3102 (None, htlcs_to_fail) => {
3103 if require_commitment {
3104 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
3106 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
3107 // strictly increasing by one, so decrement it here.
3108 self.latest_monitor_update_id = monitor_update.update_id;
3109 monitor_update.updates.append(&mut additional_update.updates);
3111 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
3112 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
3114 commitment_update: Some(msgs::CommitmentUpdate {
3115 update_add_htlcs: Vec::new(),
3116 update_fulfill_htlcs: Vec::new(),
3118 update_fail_malformed_htlcs,
3122 finalized_claimed_htlcs,
3123 accepted_htlcs: to_forward_infos, failed_htlcs: revoked_htlcs,
3124 monitor_update, holding_cell_failed_htlcs: htlcs_to_fail
3127 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
3129 commitment_update: None,
3130 finalized_claimed_htlcs,
3131 accepted_htlcs: to_forward_infos, failed_htlcs: revoked_htlcs,
3132 monitor_update, holding_cell_failed_htlcs: htlcs_to_fail
3139 /// Adds a pending update to this channel. See the doc for send_htlc for
3140 /// further details on the optionness of the return value.
3141 /// If our balance is too low to cover the cost of the next commitment transaction at the
3142 /// new feerate, the update is cancelled.
3143 /// You MUST call send_commitment prior to any other calls on this Channel
3144 fn send_update_fee<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Option<msgs::UpdateFee> where L::Target: Logger {
3145 if !self.is_outbound() {
3146 panic!("Cannot send fee from inbound channel");
3148 if !self.is_usable() {
3149 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
3151 if !self.is_live() {
3152 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
3155 // Before proposing a feerate update, check that we can actually afford the new fee.
3156 let inbound_stats = self.get_inbound_pending_htlc_stats(Some(feerate_per_kw));
3157 let outbound_stats = self.get_outbound_pending_htlc_stats(Some(feerate_per_kw));
3158 let keys = if let Ok(keys) = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number) { keys } else { return None; };
3159 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
3160 let buffer_fee_msat = Channel::<Signer>::commit_tx_fee_sat(feerate_per_kw, commitment_stats.num_nondust_htlcs + outbound_stats.on_holder_tx_holding_cell_htlcs_count as usize + CONCURRENT_INBOUND_HTLC_FEE_BUFFER as usize, self.opt_anchors()) * 1000;
3161 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
3162 if holder_balance_msat < buffer_fee_msat + self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 {
3163 //TODO: auto-close after a number of failures?
3164 log_debug!(logger, "Cannot afford to send new feerate at {}", feerate_per_kw);
3168 // Note, we evaluate pending htlc "preemptive" trimmed-to-dust threshold at the proposed `feerate_per_kw`.
3169 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3170 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3171 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3172 log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3175 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3176 log_debug!(logger, "Cannot afford to send new feerate at {} without infringing max dust htlc exposure", feerate_per_kw);
3180 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3181 self.holding_cell_update_fee = Some(feerate_per_kw);
3185 debug_assert!(self.pending_update_fee.is_none());
3186 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
3188 Some(msgs::UpdateFee {
3189 channel_id: self.channel_id,
3194 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 {
3195 match self.send_update_fee(feerate_per_kw, logger) {
3196 Some(update_fee) => {
3197 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
3198 Ok(Some((update_fee, commitment_signed, monitor_update)))
3204 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
3205 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
3207 /// No further message handling calls may be made until a channel_reestablish dance has
3209 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
3210 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3211 if self.channel_state < ChannelState::FundingSent as u32 {
3212 self.channel_state = ChannelState::ShutdownComplete as u32;
3215 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
3216 // will be retransmitted.
3217 self.last_sent_closing_fee = None;
3218 self.pending_counterparty_closing_signed = None;
3219 self.closing_fee_limits = None;
3221 let mut inbound_drop_count = 0;
3222 self.pending_inbound_htlcs.retain(|htlc| {
3224 InboundHTLCState::RemoteAnnounced(_) => {
3225 // They sent us an update_add_htlc but we never got the commitment_signed.
3226 // We'll tell them what commitment_signed we're expecting next and they'll drop
3227 // this HTLC accordingly
3228 inbound_drop_count += 1;
3231 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3232 // We received a commitment_signed updating this HTLC and (at least hopefully)
3233 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3234 // in response to it yet, so don't touch it.
3237 InboundHTLCState::Committed => true,
3238 InboundHTLCState::LocalRemoved(_) => {
3239 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3240 // re-transmit if needed) and they may have even sent a revoke_and_ack back
3241 // (that we missed). Keep this around for now and if they tell us they missed
3242 // the commitment_signed we can re-transmit the update then.
3247 self.next_counterparty_htlc_id -= inbound_drop_count;
3249 if let Some((_, update_state)) = self.pending_update_fee {
3250 if update_state == FeeUpdateState::RemoteAnnounced {
3251 debug_assert!(!self.is_outbound());
3252 self.pending_update_fee = None;
3256 for htlc in self.pending_outbound_htlcs.iter_mut() {
3257 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3258 // They sent us an update to remove this but haven't yet sent the corresponding
3259 // commitment_signed, we need to move it back to Committed and they can re-send
3260 // the update upon reconnection.
3261 htlc.state = OutboundHTLCState::Committed;
3265 self.channel_state |= ChannelState::PeerDisconnected as u32;
3266 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3269 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3270 /// updates are partially paused.
3271 /// This must be called immediately after the call which generated the ChannelMonitor update
3272 /// which failed. The messages which were generated from that call which generated the
3273 /// monitor update failure must *not* have been sent to the remote end, and must instead
3274 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3275 pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool,
3276 mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
3277 mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
3278 mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
3280 self.monitor_pending_revoke_and_ack |= resend_raa;
3281 self.monitor_pending_commitment_signed |= resend_commitment;
3282 self.monitor_pending_forwards.append(&mut pending_forwards);
3283 self.monitor_pending_failures.append(&mut pending_fails);
3284 self.monitor_pending_finalized_fulfills.append(&mut pending_finalized_claimed_htlcs);
3285 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3288 /// Indicates that the latest ChannelMonitor update has been committed by the client
3289 /// successfully and we should restore normal operation. Returns messages which should be sent
3290 /// to the remote side.
3291 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> MonitorRestoreUpdates where L::Target: Logger {
3292 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3293 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3295 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
3296 self.funding_transaction.take()
3299 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3300 // we assume the user never directly broadcasts the funding transaction and waits for us to
3301 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
3302 // channel which failed to persist the monitor on funding_created, and we got the funding
3303 // transaction confirmed before the monitor was persisted.
3304 let funding_locked = if self.monitor_pending_funding_locked {
3305 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3306 self.monitor_pending_funding_locked = false;
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 let mut accepted_htlcs = Vec::new();
3315 mem::swap(&mut accepted_htlcs, &mut self.monitor_pending_forwards);
3316 let mut failed_htlcs = Vec::new();
3317 mem::swap(&mut failed_htlcs, &mut self.monitor_pending_failures);
3318 let mut finalized_claimed_htlcs = Vec::new();
3319 mem::swap(&mut finalized_claimed_htlcs, &mut self.monitor_pending_finalized_fulfills);
3321 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3322 self.monitor_pending_revoke_and_ack = false;
3323 self.monitor_pending_commitment_signed = false;
3324 return MonitorRestoreUpdates {
3325 raa: None, commitment_update: None, order: RAACommitmentOrder::RevokeAndACKFirst,
3326 accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, funding_locked
3330 let raa = if self.monitor_pending_revoke_and_ack {
3331 Some(self.get_last_revoke_and_ack())
3333 let commitment_update = if self.monitor_pending_commitment_signed {
3334 Some(self.get_last_commitment_update(logger))
3337 self.monitor_pending_revoke_and_ack = false;
3338 self.monitor_pending_commitment_signed = false;
3339 let order = self.resend_order.clone();
3340 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3341 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3342 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3343 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3344 MonitorRestoreUpdates {
3345 raa, commitment_update, order, accepted_htlcs, failed_htlcs, finalized_claimed_htlcs, funding_broadcastable, funding_locked
3349 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3350 where F::Target: FeeEstimator
3352 if self.is_outbound() {
3353 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3355 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3356 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3358 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3359 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate(None);
3361 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3362 self.update_time_counter += 1;
3363 // If the feerate has increased over the previous dust buffer (note that
3364 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3365 // won't be pushed over our dust exposure limit by the feerate increase.
3366 if feerate_over_dust_buffer {
3367 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
3368 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
3369 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3370 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3371 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3372 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)",
3373 msg.feerate_per_kw, holder_tx_dust_exposure)));
3375 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3376 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)",
3377 msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3383 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3384 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3385 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3386 msgs::RevokeAndACK {
3387 channel_id: self.channel_id,
3388 per_commitment_secret,
3389 next_per_commitment_point,
3393 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3394 let mut update_add_htlcs = Vec::new();
3395 let mut update_fulfill_htlcs = Vec::new();
3396 let mut update_fail_htlcs = Vec::new();
3397 let mut update_fail_malformed_htlcs = Vec::new();
3399 for htlc in self.pending_outbound_htlcs.iter() {
3400 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3401 update_add_htlcs.push(msgs::UpdateAddHTLC {
3402 channel_id: self.channel_id(),
3403 htlc_id: htlc.htlc_id,
3404 amount_msat: htlc.amount_msat,
3405 payment_hash: htlc.payment_hash,
3406 cltv_expiry: htlc.cltv_expiry,
3407 onion_routing_packet: (**onion_packet).clone(),
3412 for htlc in self.pending_inbound_htlcs.iter() {
3413 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3415 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3416 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3417 channel_id: self.channel_id(),
3418 htlc_id: htlc.htlc_id,
3419 reason: err_packet.clone()
3422 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3423 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3424 channel_id: self.channel_id(),
3425 htlc_id: htlc.htlc_id,
3426 sha256_of_onion: sha256_of_onion.clone(),
3427 failure_code: failure_code.clone(),
3430 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3431 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3432 channel_id: self.channel_id(),
3433 htlc_id: htlc.htlc_id,
3434 payment_preimage: payment_preimage.clone(),
3441 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3442 Some(msgs::UpdateFee {
3443 channel_id: self.channel_id(),
3444 feerate_per_kw: self.pending_update_fee.unwrap().0,
3448 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3449 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3450 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3451 msgs::CommitmentUpdate {
3452 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3453 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,
3457 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3458 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3459 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 {
3460 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3461 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3462 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3463 // just close here instead of trying to recover.
3464 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3467 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3468 msg.next_local_commitment_number == 0 {
3469 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3472 if msg.next_remote_commitment_number > 0 {
3473 match msg.data_loss_protect {
3474 OptionalField::Present(ref data_loss) => {
3475 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3476 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3477 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3478 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3479 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3481 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3482 return Err(ChannelError::CloseDelayBroadcast(
3483 "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()
3487 OptionalField::Absent => {}
3491 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3492 // remaining cases either succeed or ErrorMessage-fail).
3493 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3495 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3496 assert!(self.shutdown_scriptpubkey.is_some());
3497 Some(msgs::Shutdown {
3498 channel_id: self.channel_id,
3499 scriptpubkey: self.get_closing_scriptpubkey(),
3503 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3504 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3505 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3506 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3507 if msg.next_remote_commitment_number != 0 {
3508 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3510 // Short circuit the whole handler as there is nothing we can resend them
3511 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3514 // We have OurFundingLocked set!
3515 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3516 return Ok((Some(msgs::FundingLocked {
3517 channel_id: self.channel_id(),
3518 next_per_commitment_point,
3519 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3522 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3523 // Remote isn't waiting on any RevokeAndACK from us!
3524 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3526 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3527 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3528 self.monitor_pending_revoke_and_ack = true;
3531 Some(self.get_last_revoke_and_ack())
3534 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3537 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3538 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3539 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3540 // the corresponding revoke_and_ack back yet.
3541 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 };
3543 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3544 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3545 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3546 Some(msgs::FundingLocked {
3547 channel_id: self.channel_id(),
3548 next_per_commitment_point,
3552 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3553 if required_revoke.is_some() {
3554 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3556 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3559 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3560 // We're up-to-date and not waiting on a remote revoke (if we are our
3561 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3562 // have received some updates while we were disconnected. Free the holding cell
3564 match self.free_holding_cell_htlcs(logger) {
3565 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3566 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
3567 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3568 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3569 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3571 Ok((None, htlcs_to_fail)) => {
3572 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3576 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3578 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3579 if required_revoke.is_some() {
3580 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3582 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3585 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3586 self.monitor_pending_commitment_signed = true;
3587 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3590 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3592 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3596 /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
3597 /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
3598 /// at which point they will be recalculated.
3599 fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &F) -> (u64, u64)
3600 where F::Target: FeeEstimator
3602 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
3604 // Propose a range from our current Background feerate to our Normal feerate plus our
3605 // force_close_avoidance_max_fee_satoshis.
3606 // If we fail to come to consensus, we'll have to force-close.
3607 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3608 let normal_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3609 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
3611 // The spec requires that (when the channel does not have anchors) we only send absolute
3612 // channel fees no greater than the absolute channel fee on the current commitment
3613 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
3614 // very good reason to apply such a limit in any case. We don't bother doing so, risking
3615 // some force-closure by old nodes, but we wanted to close the channel anyway.
3617 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
3618 let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
3619 proposed_feerate = cmp::max(proposed_feerate, min_feerate);
3620 proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
3623 // Note that technically we could end up with a lower minimum fee if one sides' balance is
3624 // below our dust limit, causing the output to disappear. We don't bother handling this
3625 // case, however, as this should only happen if a channel is closed before any (material)
3626 // payments have been made on it. This may cause slight fee overpayment and/or failure to
3627 // come to consensus with our counterparty on appropriate fees, however it should be a
3628 // relatively rare case. We can revisit this later, though note that in order to determine
3629 // if the funders' output is dust we have to know the absolute fee we're going to use.
3630 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3631 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3632 let proposed_max_total_fee_satoshis = if self.is_outbound() {
3633 // We always add force_close_avoidance_max_fee_satoshis to our normal
3634 // feerate-calculated fee, but allow the max to be overridden if we're using a
3635 // target feerate-calculated fee.
3636 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.force_close_avoidance_max_fee_satoshis,
3637 proposed_max_feerate as u64 * tx_weight / 1000)
3639 self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000
3642 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
3643 self.closing_fee_limits.clone().unwrap()
3646 /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
3647 /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
3648 /// this point if we're the funder we should send the initial closing_signed, and in any case
3649 /// shutdown should complete within a reasonable timeframe.
3650 fn closing_negotiation_ready(&self) -> bool {
3651 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
3652 self.channel_state &
3653 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
3654 ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)
3655 == BOTH_SIDES_SHUTDOWN_MASK &&
3656 self.pending_update_fee.is_none()
3659 /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
3660 /// an Err if no progress is being made and the channel should be force-closed instead.
3661 /// Should be called on a one-minute timer.
3662 pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
3663 if self.closing_negotiation_ready() {
3664 if self.closing_signed_in_flight {
3665 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
3667 self.closing_signed_in_flight = true;
3673 pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(&mut self, fee_estimator: &F, logger: &L)
3674 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3675 where F::Target: FeeEstimator, L::Target: Logger
3677 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
3678 return Ok((None, None));
3681 if !self.is_outbound() {
3682 if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
3683 return self.closing_signed(fee_estimator, &msg);
3685 return Ok((None, None));
3688 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3690 assert!(self.shutdown_scriptpubkey.is_some());
3691 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
3692 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
3693 our_min_fee, our_max_fee, total_fee_satoshis);
3695 let sig = self.holder_signer
3696 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3697 .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
3699 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
3700 Ok((Some(msgs::ClosingSigned {
3701 channel_id: self.channel_id,
3702 fee_satoshis: total_fee_satoshis,
3704 fee_range: Some(msgs::ClosingSignedFeeRange {
3705 min_fee_satoshis: our_min_fee,
3706 max_fee_satoshis: our_max_fee,
3711 pub fn shutdown<K: Deref>(
3712 &mut self, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3713 ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3714 where K::Target: KeysInterface<Signer = Signer>
3716 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3717 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3719 if self.channel_state < ChannelState::FundingSent as u32 {
3720 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3721 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3722 // can do that via error message without getting a connection fail anyway...
3723 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3725 for htlc in self.pending_inbound_htlcs.iter() {
3726 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3727 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3730 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3732 if !script::is_bolt2_compliant(&msg.scriptpubkey, their_features) {
3733 return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3736 if self.counterparty_shutdown_scriptpubkey.is_some() {
3737 if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3738 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3741 self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3744 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
3745 // immediately after the commitment dance, but we can send a Shutdown because we won't send
3746 // any further commitment updates after we set LocalShutdownSent.
3747 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3749 let update_shutdown_script = match self.shutdown_scriptpubkey {
3752 assert!(send_shutdown);
3753 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3754 if !shutdown_scriptpubkey.is_compatible(their_features) {
3755 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
3757 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3762 // From here on out, we may not fail!
3764 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3765 self.update_time_counter += 1;
3767 let monitor_update = if update_shutdown_script {
3768 self.latest_monitor_update_id += 1;
3769 Some(ChannelMonitorUpdate {
3770 update_id: self.latest_monitor_update_id,
3771 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3772 scriptpubkey: self.get_closing_scriptpubkey(),
3776 let shutdown = if send_shutdown {
3777 Some(msgs::Shutdown {
3778 channel_id: self.channel_id,
3779 scriptpubkey: self.get_closing_scriptpubkey(),
3783 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3784 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3785 // cell HTLCs and return them to fail the payment.
3786 self.holding_cell_update_fee = None;
3787 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3788 self.holding_cell_htlc_updates.retain(|htlc_update| {
3790 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3791 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3798 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3799 self.update_time_counter += 1;
3801 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
3804 fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
3805 let mut tx = closing_tx.trust().built_transaction().clone();
3807 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3809 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3810 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3811 if funding_key[..] < counterparty_funding_key[..] {
3812 tx.input[0].witness.push(sig.serialize_der().to_vec());
3813 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3815 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3816 tx.input[0].witness.push(sig.serialize_der().to_vec());
3818 tx.input[0].witness[1].push(SigHashType::All as u8);
3819 tx.input[0].witness[2].push(SigHashType::All as u8);
3821 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3825 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3826 where F::Target: FeeEstimator
3828 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3829 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3831 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3832 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3834 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3835 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3837 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3838 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3841 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
3842 return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
3845 if self.channel_state & ChannelState::MonitorUpdateFailed as u32 != 0 {
3846 self.pending_counterparty_closing_signed = Some(msg.clone());
3847 return Ok((None, None));
3850 let funding_redeemscript = self.get_funding_redeemscript();
3851 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3852 if used_total_fee != msg.fee_satoshis {
3853 return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee other than the value they can claim. Fee in message: {}. Actual closing tx fee: {}", msg.fee_satoshis, used_total_fee)));
3855 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3857 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3860 // The remote end may have decided to revoke their output due to inconsistent dust
3861 // limits, so check for that case by re-checking the signature here.
3862 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3863 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3864 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3868 for outp in closing_tx.trust().built_transaction().output.iter() {
3869 if !outp.script_pubkey.is_witness_program() && outp.value < MAX_STD_OUTPUT_DUST_LIMIT_SATOSHIS {
3870 return Err(ChannelError::Close("Remote sent us a closing_signed with a dust output. Always use segwit closing scripts!".to_owned()));
3874 assert!(self.shutdown_scriptpubkey.is_some());
3875 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
3876 if last_fee == msg.fee_satoshis {
3877 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3878 self.channel_state = ChannelState::ShutdownComplete as u32;
3879 self.update_time_counter += 1;
3880 return Ok((None, Some(tx)));
3884 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3886 macro_rules! propose_fee {
3887 ($new_fee: expr) => {
3888 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
3889 (closing_tx, $new_fee)
3891 self.build_closing_transaction($new_fee, false)
3894 let sig = self.holder_signer
3895 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3896 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3898 let signed_tx = if $new_fee == msg.fee_satoshis {
3899 self.channel_state = ChannelState::ShutdownComplete as u32;
3900 self.update_time_counter += 1;
3901 let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
3905 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
3906 return Ok((Some(msgs::ClosingSigned {
3907 channel_id: self.channel_id,
3908 fee_satoshis: used_fee,
3910 fee_range: Some(msgs::ClosingSignedFeeRange {
3911 min_fee_satoshis: our_min_fee,
3912 max_fee_satoshis: our_max_fee,
3918 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
3919 if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
3920 return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in their desired range of {} sat - {} sat", msg.fee_satoshis, min_fee_satoshis, max_fee_satoshis)));
3922 if max_fee_satoshis < our_min_fee {
3923 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's max fee ({} sat) was smaller than our min fee ({} sat)", max_fee_satoshis, our_min_fee)));
3925 if min_fee_satoshis > our_max_fee {
3926 return Err(ChannelError::Warn(format!("Unable to come to consensus about closing feerate, remote's min fee ({} sat) was greater than our max fee ({} sat)", min_fee_satoshis, our_max_fee)));
3929 if !self.is_outbound() {
3930 // They have to pay, so pick the highest fee in the overlapping range.
3931 // We should never set an upper bound aside from their full balance
3932 debug_assert_eq!(our_max_fee, self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000);
3933 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
3935 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
3936 return Err(ChannelError::Close(format!("Peer sent a bogus closing_signed - suggested fee of {} sat was not in our desired range of {} sat - {} sat after we informed them of our range.",
3937 msg.fee_satoshis, our_min_fee, our_max_fee)));
3939 // The proposed fee is in our acceptable range, accept it and broadcast!
3940 propose_fee!(msg.fee_satoshis);
3943 // Old fee style negotiation. We don't bother to enforce whether they are complying
3944 // with the "making progress" requirements, we just comply and hope for the best.
3945 if let Some((last_fee, _)) = self.last_sent_closing_fee {
3946 if msg.fee_satoshis > last_fee {
3947 if msg.fee_satoshis < our_max_fee {
3948 propose_fee!(msg.fee_satoshis);
3949 } else if last_fee < our_max_fee {
3950 propose_fee!(our_max_fee);
3952 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) higher than our max fee ({} sat)", msg.fee_satoshis, our_max_fee)));
3955 if msg.fee_satoshis > our_min_fee {
3956 propose_fee!(msg.fee_satoshis);
3957 } else if last_fee > our_min_fee {
3958 propose_fee!(our_min_fee);
3960 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wants something ({} sat) lower than our min fee ({} sat)", msg.fee_satoshis, our_min_fee)));
3964 if msg.fee_satoshis < our_min_fee {
3965 propose_fee!(our_min_fee);
3966 } else if msg.fee_satoshis > our_max_fee {
3967 propose_fee!(our_max_fee);
3969 propose_fee!(msg.fee_satoshis);
3975 // Public utilities:
3977 pub fn channel_id(&self) -> [u8; 32] {
3981 pub fn minimum_depth(&self) -> Option<u32> {
3985 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3986 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3987 pub fn get_user_id(&self) -> u64 {
3991 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3992 /// is_usable() returns true).
3993 /// Allowed in any state (including after shutdown)
3994 pub fn get_short_channel_id(&self) -> Option<u64> {
3995 self.short_channel_id
3998 /// Returns the funding_txo we either got from our peer, or were given by
3999 /// get_outbound_funding_created.
4000 pub fn get_funding_txo(&self) -> Option<OutPoint> {
4001 self.channel_transaction_parameters.funding_outpoint
4004 fn get_holder_selected_contest_delay(&self) -> u16 {
4005 self.channel_transaction_parameters.holder_selected_contest_delay
4008 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
4009 &self.channel_transaction_parameters.holder_pubkeys
4012 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
4013 self.channel_transaction_parameters.counterparty_parameters
4014 .as_ref().map(|params| params.selected_contest_delay)
4017 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
4018 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
4021 /// Allowed in any state (including after shutdown)
4022 pub fn get_counterparty_node_id(&self) -> PublicKey {
4023 self.counterparty_node_id
4026 /// Allowed in any state (including after shutdown)
4028 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
4029 self.holder_htlc_minimum_msat
4032 /// Allowed in any state (including after shutdown)
4033 pub fn get_announced_htlc_max_msat(&self) -> u64 {
4035 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
4036 // to use full capacity. This is an effort to reduce routing failures, because in many cases
4037 // channel might have been used to route very small values (either by honest users or as DoS).
4038 self.channel_value_satoshis * 1000 * 9 / 10,
4040 self.holder_max_htlc_value_in_flight_msat
4044 /// Allowed in any state (including after shutdown)
4045 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
4046 self.counterparty_htlc_minimum_msat
4049 pub fn get_value_satoshis(&self) -> u64 {
4050 self.channel_value_satoshis
4053 pub fn get_fee_proportional_millionths(&self) -> u32 {
4054 self.config.forwarding_fee_proportional_millionths
4057 pub fn get_cltv_expiry_delta(&self) -> u16 {
4058 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
4061 pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
4062 self.config.max_dust_htlc_exposure_msat
4065 pub fn get_feerate(&self) -> u32 {
4069 pub fn get_dust_buffer_feerate(&self, outbound_feerate_update: Option<u32>) -> u32 {
4070 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
4071 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
4072 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
4073 // more dust balance if the feerate increases when we have several HTLCs pending
4074 // which are near the dust limit.
4075 let mut feerate_per_kw = self.feerate_per_kw;
4076 // If there's a pending update fee, use it to ensure we aren't under-estimating
4077 // potential feerate updates coming soon.
4078 if let Some((feerate, _)) = self.pending_update_fee {
4079 feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4081 if let Some(feerate) = outbound_feerate_update {
4082 feerate_per_kw = cmp::max(feerate_per_kw, feerate);
4084 cmp::max(2530, feerate_per_kw * 1250 / 1000)
4087 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
4088 self.cur_holder_commitment_transaction_number + 1
4091 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
4092 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
4095 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
4096 self.cur_counterparty_commitment_transaction_number + 2
4100 pub fn get_signer(&self) -> &Signer {
4105 pub fn get_value_stat(&self) -> ChannelValueStat {
4107 value_to_self_msat: self.value_to_self_msat,
4108 channel_value_msat: self.channel_value_satoshis * 1000,
4109 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
4110 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4111 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
4112 holding_cell_outbound_amount_msat: {
4114 for h in self.holding_cell_htlc_updates.iter() {
4116 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
4124 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
4125 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
4129 /// Allowed in any state (including after shutdown)
4130 pub fn get_update_time_counter(&self) -> u32 {
4131 self.update_time_counter
4134 pub fn get_latest_monitor_update_id(&self) -> u64 {
4135 self.latest_monitor_update_id
4138 pub fn should_announce(&self) -> bool {
4139 self.config.announced_channel
4142 pub fn is_outbound(&self) -> bool {
4143 self.channel_transaction_parameters.is_outbound_from_holder
4146 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
4147 /// Allowed in any state (including after shutdown)
4148 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
4149 self.config.forwarding_fee_base_msat
4152 /// Returns true if we've ever received a message from the remote end for this Channel
4153 pub fn have_received_message(&self) -> bool {
4154 self.channel_state > (ChannelState::OurInitSent as u32)
4157 /// Returns true if this channel is fully established and not known to be closing.
4158 /// Allowed in any state (including after shutdown)
4159 pub fn is_usable(&self) -> bool {
4160 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
4161 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
4164 /// Returns true if this channel is currently available for use. This is a superset of
4165 /// is_usable() and considers things like the channel being temporarily disabled.
4166 /// Allowed in any state (including after shutdown)
4167 pub fn is_live(&self) -> bool {
4168 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
4171 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
4172 /// Allowed in any state (including after shutdown)
4173 pub fn is_awaiting_monitor_update(&self) -> bool {
4174 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
4177 /// Returns true if funding_created was sent/received.
4178 pub fn is_funding_initiated(&self) -> bool {
4179 self.channel_state >= ChannelState::FundingSent as u32
4182 /// Returns true if our peer has either initiated or agreed to shut down the channel.
4183 pub fn received_shutdown(&self) -> bool {
4184 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
4187 /// Returns true if we either initiated or agreed to shut down the channel.
4188 pub fn sent_shutdown(&self) -> bool {
4189 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
4192 /// Returns true if this channel is fully shut down. True here implies that no further actions
4193 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
4194 /// will be handled appropriately by the chain monitor.
4195 pub fn is_shutdown(&self) -> bool {
4196 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
4197 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
4202 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
4203 self.channel_update_status
4206 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
4207 self.update_time_counter += 1;
4208 self.channel_update_status = status;
4211 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
4212 if self.funding_tx_confirmation_height == 0 {
4216 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4217 if funding_tx_confirmations <= 0 {
4218 self.funding_tx_confirmation_height = 0;
4221 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
4225 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4226 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
4227 self.channel_state |= ChannelState::OurFundingLocked as u32;
4229 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
4230 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
4231 self.update_time_counter += 1;
4233 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
4234 // We got a reorg but not enough to trigger a force close, just ignore.
4236 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
4237 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
4239 // We got a reorg but not enough to trigger a force close, just ignore.
4243 if need_commitment_update {
4244 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
4245 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4246 return Some(msgs::FundingLocked {
4247 channel_id: self.channel_id,
4248 next_per_commitment_point,
4251 self.monitor_pending_funding_locked = true;
4257 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
4258 /// In the first case, we store the confirmation height and calculating the short channel id.
4259 /// In the second, we simply return an Err indicating we need to be force-closed now.
4260 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
4261 -> Result<Option<msgs::FundingLocked>, ClosureReason> where L::Target: Logger {
4262 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4263 for &(index_in_block, tx) in txdata.iter() {
4264 if let Some(funding_txo) = self.get_funding_txo() {
4265 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
4266 // whether they've sent a funding_locked or not), check if we should send one.
4267 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
4268 if tx.txid() == funding_txo.txid {
4269 let txo_idx = funding_txo.index as usize;
4270 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
4271 tx.output[txo_idx].value != self.channel_value_satoshis {
4272 if self.is_outbound() {
4273 // If we generated the funding transaction and it doesn't match what it
4274 // should, the client is really broken and we should just panic and
4275 // tell them off. That said, because hash collisions happen with high
4276 // probability in fuzztarget mode, if we're fuzzing we just close the
4277 // channel and move on.
4278 #[cfg(not(feature = "fuzztarget"))]
4279 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4281 self.update_time_counter += 1;
4282 let err_reason = "funding tx had wrong script/value or output index";
4283 return Err(ClosureReason::ProcessingError { err: err_reason.to_owned() });
4285 if self.is_outbound() {
4286 for input in tx.input.iter() {
4287 if input.witness.is_empty() {
4288 // We generated a malleable funding transaction, implying we've
4289 // just exposed ourselves to funds loss to our counterparty.
4290 #[cfg(not(feature = "fuzztarget"))]
4291 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4295 self.funding_tx_confirmation_height = height;
4296 self.funding_tx_confirmed_in = Some(*block_hash);
4297 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
4298 Ok(scid) => Some(scid),
4299 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
4303 // If we allow 1-conf funding, we may need to check for funding_locked here and
4304 // send it immediately instead of waiting for a best_block_updated call (which
4305 // may have already happened for this block).
4306 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4307 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4308 return Ok(Some(funding_locked));
4311 for inp in tx.input.iter() {
4312 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
4313 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()));
4314 return Err(ClosureReason::CommitmentTxConfirmed);
4322 /// When a new block is connected, we check the height of the block against outbound holding
4323 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
4324 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
4325 /// handled by the ChannelMonitor.
4327 /// If we return Err, the channel may have been closed, at which point the standard
4328 /// requirements apply - no calls may be made except those explicitly stated to be allowed
4331 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
4333 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
4334 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), ClosureReason> where L::Target: Logger {
4335 let mut timed_out_htlcs = Vec::new();
4336 // This mirrors the check in ChannelManager::decode_update_add_htlc_onion, refusing to
4337 // forward an HTLC when our counterparty should almost certainly just fail it for expiring
4339 let unforwarded_htlc_cltv_limit = height + LATENCY_GRACE_PERIOD_BLOCKS;
4340 self.holding_cell_htlc_updates.retain(|htlc_update| {
4342 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
4343 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
4344 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
4352 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
4354 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4355 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4356 return Ok((Some(funding_locked), timed_out_htlcs));
4359 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4360 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
4361 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
4362 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4363 if self.funding_tx_confirmation_height == 0 {
4364 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
4365 // zero if it has been reorged out, however in either case, our state flags
4366 // indicate we've already sent a funding_locked
4367 funding_tx_confirmations = 0;
4370 // If we've sent funding_locked (or have both sent and received funding_locked), and
4371 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
4372 // close the channel and hope we can get the latest state on chain (because presumably
4373 // the funding transaction is at least still in the mempool of most nodes).
4374 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
4375 let err_reason = format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.",
4376 self.minimum_depth.unwrap(), funding_tx_confirmations);
4377 return Err(ClosureReason::ProcessingError { err: err_reason });
4379 } else if !self.is_outbound() && self.funding_tx_confirmed_in.is_none() &&
4380 height >= self.channel_creation_height + FUNDING_CONF_DEADLINE_BLOCKS {
4381 log_info!(logger, "Closing channel {} due to funding timeout", log_bytes!(self.channel_id));
4382 // If funding_tx_confirmed_in is unset, the channel must not be active
4383 assert!(non_shutdown_state <= ChannelState::ChannelFunded as u32);
4384 assert_eq!(non_shutdown_state & ChannelState::OurFundingLocked as u32, 0);
4385 return Err(ClosureReason::FundingTimedOut);
4388 Ok((None, timed_out_htlcs))
4391 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4392 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4393 /// before the channel has reached funding_locked and we can just wait for more blocks.
4394 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), ClosureReason> where L::Target: Logger {
4395 if self.funding_tx_confirmation_height != 0 {
4396 // We handle the funding disconnection by calling best_block_updated with a height one
4397 // below where our funding was connected, implying a reorg back to conf_height - 1.
4398 let reorg_height = self.funding_tx_confirmation_height - 1;
4399 // We use the time field to bump the current time we set on channel updates if its
4400 // larger. If we don't know that time has moved forward, we can just set it to the last
4401 // time we saw and it will be ignored.
4402 let best_time = self.update_time_counter;
4403 match self.best_block_updated(reorg_height, best_time, logger) {
4404 Ok((funding_locked, timed_out_htlcs)) => {
4405 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
4406 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4412 // We never learned about the funding confirmation anyway, just ignore
4417 // Methods to get unprompted messages to send to the remote end (or where we already returned
4418 // something in the handler for the message that prompted this message):
4420 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
4421 if !self.is_outbound() {
4422 panic!("Tried to open a channel for an inbound channel?");
4424 if self.channel_state != ChannelState::OurInitSent as u32 {
4425 panic!("Cannot generate an open_channel after we've moved forward");
4428 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4429 panic!("Tried to send an open_channel for a channel that has already advanced");
4432 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4433 let keys = self.get_holder_pubkeys();
4437 temporary_channel_id: self.channel_id,
4438 funding_satoshis: self.channel_value_satoshis,
4439 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
4440 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4441 max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
4442 channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
4443 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4444 feerate_per_kw: self.feerate_per_kw as u32,
4445 to_self_delay: self.get_holder_selected_contest_delay(),
4446 max_accepted_htlcs: OUR_MAX_HTLCS,
4447 funding_pubkey: keys.funding_pubkey,
4448 revocation_basepoint: keys.revocation_basepoint,
4449 payment_point: keys.payment_point,
4450 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4451 htlc_basepoint: keys.htlc_basepoint,
4452 first_per_commitment_point,
4453 channel_flags: if self.config.announced_channel {1} else {0},
4454 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4455 Some(script) => script.clone().into_inner(),
4456 None => Builder::new().into_script(),
4458 channel_type: Some(self.channel_type.clone()),
4462 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
4463 if self.is_outbound() {
4464 panic!("Tried to send accept_channel for an outbound channel?");
4466 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
4467 panic!("Tried to send accept_channel after channel had moved forward");
4469 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4470 panic!("Tried to send an accept_channel for a channel that has already advanced");
4473 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4474 let keys = self.get_holder_pubkeys();
4476 msgs::AcceptChannel {
4477 temporary_channel_id: self.channel_id,
4478 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4479 max_htlc_value_in_flight_msat: self.holder_max_htlc_value_in_flight_msat,
4480 channel_reserve_satoshis: self.holder_selected_channel_reserve_satoshis,
4481 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4482 minimum_depth: self.minimum_depth.unwrap(),
4483 to_self_delay: self.get_holder_selected_contest_delay(),
4484 max_accepted_htlcs: OUR_MAX_HTLCS,
4485 funding_pubkey: keys.funding_pubkey,
4486 revocation_basepoint: keys.revocation_basepoint,
4487 payment_point: keys.payment_point,
4488 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4489 htlc_basepoint: keys.htlc_basepoint,
4490 first_per_commitment_point,
4491 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4492 Some(script) => script.clone().into_inner(),
4493 None => Builder::new().into_script(),
4498 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
4499 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
4500 let counterparty_keys = self.build_remote_transaction_keys()?;
4501 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).tx;
4502 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
4503 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
4506 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
4507 /// a funding_created message for the remote peer.
4508 /// Panics if called at some time other than immediately after initial handshake, if called twice,
4509 /// or if called on an inbound channel.
4510 /// Note that channel_id changes during this call!
4511 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
4512 /// If an Err is returned, it is a ChannelError::Close.
4513 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 {
4514 if !self.is_outbound() {
4515 panic!("Tried to create outbound funding_created message on an inbound channel!");
4517 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
4518 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)");
4520 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
4521 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
4522 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4523 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
4526 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
4527 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
4529 let signature = match self.get_outbound_funding_created_signature(logger) {
4532 log_error!(logger, "Got bad signatures: {:?}!", e);
4533 self.channel_transaction_parameters.funding_outpoint = None;
4538 let temporary_channel_id = self.channel_id;
4540 // Now that we're past error-generating stuff, update our local state:
4542 self.channel_state = ChannelState::FundingCreated as u32;
4543 self.channel_id = funding_txo.to_channel_id();
4544 self.funding_transaction = Some(funding_transaction);
4546 Ok(msgs::FundingCreated {
4547 temporary_channel_id,
4548 funding_txid: funding_txo.txid,
4549 funding_output_index: funding_txo.index,
4554 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4555 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4556 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4557 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4558 /// Will only fail if we're not in a state where channel_announcement may be sent (including
4560 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4561 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4563 /// This will only return ChannelError::Ignore upon failure.
4564 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4565 if !self.config.announced_channel {
4566 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4568 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4569 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4571 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4572 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4575 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4577 let msg = msgs::UnsignedChannelAnnouncement {
4578 features: ChannelFeatures::known(),
4580 short_channel_id: self.get_short_channel_id().unwrap(),
4581 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4582 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4583 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4584 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4585 excess_data: Vec::new(),
4588 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4589 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4594 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4596 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> {
4597 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4598 let were_node_one = announcement.node_id_1 == our_node_id;
4600 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4601 Ok(msgs::ChannelAnnouncement {
4602 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4603 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4604 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4605 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4606 contents: announcement,
4609 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4613 /// Processes an incoming announcement_signatures message, providing a fully-signed
4614 /// channel_announcement message which we can broadcast and storing our counterparty's
4615 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4616 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4617 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4619 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4621 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4622 return Err(ChannelError::Close(format!(
4623 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4624 &announcement, self.get_counterparty_node_id())));
4626 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4627 return Err(ChannelError::Close(format!(
4628 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4629 &announcement, self.counterparty_funding_pubkey())));
4632 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4634 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4637 /// Gets a signed channel_announcement for this channel, if we previously received an
4638 /// announcement_signatures from our counterparty.
4639 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4640 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4642 Err(_) => return None,
4644 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4645 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4646 Ok(res) => Some(res),
4651 /// May panic if called on a channel that wasn't immediately-previously
4652 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4653 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4654 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4655 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4656 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4657 // current to_remote balances. However, it no longer has any use, and thus is now simply
4658 // set to a dummy (but valid, as required by the spec) public key.
4659 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4660 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4661 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4662 let mut pk = [2; 33]; pk[1] = 0xff;
4663 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4664 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4665 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4666 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()));
4667 OptionalField::Present(DataLossProtect {
4668 your_last_per_commitment_secret: remote_last_secret,
4669 my_current_per_commitment_point: dummy_pubkey
4672 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4673 OptionalField::Present(DataLossProtect {
4674 your_last_per_commitment_secret: [0;32],
4675 my_current_per_commitment_point: dummy_pubkey,
4678 msgs::ChannelReestablish {
4679 channel_id: self.channel_id(),
4680 // The protocol has two different commitment number concepts - the "commitment
4681 // transaction number", which starts from 0 and counts up, and the "revocation key
4682 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4683 // commitment transaction numbers by the index which will be used to reveal the
4684 // revocation key for that commitment transaction, which means we have to convert them
4685 // to protocol-level commitment numbers here...
4687 // next_local_commitment_number is the next commitment_signed number we expect to
4688 // receive (indicating if they need to resend one that we missed).
4689 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4690 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4691 // receive, however we track it by the next commitment number for a remote transaction
4692 // (which is one further, as they always revoke previous commitment transaction, not
4693 // the one we send) so we have to decrement by 1. Note that if
4694 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4695 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4697 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4703 // Send stuff to our remote peers:
4705 /// Adds a pending outbound HTLC to this channel, note that you probably want
4706 /// send_htlc_and_commit instead cause you'll want both messages at once.
4708 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4710 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4711 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4713 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4714 /// may not yet have sent the previous commitment update messages and will need to regenerate
4717 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4719 /// If an Err is returned, it's a ChannelError::Ignore!
4720 pub fn send_htlc<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>, ChannelError> where L::Target: Logger {
4721 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4722 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4724 let channel_total_msat = self.channel_value_satoshis * 1000;
4725 if amount_msat > channel_total_msat {
4726 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4729 if amount_msat == 0 {
4730 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4733 if amount_msat < self.counterparty_htlc_minimum_msat {
4734 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4737 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4738 // Note that this should never really happen, if we're !is_live() on receipt of an
4739 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4740 // the user to send directly into a !is_live() channel. However, if we
4741 // disconnected during the time the previous hop was doing the commitment dance we may
4742 // end up getting here after the forwarding delay. In any case, returning an
4743 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4744 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4747 let inbound_stats = self.get_inbound_pending_htlc_stats(None);
4748 let outbound_stats = self.get_outbound_pending_htlc_stats(None);
4749 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
4750 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4752 // Check their_max_htlc_value_in_flight_msat
4753 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4754 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)));
4757 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
4758 let commitment_stats = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, true, logger);
4759 if !self.is_outbound() {
4760 // Check that we won't violate the remote channel reserve by adding this HTLC.
4761 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4762 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4763 let holder_selected_chan_reserve_msat = self.holder_selected_channel_reserve_satoshis * 1000;
4764 if commitment_stats.remote_balance_msat < counterparty_commit_tx_fee_msat + holder_selected_chan_reserve_msat {
4765 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4769 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate(None) as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
4770 if amount_msat / 1000 < exposure_dust_limit_success_sats {
4771 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;
4772 if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4773 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
4774 on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4778 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate(None) as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
4779 if amount_msat / 1000 < exposure_dust_limit_timeout_sats {
4780 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;
4781 if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4782 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
4783 on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4787 let holder_balance_msat = commitment_stats.local_balance_msat - outbound_stats.holding_cell_msat;
4788 if holder_balance_msat < amount_msat {
4789 return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, holder_balance_msat)));
4792 // `2 *` and extra HTLC are for the fee spike buffer.
4793 let commit_tx_fee_msat = if self.is_outbound() {
4794 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4795 FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4797 if holder_balance_msat - amount_msat < commit_tx_fee_msat {
4798 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 {}", holder_balance_msat, commit_tx_fee_msat)));
4801 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4802 // reserve for the remote to have something to claim if we misbehave)
4803 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4804 if holder_balance_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4805 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4808 // Now update local state:
4809 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4810 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4815 onion_routing_packet,
4820 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4821 htlc_id: self.next_holder_htlc_id,
4823 payment_hash: payment_hash.clone(),
4825 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4829 let res = msgs::UpdateAddHTLC {
4830 channel_id: self.channel_id,
4831 htlc_id: self.next_holder_htlc_id,
4835 onion_routing_packet,
4837 self.next_holder_htlc_id += 1;
4842 /// Creates a signed commitment transaction to send to the remote peer.
4843 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4844 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4845 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4846 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4847 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4848 panic!("Cannot create commitment tx until channel is fully established");
4850 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4851 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4853 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4854 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4856 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4857 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");
4859 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
4860 for htlc in self.pending_outbound_htlcs.iter() {
4861 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4862 have_updates = true;
4864 if have_updates { break; }
4866 for htlc in self.pending_inbound_htlcs.iter() {
4867 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4868 have_updates = true;
4870 if have_updates { break; }
4873 panic!("Cannot create commitment tx until we have some updates to send");
4875 self.send_commitment_no_status_check(logger)
4877 /// Only fails in case of bad keys
4878 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4879 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
4880 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4881 // fail to generate this, we still are at least at a position where upgrading their status
4883 for htlc in self.pending_inbound_htlcs.iter_mut() {
4884 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4885 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4887 if let Some(state) = new_state {
4888 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4892 for htlc in self.pending_outbound_htlcs.iter_mut() {
4893 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4894 Some(fail_reason.take())
4896 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4897 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4900 if let Some((feerate, update_state)) = self.pending_update_fee {
4901 if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
4902 debug_assert!(!self.is_outbound());
4903 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4904 self.feerate_per_kw = feerate;
4905 self.pending_update_fee = None;
4908 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4910 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4911 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4912 // Update state now that we've passed all the can-fail calls...
4913 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4914 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4915 (res, counterparty_commitment_tx, htlcs_no_ref)
4917 Err(e) => return Err(e),
4920 self.latest_monitor_update_id += 1;
4921 let monitor_update = ChannelMonitorUpdate {
4922 update_id: self.latest_monitor_update_id,
4923 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4924 commitment_txid: counterparty_commitment_txid,
4925 htlc_outputs: htlcs.clone(),
4926 commitment_number: self.cur_counterparty_commitment_transaction_number,
4927 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4930 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4931 Ok((res, monitor_update))
4934 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4935 /// when we shouldn't change HTLC/channel state.
4936 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4937 let counterparty_keys = self.build_remote_transaction_keys()?;
4938 let commitment_stats = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
4939 let counterparty_commitment_txid = commitment_stats.tx.trust().txid();
4940 let (signature, htlc_signatures);
4942 #[cfg(any(test, feature = "fuzztarget"))]
4944 if !self.is_outbound() {
4945 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4946 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4947 if let Some(info) = projected_commit_tx_info {
4948 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4949 if info.total_pending_htlcs == total_pending_htlcs
4950 && info.next_holder_htlc_id == self.next_holder_htlc_id
4951 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4952 && info.feerate == self.feerate_per_kw {
4953 let actual_fee = Self::commit_tx_fee_msat(self.feerate_per_kw, commitment_stats.num_nondust_htlcs, self.opt_anchors());
4954 assert_eq!(actual_fee, info.fee);
4961 let mut htlcs = Vec::with_capacity(commitment_stats.htlcs_included.len());
4962 for &(ref htlc, _) in commitment_stats.htlcs_included.iter() {
4966 let res = self.holder_signer.sign_counterparty_commitment(&commitment_stats.tx, &self.secp_ctx)
4967 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4969 htlc_signatures = res.1;
4971 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4972 encode::serialize_hex(&commitment_stats.tx.trust().built_transaction().transaction),
4973 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4974 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4976 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4977 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4978 encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, commitment_stats.feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, self.opt_anchors(), &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
4979 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &counterparty_keys)),
4980 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4981 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4985 Ok((msgs::CommitmentSigned {
4986 channel_id: self.channel_id,
4989 }, (counterparty_commitment_txid, commitment_stats.htlcs_included)))
4992 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4993 /// to send to the remote peer in one go.
4994 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4996 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 {
4997 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, logger)? {
4998 Some(update_add_htlc) => {
4999 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
5000 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
5006 /// Get forwarding information for the counterparty.
5007 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
5008 self.counterparty_forwarding_info.clone()
5011 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
5012 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
5013 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
5015 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
5016 fee_base_msat: msg.contents.fee_base_msat,
5017 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
5018 cltv_expiry_delta: msg.contents.cltv_expiry_delta
5024 /// Begins the shutdown process, getting a message for the remote peer and returning all
5025 /// holding cell HTLCs for payment failure.
5026 pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures, target_feerate_sats_per_kw: Option<u32>)
5027 -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
5028 where K::Target: KeysInterface<Signer = Signer> {
5029 for htlc in self.pending_outbound_htlcs.iter() {
5030 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
5031 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
5034 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
5035 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
5036 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
5038 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
5039 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
5042 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
5043 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
5044 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()});
5047 let update_shutdown_script = match self.shutdown_scriptpubkey {
5050 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
5051 if !shutdown_scriptpubkey.is_compatible(their_features) {
5052 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
5054 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
5059 // From here on out, we may not fail!
5060 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
5061 if self.channel_state < ChannelState::FundingSent as u32 {
5062 self.channel_state = ChannelState::ShutdownComplete as u32;
5064 self.channel_state |= ChannelState::LocalShutdownSent as u32;
5066 self.update_time_counter += 1;
5068 let monitor_update = if update_shutdown_script {
5069 self.latest_monitor_update_id += 1;
5070 Some(ChannelMonitorUpdate {
5071 update_id: self.latest_monitor_update_id,
5072 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
5073 scriptpubkey: self.get_closing_scriptpubkey(),
5077 let shutdown = msgs::Shutdown {
5078 channel_id: self.channel_id,
5079 scriptpubkey: self.get_closing_scriptpubkey(),
5082 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
5083 // our shutdown until we've committed all of the pending changes.
5084 self.holding_cell_update_fee = None;
5085 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
5086 self.holding_cell_htlc_updates.retain(|htlc_update| {
5088 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
5089 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
5096 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
5099 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
5100 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
5101 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
5102 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
5103 /// immediately (others we will have to allow to time out).
5104 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
5105 // Note that we MUST only generate a monitor update that indicates force-closure - we're
5106 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
5107 // being fully configured in some cases. Thus, its likely any monitor events we generate will
5108 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
5109 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
5111 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
5112 // return them to fail the payment.
5113 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
5114 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
5116 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
5117 dropped_outbound_htlcs.push((source, payment_hash));
5122 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
5123 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
5124 // returning a channel monitor update here would imply a channel monitor update before
5125 // we even registered the channel monitor to begin with, which is invalid.
5126 // Thus, if we aren't actually at a point where we could conceivably broadcast the
5127 // funding transaction, don't return a funding txo (which prevents providing the
5128 // monitor update to the user, even if we return one).
5129 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
5130 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
5131 self.latest_monitor_update_id += 1;
5132 Some((funding_txo, ChannelMonitorUpdate {
5133 update_id: self.latest_monitor_update_id,
5134 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
5139 self.channel_state = ChannelState::ShutdownComplete as u32;
5140 self.update_time_counter += 1;
5141 (monitor_update, dropped_outbound_htlcs)
5145 const SERIALIZATION_VERSION: u8 = 2;
5146 const MIN_SERIALIZATION_VERSION: u8 = 1;
5148 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
5154 impl Writeable for ChannelUpdateStatus {
5155 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5156 // We only care about writing out the current state as it was announced, ie only either
5157 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
5158 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
5160 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
5161 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
5162 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
5163 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
5169 impl Readable for ChannelUpdateStatus {
5170 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
5171 Ok(match <u8 as Readable>::read(reader)? {
5172 0 => ChannelUpdateStatus::Enabled,
5173 1 => ChannelUpdateStatus::Disabled,
5174 _ => return Err(DecodeError::InvalidValue),
5179 impl<Signer: Sign> Writeable for Channel<Signer> {
5180 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5181 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
5184 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
5186 self.user_id.write(writer)?;
5188 // Write out the old serialization for the config object. This is read by version-1
5189 // deserializers, but we will read the version in the TLV at the end instead.
5190 self.config.forwarding_fee_proportional_millionths.write(writer)?;
5191 self.config.cltv_expiry_delta.write(writer)?;
5192 self.config.announced_channel.write(writer)?;
5193 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
5195 self.channel_id.write(writer)?;
5196 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
5197 self.channel_value_satoshis.write(writer)?;
5199 self.latest_monitor_update_id.write(writer)?;
5201 let mut key_data = VecWriter(Vec::new());
5202 self.holder_signer.write(&mut key_data)?;
5203 assert!(key_data.0.len() < core::usize::MAX);
5204 assert!(key_data.0.len() < core::u32::MAX as usize);
5205 (key_data.0.len() as u32).write(writer)?;
5206 writer.write_all(&key_data.0[..])?;
5208 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
5209 // deserialized from that format.
5210 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
5211 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
5212 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
5214 self.destination_script.write(writer)?;
5216 self.cur_holder_commitment_transaction_number.write(writer)?;
5217 self.cur_counterparty_commitment_transaction_number.write(writer)?;
5218 self.value_to_self_msat.write(writer)?;
5220 let mut dropped_inbound_htlcs = 0;
5221 for htlc in self.pending_inbound_htlcs.iter() {
5222 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
5223 dropped_inbound_htlcs += 1;
5226 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
5227 for htlc in self.pending_inbound_htlcs.iter() {
5228 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
5231 htlc.htlc_id.write(writer)?;
5232 htlc.amount_msat.write(writer)?;
5233 htlc.cltv_expiry.write(writer)?;
5234 htlc.payment_hash.write(writer)?;
5236 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
5237 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
5239 htlc_state.write(writer)?;
5241 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
5243 htlc_state.write(writer)?;
5245 &InboundHTLCState::Committed => {
5248 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
5250 removal_reason.write(writer)?;
5255 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
5256 for htlc in self.pending_outbound_htlcs.iter() {
5257 htlc.htlc_id.write(writer)?;
5258 htlc.amount_msat.write(writer)?;
5259 htlc.cltv_expiry.write(writer)?;
5260 htlc.payment_hash.write(writer)?;
5261 htlc.source.write(writer)?;
5263 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
5265 onion_packet.write(writer)?;
5267 &OutboundHTLCState::Committed => {
5270 &OutboundHTLCState::RemoteRemoved(_) => {
5271 // Treat this as a Committed because we haven't received the CS - they'll
5272 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
5275 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
5277 fail_reason.write(writer)?;
5279 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
5281 fail_reason.write(writer)?;
5286 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
5287 for update in self.holding_cell_htlc_updates.iter() {
5289 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
5291 amount_msat.write(writer)?;
5292 cltv_expiry.write(writer)?;
5293 payment_hash.write(writer)?;
5294 source.write(writer)?;
5295 onion_routing_packet.write(writer)?;
5297 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
5299 payment_preimage.write(writer)?;
5300 htlc_id.write(writer)?;
5302 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
5304 htlc_id.write(writer)?;
5305 err_packet.write(writer)?;
5310 match self.resend_order {
5311 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
5312 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
5315 self.monitor_pending_funding_locked.write(writer)?;
5316 self.monitor_pending_revoke_and_ack.write(writer)?;
5317 self.monitor_pending_commitment_signed.write(writer)?;
5319 (self.monitor_pending_forwards.len() as u64).write(writer)?;
5320 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
5321 pending_forward.write(writer)?;
5322 htlc_id.write(writer)?;
5325 (self.monitor_pending_failures.len() as u64).write(writer)?;
5326 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
5327 htlc_source.write(writer)?;
5328 payment_hash.write(writer)?;
5329 fail_reason.write(writer)?;
5332 if self.is_outbound() {
5333 self.pending_update_fee.map(|(a, _)| a).write(writer)?;
5334 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
5335 Some(feerate).write(writer)?;
5337 // As for inbound HTLCs, if the update was only announced and never committed in a
5338 // commitment_signed, drop it.
5339 None::<u32>.write(writer)?;
5341 self.holding_cell_update_fee.write(writer)?;
5343 self.next_holder_htlc_id.write(writer)?;
5344 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
5345 self.update_time_counter.write(writer)?;
5346 self.feerate_per_kw.write(writer)?;
5348 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5349 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5350 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5351 // consider the stale state on reload.
5354 self.funding_tx_confirmed_in.write(writer)?;
5355 self.funding_tx_confirmation_height.write(writer)?;
5356 self.short_channel_id.write(writer)?;
5358 self.counterparty_dust_limit_satoshis.write(writer)?;
5359 self.holder_dust_limit_satoshis.write(writer)?;
5360 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
5362 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5363 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
5365 self.counterparty_htlc_minimum_msat.write(writer)?;
5366 self.holder_htlc_minimum_msat.write(writer)?;
5367 self.counterparty_max_accepted_htlcs.write(writer)?;
5369 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5370 self.minimum_depth.unwrap_or(0).write(writer)?;
5372 match &self.counterparty_forwarding_info {
5375 info.fee_base_msat.write(writer)?;
5376 info.fee_proportional_millionths.write(writer)?;
5377 info.cltv_expiry_delta.write(writer)?;
5379 None => 0u8.write(writer)?
5382 self.channel_transaction_parameters.write(writer)?;
5383 self.funding_transaction.write(writer)?;
5385 self.counterparty_cur_commitment_point.write(writer)?;
5386 self.counterparty_prev_commitment_point.write(writer)?;
5387 self.counterparty_node_id.write(writer)?;
5389 self.counterparty_shutdown_scriptpubkey.write(writer)?;
5391 self.commitment_secrets.write(writer)?;
5393 self.channel_update_status.write(writer)?;
5395 #[cfg(any(test, feature = "fuzztarget"))]
5396 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
5397 #[cfg(any(test, feature = "fuzztarget"))]
5398 for htlc in self.historical_inbound_htlc_fulfills.iter() {
5399 htlc.write(writer)?;
5402 // If the channel type is something other than only-static-remote-key, then we need to have
5403 // older clients fail to deserialize this channel at all. If the type is
5404 // only-static-remote-key, we simply consider it "default" and don't write the channel type
5406 let chan_type = if self.channel_type != ChannelTypeFeatures::only_static_remote_key() {
5407 Some(&self.channel_type) } else { None };
5409 // The same logic applies for `holder_selected_channel_reserve_satoshis` and
5410 // `holder_max_htlc_value_in_flight_msat` values other than the defaults.
5411 let serialized_holder_selected_reserve =
5412 if self.holder_selected_channel_reserve_satoshis != Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis)
5413 { Some(self.holder_selected_channel_reserve_satoshis) } else { None };
5414 let serialized_holder_htlc_max_in_flight =
5415 if self.holder_max_htlc_value_in_flight_msat != Self::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
5416 { Some(self.holder_max_htlc_value_in_flight_msat) } else { None };
5418 write_tlv_fields!(writer, {
5419 (0, self.announcement_sigs, option),
5420 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
5421 // default value instead of being Option<>al. Thus, to maintain compatibility we write
5422 // them twice, once with their original default values above, and once as an option
5423 // here. On the read side, old versions will simply ignore the odd-type entries here,
5424 // and new versions map the default values to None and allow the TLV entries here to
5426 (1, self.minimum_depth, option),
5427 (2, chan_type, option),
5428 (3, self.counterparty_selected_channel_reserve_satoshis, option),
5429 (4, serialized_holder_selected_reserve, option),
5430 (5, self.config, required),
5431 (6, serialized_holder_htlc_max_in_flight, option),
5432 (7, self.shutdown_scriptpubkey, option),
5433 (9, self.target_closing_feerate_sats_per_kw, option),
5434 (11, self.monitor_pending_finalized_fulfills, vec_type),
5435 (13, self.channel_creation_height, required),
5442 const MAX_ALLOC_SIZE: usize = 64*1024;
5443 impl<'a, Signer: Sign, K: Deref> ReadableArgs<(&'a K, u32)> for Channel<Signer>
5444 where K::Target: KeysInterface<Signer = Signer> {
5445 fn read<R : io::Read>(reader: &mut R, args: (&'a K, u32)) -> Result<Self, DecodeError> {
5446 let (keys_source, serialized_height) = args;
5447 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5449 let user_id = Readable::read(reader)?;
5451 let mut config = Some(ChannelConfig::default());
5453 // Read the old serialization of the ChannelConfig from version 0.0.98.
5454 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
5455 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
5456 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5457 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5459 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
5460 let mut _val: u64 = Readable::read(reader)?;
5463 let channel_id = Readable::read(reader)?;
5464 let channel_state = Readable::read(reader)?;
5465 let channel_value_satoshis = Readable::read(reader)?;
5467 let latest_monitor_update_id = Readable::read(reader)?;
5469 let keys_len: u32 = Readable::read(reader)?;
5470 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
5471 while keys_data.len() != keys_len as usize {
5472 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
5473 let mut data = [0; 1024];
5474 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
5475 reader.read_exact(read_slice)?;
5476 keys_data.extend_from_slice(read_slice);
5478 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
5480 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
5481 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
5482 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
5485 let destination_script = Readable::read(reader)?;
5487 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
5488 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
5489 let value_to_self_msat = Readable::read(reader)?;
5491 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
5492 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5493 for _ in 0..pending_inbound_htlc_count {
5494 pending_inbound_htlcs.push(InboundHTLCOutput {
5495 htlc_id: Readable::read(reader)?,
5496 amount_msat: Readable::read(reader)?,
5497 cltv_expiry: Readable::read(reader)?,
5498 payment_hash: Readable::read(reader)?,
5499 state: match <u8 as Readable>::read(reader)? {
5500 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
5501 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
5502 3 => InboundHTLCState::Committed,
5503 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
5504 _ => return Err(DecodeError::InvalidValue),
5509 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
5510 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5511 for _ in 0..pending_outbound_htlc_count {
5512 pending_outbound_htlcs.push(OutboundHTLCOutput {
5513 htlc_id: Readable::read(reader)?,
5514 amount_msat: Readable::read(reader)?,
5515 cltv_expiry: Readable::read(reader)?,
5516 payment_hash: Readable::read(reader)?,
5517 source: Readable::read(reader)?,
5518 state: match <u8 as Readable>::read(reader)? {
5519 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
5520 1 => OutboundHTLCState::Committed,
5521 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
5522 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
5523 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
5524 _ => return Err(DecodeError::InvalidValue),
5529 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
5530 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
5531 for _ in 0..holding_cell_htlc_update_count {
5532 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
5533 0 => HTLCUpdateAwaitingACK::AddHTLC {
5534 amount_msat: Readable::read(reader)?,
5535 cltv_expiry: Readable::read(reader)?,
5536 payment_hash: Readable::read(reader)?,
5537 source: Readable::read(reader)?,
5538 onion_routing_packet: Readable::read(reader)?,
5540 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
5541 payment_preimage: Readable::read(reader)?,
5542 htlc_id: Readable::read(reader)?,
5544 2 => HTLCUpdateAwaitingACK::FailHTLC {
5545 htlc_id: Readable::read(reader)?,
5546 err_packet: Readable::read(reader)?,
5548 _ => return Err(DecodeError::InvalidValue),
5552 let resend_order = match <u8 as Readable>::read(reader)? {
5553 0 => RAACommitmentOrder::CommitmentFirst,
5554 1 => RAACommitmentOrder::RevokeAndACKFirst,
5555 _ => return Err(DecodeError::InvalidValue),
5558 let monitor_pending_funding_locked = Readable::read(reader)?;
5559 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
5560 let monitor_pending_commitment_signed = Readable::read(reader)?;
5562 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
5563 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
5564 for _ in 0..monitor_pending_forwards_count {
5565 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
5568 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
5569 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
5570 for _ in 0..monitor_pending_failures_count {
5571 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
5574 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
5576 let holding_cell_update_fee = Readable::read(reader)?;
5578 let next_holder_htlc_id = Readable::read(reader)?;
5579 let next_counterparty_htlc_id = Readable::read(reader)?;
5580 let update_time_counter = Readable::read(reader)?;
5581 let feerate_per_kw = Readable::read(reader)?;
5583 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5584 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5585 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5586 // consider the stale state on reload.
5587 match <u8 as Readable>::read(reader)? {
5590 let _: u32 = Readable::read(reader)?;
5591 let _: u64 = Readable::read(reader)?;
5592 let _: Signature = Readable::read(reader)?;
5594 _ => return Err(DecodeError::InvalidValue),
5597 let funding_tx_confirmed_in = Readable::read(reader)?;
5598 let funding_tx_confirmation_height = Readable::read(reader)?;
5599 let short_channel_id = Readable::read(reader)?;
5601 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
5602 let holder_dust_limit_satoshis = Readable::read(reader)?;
5603 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
5604 let mut counterparty_selected_channel_reserve_satoshis = None;
5606 // Read the old serialization from version 0.0.98.
5607 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
5609 // Read the 8 bytes of backwards-compatibility data.
5610 let _dummy: u64 = Readable::read(reader)?;
5612 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
5613 let holder_htlc_minimum_msat = Readable::read(reader)?;
5614 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
5616 let mut minimum_depth = None;
5618 // Read the old serialization from version 0.0.98.
5619 minimum_depth = Some(Readable::read(reader)?);
5621 // Read the 4 bytes of backwards-compatibility data.
5622 let _dummy: u32 = Readable::read(reader)?;
5625 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5627 1 => Some(CounterpartyForwardingInfo {
5628 fee_base_msat: Readable::read(reader)?,
5629 fee_proportional_millionths: Readable::read(reader)?,
5630 cltv_expiry_delta: Readable::read(reader)?,
5632 _ => return Err(DecodeError::InvalidValue),
5635 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
5636 let funding_transaction = Readable::read(reader)?;
5638 let counterparty_cur_commitment_point = Readable::read(reader)?;
5640 let counterparty_prev_commitment_point = Readable::read(reader)?;
5641 let counterparty_node_id = Readable::read(reader)?;
5643 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5644 let commitment_secrets = Readable::read(reader)?;
5646 let channel_update_status = Readable::read(reader)?;
5648 #[cfg(any(test, feature = "fuzztarget"))]
5649 let mut historical_inbound_htlc_fulfills = HashSet::new();
5650 #[cfg(any(test, feature = "fuzztarget"))]
5652 let htlc_fulfills_len: u64 = Readable::read(reader)?;
5653 for _ in 0..htlc_fulfills_len {
5654 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5658 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
5659 Some((feerate, if channel_parameters.is_outbound_from_holder {
5660 FeeUpdateState::Outbound
5662 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
5668 let mut announcement_sigs = None;
5669 let mut target_closing_feerate_sats_per_kw = None;
5670 let mut monitor_pending_finalized_fulfills = Some(Vec::new());
5671 let mut holder_selected_channel_reserve_satoshis = Some(Self::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis));
5672 let mut holder_max_htlc_value_in_flight_msat = Some(Self::get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis));
5673 // Prior to supporting channel type negotiation, all of our channels were static_remotekey
5674 // only, so we default to that if none was written.
5675 let mut channel_type = Some(ChannelTypeFeatures::only_static_remote_key());
5676 let mut channel_creation_height = Some(serialized_height);
5677 read_tlv_fields!(reader, {
5678 (0, announcement_sigs, option),
5679 (1, minimum_depth, option),
5680 (2, channel_type, option),
5681 (3, counterparty_selected_channel_reserve_satoshis, option),
5682 (4, holder_selected_channel_reserve_satoshis, option),
5683 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5684 (6, holder_max_htlc_value_in_flight_msat, option),
5685 (7, shutdown_scriptpubkey, option),
5686 (9, target_closing_feerate_sats_per_kw, option),
5687 (11, monitor_pending_finalized_fulfills, vec_type),
5688 (13, channel_creation_height, option),
5691 let chan_features = channel_type.as_ref().unwrap();
5692 if chan_features.supports_unknown_bits() || chan_features.requires_unknown_bits() {
5693 // If the channel was written by a new version and negotiated with features we don't
5694 // understand yet, refuse to read it.
5695 return Err(DecodeError::UnknownRequiredFeature);
5698 if channel_parameters.opt_anchors.is_some() {
5699 // Relax this check when ChannelTypeFeatures supports anchors.
5700 return Err(DecodeError::InvalidValue);
5703 let mut secp_ctx = Secp256k1::new();
5704 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5709 config: config.unwrap(),
5713 channel_value_satoshis,
5715 latest_monitor_update_id,
5718 shutdown_scriptpubkey,
5721 cur_holder_commitment_transaction_number,
5722 cur_counterparty_commitment_transaction_number,
5725 pending_inbound_htlcs,
5726 pending_outbound_htlcs,
5727 holding_cell_htlc_updates,
5731 monitor_pending_funding_locked,
5732 monitor_pending_revoke_and_ack,
5733 monitor_pending_commitment_signed,
5734 monitor_pending_forwards,
5735 monitor_pending_failures,
5736 monitor_pending_finalized_fulfills: monitor_pending_finalized_fulfills.unwrap(),
5739 holding_cell_update_fee,
5740 next_holder_htlc_id,
5741 next_counterparty_htlc_id,
5742 update_time_counter,
5745 #[cfg(debug_assertions)]
5746 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5747 #[cfg(debug_assertions)]
5748 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5750 last_sent_closing_fee: None,
5751 pending_counterparty_closing_signed: None,
5752 closing_fee_limits: None,
5753 target_closing_feerate_sats_per_kw,
5755 funding_tx_confirmed_in,
5756 funding_tx_confirmation_height,
5758 channel_creation_height: channel_creation_height.unwrap(),
5760 counterparty_dust_limit_satoshis,
5761 holder_dust_limit_satoshis,
5762 counterparty_max_htlc_value_in_flight_msat,
5763 holder_max_htlc_value_in_flight_msat: holder_max_htlc_value_in_flight_msat.unwrap(),
5764 counterparty_selected_channel_reserve_satoshis,
5765 holder_selected_channel_reserve_satoshis: holder_selected_channel_reserve_satoshis.unwrap(),
5766 counterparty_htlc_minimum_msat,
5767 holder_htlc_minimum_msat,
5768 counterparty_max_accepted_htlcs,
5771 counterparty_forwarding_info,
5773 channel_transaction_parameters: channel_parameters,
5774 funding_transaction,
5776 counterparty_cur_commitment_point,
5777 counterparty_prev_commitment_point,
5778 counterparty_node_id,
5780 counterparty_shutdown_scriptpubkey,
5784 channel_update_status,
5785 closing_signed_in_flight: false,
5789 #[cfg(any(test, feature = "fuzztarget"))]
5790 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5791 #[cfg(any(test, feature = "fuzztarget"))]
5792 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5794 workaround_lnd_bug_4006: None,
5796 #[cfg(any(test, feature = "fuzztarget"))]
5797 historical_inbound_htlc_fulfills,
5799 channel_type: channel_type.unwrap(),
5806 use bitcoin::util::bip143;
5807 use bitcoin::consensus::encode::serialize;
5808 use bitcoin::blockdata::script::{Script, Builder};
5809 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5810 use bitcoin::blockdata::constants::genesis_block;
5811 use bitcoin::blockdata::opcodes;
5812 use bitcoin::network::constants::Network;
5813 use bitcoin::hashes::hex::FromHex;
5815 use ln::{PaymentPreimage, PaymentHash};
5816 use ln::channelmanager::{HTLCSource, PaymentId};
5817 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5818 use ln::channel::MAX_FUNDING_SATOSHIS;
5819 use ln::features::InitFeatures;
5820 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5821 use ln::script::ShutdownScript;
5823 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5824 use chain::BestBlock;
5825 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5826 use chain::keysinterface::{InMemorySigner, KeyMaterial, KeysInterface, BaseSign};
5827 use chain::transaction::OutPoint;
5828 use util::config::UserConfig;
5829 use util::enforcing_trait_impls::EnforcingSigner;
5830 use util::errors::APIError;
5831 use util::test_utils;
5832 use util::test_utils::OnGetShutdownScriptpubkey;
5833 use util::logger::Logger;
5834 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5835 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5836 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5837 use bitcoin::secp256k1::recovery::RecoverableSignature;
5838 use bitcoin::hashes::sha256::Hash as Sha256;
5839 use bitcoin::hashes::Hash;
5840 use bitcoin::hash_types::{Txid, WPubkeyHash};
5841 use core::num::NonZeroU8;
5845 struct TestFeeEstimator {
5848 impl FeeEstimator for TestFeeEstimator {
5849 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5855 fn test_max_funding_satoshis() {
5856 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5857 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5861 signer: InMemorySigner,
5863 impl KeysInterface for Keys {
5864 type Signer = InMemorySigner;
5866 fn get_node_secret(&self) -> SecretKey { panic!(); }
5867 fn get_inbound_payment_key_material(&self) -> KeyMaterial { panic!(); }
5868 fn get_destination_script(&self) -> Script {
5869 let secp_ctx = Secp256k1::signing_only();
5870 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5871 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5872 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5875 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5876 let secp_ctx = Secp256k1::signing_only();
5877 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5878 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5881 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5884 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5885 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5886 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5889 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5890 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5894 fn upfront_shutdown_script_incompatibility() {
5895 let features = InitFeatures::known().clear_shutdown_anysegwit();
5896 let non_v0_segwit_shutdown_script =
5897 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
5899 let seed = [42; 32];
5900 let network = Network::Testnet;
5901 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5902 keys_provider.expect(OnGetShutdownScriptpubkey {
5903 returns: non_v0_segwit_shutdown_script.clone(),
5906 let fee_estimator = TestFeeEstimator { fee_est: 253 };
5907 let secp_ctx = Secp256k1::new();
5908 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5909 let config = UserConfig::default();
5910 match Channel::<EnforcingSigner>::new_outbound(&&fee_estimator, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config, 0) {
5911 Err(APIError::IncompatibleShutdownScript { script }) => {
5912 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
5914 Err(e) => panic!("Unexpected error: {:?}", e),
5915 Ok(_) => panic!("Expected error"),
5919 // Check that, during channel creation, we use the same feerate in the open channel message
5920 // as we do in the Channel object creation itself.
5922 fn test_open_channel_msg_fee() {
5923 let original_fee = 253;
5924 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5925 let secp_ctx = Secp256k1::new();
5926 let seed = [42; 32];
5927 let network = Network::Testnet;
5928 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5930 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5931 let config = UserConfig::default();
5932 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0).unwrap();
5934 // Now change the fee so we can check that the fee in the open_channel message is the
5935 // same as the old fee.
5936 fee_est.fee_est = 500;
5937 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5938 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5942 fn test_holder_vs_counterparty_dust_limit() {
5943 // Test that when calculating the local and remote commitment transaction fees, the correct
5944 // dust limits are used.
5945 let feeest = TestFeeEstimator{fee_est: 15000};
5946 let secp_ctx = Secp256k1::new();
5947 let seed = [42; 32];
5948 let network = Network::Testnet;
5949 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5950 let logger = test_utils::TestLogger::new();
5952 // Go through the flow of opening a channel between two nodes, making sure
5953 // they have different dust limits.
5955 // Create Node A's channel pointing to Node B's pubkey
5956 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5957 let config = UserConfig::default();
5958 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0).unwrap();
5960 // Create Node B's channel by receiving Node A's open_channel message
5961 // Make sure A's dust limit is as we expect.
5962 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5963 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5964 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config, 0, &&logger).unwrap();
5966 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5967 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5968 accept_channel_msg.dust_limit_satoshis = 546;
5969 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5970 node_a_chan.holder_dust_limit_satoshis = 1560;
5972 // Put some inbound and outbound HTLCs in A's channel.
5973 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5974 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5976 amount_msat: htlc_amount_msat,
5977 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5978 cltv_expiry: 300000000,
5979 state: InboundHTLCState::Committed,
5982 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5984 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5985 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5986 cltv_expiry: 200000000,
5987 state: OutboundHTLCState::Committed,
5988 source: HTLCSource::OutboundRoute {
5990 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5991 first_hop_htlc_msat: 548,
5992 payment_id: PaymentId([42; 32]),
5993 payment_secret: None,
5998 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5999 // the dust limit check.
6000 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
6001 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6002 let local_commit_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 0, node_a_chan.opt_anchors());
6003 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
6005 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
6006 // of the HTLCs are seen to be above the dust limit.
6007 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
6008 let remote_commit_fee_3_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(node_a_chan.feerate_per_kw, 3, node_a_chan.opt_anchors());
6009 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
6010 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6011 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
6015 fn test_timeout_vs_success_htlc_dust_limit() {
6016 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
6017 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
6018 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
6019 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
6020 let fee_est = TestFeeEstimator{fee_est: 253 };
6021 let secp_ctx = Secp256k1::new();
6022 let seed = [42; 32];
6023 let network = Network::Testnet;
6024 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6026 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6027 let config = UserConfig::default();
6028 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0).unwrap();
6030 let commitment_tx_fee_0_htlcs = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 0, chan.opt_anchors());
6031 let commitment_tx_fee_1_htlc = Channel::<EnforcingSigner>::commit_tx_fee_msat(chan.feerate_per_kw, 1, chan.opt_anchors());
6033 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
6034 // counted as dust when it shouldn't be.
6035 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
6036 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
6037 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6038 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
6040 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
6041 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
6042 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
6043 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
6044 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
6046 chan.channel_transaction_parameters.is_outbound_from_holder = false;
6048 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
6049 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
6050 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
6051 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6052 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
6054 // If swapped: this HTLC would be counted as dust when it shouldn't be.
6055 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
6056 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
6057 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
6058 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
6062 fn channel_reestablish_no_updates() {
6063 let feeest = TestFeeEstimator{fee_est: 15000};
6064 let logger = test_utils::TestLogger::new();
6065 let secp_ctx = Secp256k1::new();
6066 let seed = [42; 32];
6067 let network = Network::Testnet;
6068 let best_block = BestBlock::from_genesis(network);
6069 let chain_hash = best_block.block_hash();
6070 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6072 // Go through the flow of opening a channel between two nodes.
6074 // Create Node A's channel pointing to Node B's pubkey
6075 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6076 let config = UserConfig::default();
6077 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0).unwrap();
6079 // Create Node B's channel by receiving Node A's open_channel message
6080 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
6081 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
6082 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config, 0, &&logger).unwrap();
6084 // Node B --> Node A: accept channel
6085 let accept_channel_msg = node_b_chan.get_accept_channel();
6086 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
6088 // Node A --> Node B: funding created
6089 let output_script = node_a_chan.get_funding_redeemscript();
6090 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
6091 value: 10000000, script_pubkey: output_script.clone(),
6093 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
6094 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
6095 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
6097 // Node B --> Node A: funding signed
6098 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
6100 // Now disconnect the two nodes and check that the commitment point in
6101 // Node B's channel_reestablish message is sane.
6102 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
6103 let msg = node_b_chan.get_channel_reestablish(&&logger);
6104 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
6105 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
6106 match msg.data_loss_protect {
6107 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
6108 assert_eq!(your_last_per_commitment_secret, [0; 32]);
6113 // Check that the commitment point in Node A's channel_reestablish message
6115 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
6116 let msg = node_a_chan.get_channel_reestablish(&&logger);
6117 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
6118 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
6119 match msg.data_loss_protect {
6120 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
6121 assert_eq!(your_last_per_commitment_secret, [0; 32]);
6128 fn channel_update() {
6129 let feeest = TestFeeEstimator{fee_est: 15000};
6130 let secp_ctx = Secp256k1::new();
6131 let seed = [42; 32];
6132 let network = Network::Testnet;
6133 let chain_hash = genesis_block(network).header.block_hash();
6134 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
6136 // Create a channel.
6137 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6138 let config = UserConfig::default();
6139 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config, 0).unwrap();
6140 assert!(node_a_chan.counterparty_forwarding_info.is_none());
6141 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
6142 assert!(node_a_chan.counterparty_forwarding_info().is_none());
6144 // Make sure that receiving a channel update will update the Channel as expected.
6145 let update = ChannelUpdate {
6146 contents: UnsignedChannelUpdate {
6148 short_channel_id: 0,
6151 cltv_expiry_delta: 100,
6152 htlc_minimum_msat: 5,
6153 htlc_maximum_msat: OptionalField::Absent,
6155 fee_proportional_millionths: 11,
6156 excess_data: Vec::new(),
6158 signature: Signature::from(unsafe { FFISignature::new() })
6160 node_a_chan.channel_update(&update).unwrap();
6162 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
6163 // change our official htlc_minimum_msat.
6164 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
6165 match node_a_chan.counterparty_forwarding_info() {
6167 assert_eq!(info.cltv_expiry_delta, 100);
6168 assert_eq!(info.fee_base_msat, 110);
6169 assert_eq!(info.fee_proportional_millionths, 11);
6171 None => panic!("expected counterparty forwarding info to be Some")
6176 fn outbound_commitment_test() {
6177 // Test vectors from BOLT 3 Appendix C:
6178 let feeest = TestFeeEstimator{fee_est: 15000};
6179 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
6180 let secp_ctx = Secp256k1::new();
6182 let mut signer = InMemorySigner::new(
6184 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
6185 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
6186 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
6187 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
6188 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
6190 // These aren't set in the test vectors:
6191 [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],
6196 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
6197 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
6198 let keys_provider = Keys { signer: signer.clone() };
6200 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
6201 let mut config = UserConfig::default();
6202 config.channel_options.announced_channel = false;
6203 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, &InitFeatures::known(), 10_000_000, 100000, 42, &config, 0).unwrap(); // Nothing uses their network key in this test
6204 chan.holder_dust_limit_satoshis = 546;
6205 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
6207 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
6209 let counterparty_pubkeys = ChannelPublicKeys {
6210 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
6211 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
6212 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
6213 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
6214 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
6216 chan.channel_transaction_parameters.counterparty_parameters = Some(
6217 CounterpartyChannelTransactionParameters {
6218 pubkeys: counterparty_pubkeys.clone(),
6219 selected_contest_delay: 144
6221 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
6222 signer.ready_channel(&chan.channel_transaction_parameters);
6224 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
6225 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
6227 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
6228 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
6230 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
6231 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
6233 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
6234 // derived from a commitment_seed, so instead we copy it here and call
6235 // build_commitment_transaction.
6236 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
6237 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6238 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6239 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
6240 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
6242 macro_rules! test_commitment {
6243 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
6244 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
6246 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
6247 let mut commitment_stats = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
6249 let htlcs = commitment_stats.htlcs_included.drain(..)
6250 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
6252 (commitment_stats.tx, htlcs)
6254 let trusted_tx = commitment_tx.trust();
6255 let unsigned_tx = trusted_tx.built_transaction();
6256 let redeemscript = chan.get_funding_redeemscript();
6257 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
6258 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
6259 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
6261 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
6262 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
6263 let mut counterparty_htlc_sigs = Vec::new();
6264 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
6266 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
6267 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
6268 counterparty_htlc_sigs.push(remote_signature);
6270 assert_eq!(htlcs.len(), per_htlc.len());
6272 let holder_commitment_tx = HolderCommitmentTransaction::new(
6273 commitment_tx.clone(),
6274 counterparty_signature,
6275 counterparty_htlc_sigs,
6276 &chan.holder_signer.pubkeys().funding_pubkey,
6277 chan.counterparty_funding_pubkey()
6279 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
6280 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
6282 let funding_redeemscript = chan.get_funding_redeemscript();
6283 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
6284 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
6286 // ((htlc, counterparty_sig), (index, holder_sig))
6287 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
6290 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
6292 let ref htlc = htlcs[$htlc_idx];
6293 let opt_anchors = false;
6294 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
6295 chan.get_counterparty_selected_contest_delay().unwrap(),
6296 &htlc, opt_anchors, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
6297 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, opt_anchors, &keys);
6298 let htlc_sighashtype = if opt_anchors { SigHashType::SinglePlusAnyoneCanPay } else { SigHashType::All };
6299 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype)[..]).unwrap();
6300 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
6302 let mut preimage: Option<PaymentPreimage> = None;
6305 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
6306 if out == htlc.payment_hash {
6307 preimage = Some(PaymentPreimage([i; 32]));
6311 assert!(preimage.is_some());
6314 let htlc_sig = htlc_sig_iter.next().unwrap();
6315 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
6317 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
6318 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
6319 let index = (htlc_sig.1).0;
6320 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
6321 let trusted_tx = holder_commitment_tx.trust();
6322 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
6323 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
6325 assert!(htlc_sig_iter.next().is_none());
6329 // simple commitment tx with no HTLCs
6330 chan.value_to_self_msat = 7000000000;
6332 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
6333 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
6334 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6336 chan.pending_inbound_htlcs.push({
6337 let mut out = InboundHTLCOutput{
6339 amount_msat: 1000000,
6341 payment_hash: PaymentHash([0; 32]),
6342 state: InboundHTLCState::Committed,
6344 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
6347 chan.pending_inbound_htlcs.push({
6348 let mut out = InboundHTLCOutput{
6350 amount_msat: 2000000,
6352 payment_hash: PaymentHash([0; 32]),
6353 state: InboundHTLCState::Committed,
6355 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6358 chan.pending_outbound_htlcs.push({
6359 let mut out = OutboundHTLCOutput{
6361 amount_msat: 2000000,
6363 payment_hash: PaymentHash([0; 32]),
6364 state: OutboundHTLCState::Committed,
6365 source: HTLCSource::dummy(),
6367 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
6370 chan.pending_outbound_htlcs.push({
6371 let mut out = OutboundHTLCOutput{
6373 amount_msat: 3000000,
6375 payment_hash: PaymentHash([0; 32]),
6376 state: OutboundHTLCState::Committed,
6377 source: HTLCSource::dummy(),
6379 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
6382 chan.pending_inbound_htlcs.push({
6383 let mut out = InboundHTLCOutput{
6385 amount_msat: 4000000,
6387 payment_hash: PaymentHash([0; 32]),
6388 state: InboundHTLCState::Committed,
6390 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
6394 // commitment tx with all five HTLCs untrimmed (minimum feerate)
6395 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6396 chan.feerate_per_kw = 0;
6398 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
6399 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
6400 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6403 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
6404 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
6405 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6408 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
6409 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
6410 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6413 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
6414 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
6415 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6418 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
6419 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
6420 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6423 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
6424 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
6425 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6428 // commitment tx with seven outputs untrimmed (maximum feerate)
6429 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6430 chan.feerate_per_kw = 647;
6432 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
6433 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
6434 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6437 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
6438 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
6439 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6442 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
6443 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
6444 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6447 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
6448 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
6449 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6452 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
6453 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
6454 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6457 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
6458 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
6459 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6462 // commitment tx with six outputs untrimmed (minimum feerate)
6463 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6464 chan.feerate_per_kw = 648;
6466 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
6467 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
6468 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6471 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
6472 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
6473 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6476 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
6477 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
6478 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6481 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
6482 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
6483 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6486 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
6487 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
6488 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6491 // commitment tx with six outputs untrimmed (maximum feerate)
6492 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6493 chan.feerate_per_kw = 2069;
6495 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
6496 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
6497 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6500 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
6501 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
6502 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6505 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
6506 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
6507 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6510 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
6511 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
6512 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6515 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
6516 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
6517 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6520 // commitment tx with five outputs untrimmed (minimum feerate)
6521 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6522 chan.feerate_per_kw = 2070;
6524 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
6525 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
6526 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6529 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
6530 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
6531 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6534 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
6535 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
6536 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6539 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
6540 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
6541 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6544 // commitment tx with five outputs untrimmed (maximum feerate)
6545 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6546 chan.feerate_per_kw = 2194;
6548 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
6549 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
6550 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6553 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
6554 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
6555 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6558 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
6559 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
6560 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6563 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
6564 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
6565 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6568 // commitment tx with four outputs untrimmed (minimum feerate)
6569 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6570 chan.feerate_per_kw = 2195;
6572 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
6573 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
6574 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6577 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
6578 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
6579 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6582 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
6583 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
6584 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6587 // commitment tx with four outputs untrimmed (maximum feerate)
6588 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6589 chan.feerate_per_kw = 3702;
6591 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
6592 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
6593 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6596 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
6597 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
6598 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6601 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
6602 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
6603 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6606 // commitment tx with three outputs untrimmed (minimum feerate)
6607 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6608 chan.feerate_per_kw = 3703;
6610 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
6611 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
6612 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6615 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
6616 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
6617 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6620 // commitment tx with three outputs untrimmed (maximum feerate)
6621 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6622 chan.feerate_per_kw = 4914;
6624 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
6625 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
6626 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6629 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
6630 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
6631 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6634 // commitment tx with two outputs untrimmed (minimum feerate)
6635 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6636 chan.feerate_per_kw = 4915;
6638 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
6639 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
6640 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6642 // commitment tx with two outputs untrimmed (maximum feerate)
6643 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6644 chan.feerate_per_kw = 9651180;
6646 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
6647 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
6648 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6650 // commitment tx with one output untrimmed (minimum feerate)
6651 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6652 chan.feerate_per_kw = 9651181;
6654 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6655 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6656 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6658 // commitment tx with fee greater than funder amount
6659 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6660 chan.feerate_per_kw = 9651936;
6662 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6663 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6664 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6666 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
6667 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
6668 chan.feerate_per_kw = 253;
6669 chan.pending_inbound_htlcs.clear();
6670 chan.pending_inbound_htlcs.push({
6671 let mut out = InboundHTLCOutput{
6673 amount_msat: 2000000,
6675 payment_hash: PaymentHash([0; 32]),
6676 state: InboundHTLCState::Committed,
6678 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6681 chan.pending_outbound_htlcs.clear();
6682 chan.pending_outbound_htlcs.push({
6683 let mut out = OutboundHTLCOutput{
6685 amount_msat: 5000000,
6687 payment_hash: PaymentHash([0; 32]),
6688 state: OutboundHTLCState::Committed,
6689 source: HTLCSource::dummy(),
6691 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6694 chan.pending_outbound_htlcs.push({
6695 let mut out = OutboundHTLCOutput{
6697 amount_msat: 5000000,
6699 payment_hash: PaymentHash([0; 32]),
6700 state: OutboundHTLCState::Committed,
6701 source: HTLCSource::dummy(),
6703 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6707 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6708 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6709 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6712 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6713 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6714 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6716 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6717 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6718 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6720 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6721 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6722 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6727 fn test_per_commitment_secret_gen() {
6728 // Test vectors from BOLT 3 Appendix D:
6730 let mut seed = [0; 32];
6731 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6732 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6733 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6735 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6736 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6737 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6739 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6740 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6742 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6743 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6745 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6746 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6747 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6751 fn test_key_derivation() {
6752 // Test vectors from BOLT 3 Appendix E:
6753 let secp_ctx = Secp256k1::new();
6755 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6756 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6758 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6759 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6761 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6762 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6764 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6765 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6767 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6768 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6770 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6771 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6773 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6774 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());