1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
12 use bitcoin::util::bip143;
13 use bitcoin::consensus::encode;
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, InitFeatures};
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::ShutdownScript;
30 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor};
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::transaction_utils;
39 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
40 use util::logger::Logger;
41 use util::errors::APIError;
42 use util::config::{UserConfig,ChannelConfig};
43 use util::scid_utils::scid_from_parts;
47 use core::{cmp,mem,fmt};
48 use core::convert::TryFrom;
50 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
52 use bitcoin::hashes::hex::ToHex;
55 pub struct ChannelValueStat {
56 pub value_to_self_msat: u64,
57 pub channel_value_msat: u64,
58 pub channel_reserve_msat: u64,
59 pub pending_outbound_htlcs_amount_msat: u64,
60 pub pending_inbound_htlcs_amount_msat: u64,
61 pub holding_cell_outbound_amount_msat: u64,
62 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
63 pub counterparty_dust_limit_msat: u64,
66 #[derive(Clone, Copy, PartialEq)]
68 // Inbound states mirroring InboundHTLCState
70 AwaitingRemoteRevokeToAnnounce,
71 // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
72 // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
73 // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
74 // the fee update anywhere, we can simply consider the fee update `Committed` immediately
75 // instead of setting it to AwaitingAnnouncedRemoteRevoke.
77 // Outbound state can only be `LocalAnnounced` or `Committed`
81 enum InboundHTLCRemovalReason {
82 FailRelay(msgs::OnionErrorPacket),
83 FailMalformed(([u8; 32], u16)),
84 Fulfill(PaymentPreimage),
87 enum InboundHTLCState {
88 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
89 /// update_add_htlc message for this HTLC.
90 RemoteAnnounced(PendingHTLCStatus),
91 /// Included in a received commitment_signed message (implying we've
92 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
93 /// state (see the example below). We have not yet included this HTLC in a
94 /// commitment_signed message because we are waiting on the remote's
95 /// aforementioned state revocation. One reason this missing remote RAA
96 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
97 /// is because every time we create a new "state", i.e. every time we sign a
98 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
99 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
100 /// sent provided the per_commitment_point for our current commitment tx.
101 /// The other reason we should not send a commitment_signed without their RAA
102 /// is because their RAA serves to ACK our previous commitment_signed.
104 /// Here's an example of how an HTLC could come to be in this state:
105 /// remote --> update_add_htlc(prev_htlc) --> local
106 /// remote --> commitment_signed(prev_htlc) --> local
107 /// remote <-- revoke_and_ack <-- local
108 /// remote <-- commitment_signed(prev_htlc) <-- local
109 /// [note that here, the remote does not respond with a RAA]
110 /// remote --> update_add_htlc(this_htlc) --> local
111 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
112 /// Now `this_htlc` will be assigned this state. It's unable to be officially
113 /// accepted, i.e. included in a commitment_signed, because we're missing the
114 /// RAA that provides our next per_commitment_point. The per_commitment_point
115 /// is used to derive commitment keys, which are used to construct the
116 /// signatures in a commitment_signed message.
117 /// Implies AwaitingRemoteRevoke.
119 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
120 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
121 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
122 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
123 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
124 /// channel (before it can then get forwarded and/or removed).
125 /// Implies AwaitingRemoteRevoke.
126 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
128 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
129 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
131 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
132 /// commitment transaction without it as otherwise we'll have to force-close the channel to
133 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
134 /// anyway). That said, ChannelMonitor does this for us (see
135 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
136 /// our own local state before then, once we're sure that the next commitment_signed and
137 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
138 LocalRemoved(InboundHTLCRemovalReason),
141 struct InboundHTLCOutput {
145 payment_hash: PaymentHash,
146 state: InboundHTLCState,
149 enum OutboundHTLCState {
150 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
151 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
152 /// we will promote to Committed (note that they may not accept it until the next time we
153 /// revoke, but we don't really care about that:
154 /// * they've revoked, so worst case we can announce an old state and get our (option on)
155 /// money back (though we won't), and,
156 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
157 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
158 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
159 /// we'll never get out of sync).
160 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
161 /// OutboundHTLCOutput's size just for a temporary bit
162 LocalAnnounced(Box<msgs::OnionPacket>),
164 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
165 /// the change (though they'll need to revoke before we fail the payment).
166 RemoteRemoved(Option<HTLCFailReason>),
167 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
168 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
169 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
170 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
171 /// remote revoke_and_ack on a previous state before we can do so.
172 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
173 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
174 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
175 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
176 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
177 /// revoke_and_ack to drop completely.
178 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
181 struct OutboundHTLCOutput {
185 payment_hash: PaymentHash,
186 state: OutboundHTLCState,
190 /// See AwaitingRemoteRevoke ChannelState for more info
191 enum HTLCUpdateAwaitingACK {
192 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
196 payment_hash: PaymentHash,
198 onion_routing_packet: msgs::OnionPacket,
201 payment_preimage: PaymentPreimage,
206 err_packet: msgs::OnionErrorPacket,
210 /// There are a few "states" and then a number of flags which can be applied:
211 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
212 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
213 /// move on to ChannelFunded.
214 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
215 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
216 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
218 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
219 OurInitSent = 1 << 0,
220 /// Implies we have received their open_channel/accept_channel message
221 TheirInitSent = 1 << 1,
222 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
223 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
224 /// upon receipt of funding_created, so simply skip this state.
226 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
227 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
228 /// and our counterparty consider the funding transaction confirmed.
230 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
231 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
232 TheirFundingLocked = 1 << 4,
233 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
234 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
235 OurFundingLocked = 1 << 5,
237 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
238 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
240 PeerDisconnected = 1 << 7,
241 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
242 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
243 /// outbound messages until they've managed to do so.
244 MonitorUpdateFailed = 1 << 8,
245 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
246 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
247 /// messages as then we will be unable to determine which HTLCs they included in their
248 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
250 /// Flag is set on ChannelFunded.
251 AwaitingRemoteRevoke = 1 << 9,
252 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
253 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
254 /// to respond with our own shutdown message when possible.
255 RemoteShutdownSent = 1 << 10,
256 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
257 /// point, we may not add any new HTLCs to the channel.
258 LocalShutdownSent = 1 << 11,
259 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
260 /// to drop us, but we store this anyway.
261 ShutdownComplete = 4096,
263 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
264 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
266 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
268 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
269 /// our counterparty or not. However, we don't want to announce updates right away to avoid
270 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
271 /// our channel_update message and track the current state here.
272 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
273 #[derive(Clone, Copy, PartialEq)]
274 pub(super) enum ChannelUpdateStatus {
275 /// We've announced the channel as enabled and are connected to our peer.
277 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
279 /// Our channel is live again, but we haven't announced the channel as enabled yet.
281 /// We've announced the channel as disabled.
285 /// An enum indicating whether the local or remote side offered a given HTLC.
291 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
294 pending_htlcs_value_msat: u64,
295 on_counterparty_tx_dust_exposure_msat: u64,
296 on_holder_tx_dust_exposure_msat: u64,
299 /// Used when calculating whether we or the remote can afford an additional HTLC.
300 struct HTLCCandidate {
302 origin: HTLCInitiator,
306 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
314 /// Information needed for constructing an invoice route hint for this channel.
315 #[derive(Clone, Debug, PartialEq)]
316 pub struct CounterpartyForwardingInfo {
317 /// Base routing fee in millisatoshis.
318 pub fee_base_msat: u32,
319 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
320 pub fee_proportional_millionths: u32,
321 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
322 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
323 /// `cltv_expiry_delta` for more details.
324 pub cltv_expiry_delta: u16,
327 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
329 enum UpdateFulfillFetch {
331 monitor_update: ChannelMonitorUpdate,
332 htlc_value_msat: u64,
333 msg: Option<msgs::UpdateFulfillHTLC>,
338 /// The return type of get_update_fulfill_htlc_and_commit.
339 pub enum UpdateFulfillCommitFetch {
340 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
341 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
342 /// previously placed in the holding cell (and has since been removed).
344 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
345 monitor_update: ChannelMonitorUpdate,
346 /// The value of the HTLC which was claimed, in msat.
347 htlc_value_msat: u64,
348 /// The update_fulfill message and commitment_signed message (if the claim was not placed
349 /// in the holding cell).
350 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
352 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
353 /// or has been forgotten (presumably previously claimed).
357 /// If the majority of the channels funds are to the fundee and the initiator holds only just
358 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
359 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
360 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
361 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
362 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
363 /// by this multiple without hitting this case, before sending.
364 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
365 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
366 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
367 /// leave the channel less usable as we hold a bigger reserve.
369 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
371 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
373 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
374 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
375 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
378 // Holder designates channel data owned for the benefice of the user client.
379 // Counterparty designates channel data owned by the another channel participant entity.
380 pub(super) struct Channel<Signer: Sign> {
381 #[cfg(any(test, feature = "_test_utils"))]
382 pub(crate) config: ChannelConfig,
383 #[cfg(not(any(test, feature = "_test_utils")))]
384 config: ChannelConfig,
388 channel_id: [u8; 32],
390 secp_ctx: Secp256k1<secp256k1::All>,
391 channel_value_satoshis: u64,
393 latest_monitor_update_id: u64,
395 holder_signer: Signer,
396 shutdown_scriptpubkey: Option<ShutdownScript>,
397 destination_script: Script,
399 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
400 // generation start at 0 and count up...this simplifies some parts of implementation at the
401 // cost of others, but should really just be changed.
403 cur_holder_commitment_transaction_number: u64,
404 cur_counterparty_commitment_transaction_number: u64,
405 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
406 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
407 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
408 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
410 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
411 /// need to ensure we resend them in the order we originally generated them. Note that because
412 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
413 /// sufficient to simply set this to the opposite of any message we are generating as we
414 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
415 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
417 resend_order: RAACommitmentOrder,
419 monitor_pending_funding_locked: bool,
420 monitor_pending_revoke_and_ack: bool,
421 monitor_pending_commitment_signed: bool,
422 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
423 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
425 // pending_update_fee is filled when sending and receiving update_fee
426 // For outbound channel, feerate_per_kw is updated with the value from
427 // pending_update_fee when revoke_and_ack is received
429 // For inbound channel, feerate_per_kw is updated when it receives
430 // commitment_signed and revoke_and_ack is generated
431 // The pending value is kept when another pair of update_fee and commitment_signed
432 // is received during AwaitingRemoteRevoke and relieved when the expected
433 // revoke_and_ack is received and new commitment_signed is generated to be
434 // sent to the funder. Otherwise, the pending value is removed when receiving
435 // commitment_signed.
436 pending_update_fee: Option<(u32, FeeUpdateState)>,
437 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
438 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
439 // is received. holding_cell_update_fee is updated when there are additional
440 // update_fee() during ChannelState::AwaitingRemoteRevoke.
441 holding_cell_update_fee: Option<u32>,
442 next_holder_htlc_id: u64,
443 next_counterparty_htlc_id: u64,
444 update_time_counter: u32,
447 #[cfg(debug_assertions)]
448 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
449 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
450 #[cfg(debug_assertions)]
451 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
452 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
454 last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
455 target_closing_feerate_sats_per_kw: Option<u32>,
457 /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
458 /// update, we need to delay processing it until later. We do that here by simply storing the
459 /// closing_signed message and handling it in `maybe_propose_closing_signed`.
460 pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
462 /// The minimum and maximum absolute fee we are willing to place on the closing transaction.
463 /// These are set once we reach `closing_negotiation_ready`.
465 pub(crate) closing_fee_limits: Option<(u64, u64)>,
467 closing_fee_limits: Option<(u64, u64)>,
469 /// The hash of the block in which the funding transaction was included.
470 funding_tx_confirmed_in: Option<BlockHash>,
471 funding_tx_confirmation_height: u32,
472 short_channel_id: Option<u64>,
474 counterparty_dust_limit_satoshis: u64,
476 pub(super) holder_dust_limit_satoshis: u64,
478 holder_dust_limit_satoshis: u64,
480 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
482 counterparty_max_htlc_value_in_flight_msat: u64,
483 //get_holder_max_htlc_value_in_flight_msat(): u64,
484 /// minimum channel reserve for self to maintain - set by them.
485 counterparty_selected_channel_reserve_satoshis: Option<u64>,
486 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
487 counterparty_htlc_minimum_msat: u64,
488 holder_htlc_minimum_msat: u64,
490 pub counterparty_max_accepted_htlcs: u16,
492 counterparty_max_accepted_htlcs: u16,
493 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
494 minimum_depth: Option<u32>,
496 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
498 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
499 funding_transaction: Option<Transaction>,
501 counterparty_cur_commitment_point: Option<PublicKey>,
502 counterparty_prev_commitment_point: Option<PublicKey>,
503 counterparty_node_id: PublicKey,
505 counterparty_shutdown_scriptpubkey: Option<Script>,
507 commitment_secrets: CounterpartyCommitmentSecrets,
509 channel_update_status: ChannelUpdateStatus,
510 /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
511 /// not complete within a single timer tick (one minute), we should force-close the channel.
512 /// This prevents us from keeping unusable channels around forever if our counterparty wishes
514 /// Note that this field is reset to false on deserialization to give us a chance to connect to
515 /// our peer and start the closing_signed negotiation fresh.
516 closing_signed_in_flight: bool,
518 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
519 /// This can be used to rebroadcast the channel_announcement message later.
520 announcement_sigs: Option<(Signature, Signature)>,
522 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
523 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
524 // be, by comparing the cached values to the fee of the tranaction generated by
525 // `build_commitment_transaction`.
526 #[cfg(any(test, feature = "fuzztarget"))]
527 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
528 #[cfg(any(test, feature = "fuzztarget"))]
529 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
531 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
532 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
533 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
534 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
535 /// message until we receive a channel_reestablish.
537 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
538 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
540 #[cfg(any(test, feature = "fuzztarget"))]
541 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
542 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
543 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
544 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
545 // is fine, but as a sanity check in our failure to generate the second claim, we check here
546 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
547 historical_inbound_htlc_fulfills: HashSet<u64>,
550 #[cfg(any(test, feature = "fuzztarget"))]
551 struct CommitmentTxInfoCached {
553 total_pending_htlcs: usize,
554 next_holder_htlc_id: u64,
555 next_counterparty_htlc_id: u64,
559 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
562 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
564 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
566 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
568 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
570 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
572 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
574 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
575 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
576 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
577 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
578 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
579 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
580 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
581 /// upper bound to avoid negotiation conflicts with other implementations.
582 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
584 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
585 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
586 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
587 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
588 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
590 /// Used to return a simple Error back to ChannelManager. Will get converted to a
591 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
592 /// channel_id in ChannelManager.
593 pub(super) enum ChannelError {
597 CloseDelayBroadcast(String),
600 impl fmt::Debug for ChannelError {
601 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
603 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
604 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
605 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
606 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
611 macro_rules! secp_check {
612 ($res: expr, $err: expr) => {
615 Err(_) => return Err(ChannelError::Close($err)),
620 impl<Signer: Sign> Channel<Signer> {
621 // Convert constants + channel value to limits:
622 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
623 channel_value_satoshis * 1000 / 10 //TODO
626 /// Returns a minimum channel reserve value the remote needs to maintain,
629 /// Guaranteed to return a value no larger than channel_value_satoshis
630 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
631 let (q, _) = channel_value_satoshis.overflowing_div(100);
632 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
636 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
637 where K::Target: KeysInterface<Signer = Signer>,
638 F::Target: FeeEstimator,
640 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
641 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
642 let pubkeys = holder_signer.pubkeys().clone();
644 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
645 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
647 let channel_value_msat = channel_value_satoshis * 1000;
648 if push_msat > channel_value_msat {
649 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
651 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
652 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
654 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
655 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
656 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
659 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
661 let mut secp_ctx = Secp256k1::new();
662 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
664 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
665 Some(keys_provider.get_shutdown_scriptpubkey())
668 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
669 if !shutdown_scriptpubkey.is_compatible(&their_features) {
670 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
676 config: config.channel_options.clone(),
678 channel_id: keys_provider.get_secure_random_bytes(),
679 channel_state: ChannelState::OurInitSent as u32,
681 channel_value_satoshis,
683 latest_monitor_update_id: 0,
686 shutdown_scriptpubkey,
687 destination_script: keys_provider.get_destination_script(),
689 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
690 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
691 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
693 pending_inbound_htlcs: Vec::new(),
694 pending_outbound_htlcs: Vec::new(),
695 holding_cell_htlc_updates: Vec::new(),
696 pending_update_fee: None,
697 holding_cell_update_fee: None,
698 next_holder_htlc_id: 0,
699 next_counterparty_htlc_id: 0,
700 update_time_counter: 1,
702 resend_order: RAACommitmentOrder::CommitmentFirst,
704 monitor_pending_funding_locked: false,
705 monitor_pending_revoke_and_ack: false,
706 monitor_pending_commitment_signed: false,
707 monitor_pending_forwards: Vec::new(),
708 monitor_pending_failures: Vec::new(),
710 #[cfg(debug_assertions)]
711 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
712 #[cfg(debug_assertions)]
713 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
715 last_sent_closing_fee: None,
716 pending_counterparty_closing_signed: None,
717 closing_fee_limits: None,
718 target_closing_feerate_sats_per_kw: None,
720 funding_tx_confirmed_in: None,
721 funding_tx_confirmation_height: 0,
722 short_channel_id: None,
724 feerate_per_kw: feerate,
725 counterparty_dust_limit_satoshis: 0,
726 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
727 counterparty_max_htlc_value_in_flight_msat: 0,
728 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
729 counterparty_htlc_minimum_msat: 0,
730 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
731 counterparty_max_accepted_htlcs: 0,
732 minimum_depth: None, // Filled in in accept_channel
734 counterparty_forwarding_info: None,
736 channel_transaction_parameters: ChannelTransactionParameters {
737 holder_pubkeys: pubkeys,
738 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
739 is_outbound_from_holder: true,
740 counterparty_parameters: None,
741 funding_outpoint: None
743 funding_transaction: None,
745 counterparty_cur_commitment_point: None,
746 counterparty_prev_commitment_point: None,
747 counterparty_node_id,
749 counterparty_shutdown_scriptpubkey: None,
751 commitment_secrets: CounterpartyCommitmentSecrets::new(),
753 channel_update_status: ChannelUpdateStatus::Enabled,
754 closing_signed_in_flight: false,
756 announcement_sigs: None,
758 #[cfg(any(test, feature = "fuzztarget"))]
759 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
760 #[cfg(any(test, feature = "fuzztarget"))]
761 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
763 workaround_lnd_bug_4006: None,
765 #[cfg(any(test, feature = "fuzztarget"))]
766 historical_inbound_htlc_fulfills: HashSet::new(),
770 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
771 where F::Target: FeeEstimator
773 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
774 if feerate_per_kw < lower_limit {
775 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
777 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
778 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
779 // We generally don't care too much if they set the feerate to something very high, but it
780 // could result in the channel being useless due to everything being dust.
781 let upper_limit = cmp::max(250 * 25,
782 fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
783 if feerate_per_kw as u64 > upper_limit {
784 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
789 /// Creates a new channel from a remote sides' request for one.
790 /// Assumes chain_hash has already been checked and corresponds with what we expect!
791 pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: &InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, ChannelError>
792 where K::Target: KeysInterface<Signer = Signer>,
793 F::Target: FeeEstimator
795 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
796 let pubkeys = holder_signer.pubkeys().clone();
797 let counterparty_pubkeys = ChannelPublicKeys {
798 funding_pubkey: msg.funding_pubkey,
799 revocation_basepoint: msg.revocation_basepoint,
800 payment_point: msg.payment_point,
801 delayed_payment_basepoint: msg.delayed_payment_basepoint,
802 htlc_basepoint: msg.htlc_basepoint
804 let mut local_config = (*config).channel_options.clone();
806 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
807 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)));
810 // Check sanity of message fields:
811 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
812 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
814 if msg.channel_reserve_satoshis > msg.funding_satoshis {
815 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
817 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
818 if msg.push_msat > funding_value {
819 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
821 if msg.dust_limit_satoshis > msg.funding_satoshis {
822 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)));
824 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
825 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
827 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
828 if msg.htlc_minimum_msat >= full_channel_value_msat {
829 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
831 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
833 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
834 if msg.to_self_delay > max_counterparty_selected_contest_delay {
835 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)));
837 if msg.max_accepted_htlcs < 1 {
838 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
840 if msg.max_accepted_htlcs > MAX_HTLCS {
841 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
844 // Now check against optional parameters as set by config...
845 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
846 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)));
848 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
849 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)));
851 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
852 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)));
854 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
855 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)));
857 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
858 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)));
860 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
861 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
863 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
864 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
867 // Convert things into internal flags and prep our state:
869 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
870 if config.peer_channel_config_limits.force_announced_channel_preference {
871 if local_config.announced_channel != announce {
872 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
875 // we either accept their preference or the preferences match
876 local_config.announced_channel = announce;
878 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
880 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
881 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
882 return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
884 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
885 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
887 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
888 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)));
891 // check if the funder's amount for the initial commitment tx is sufficient
892 // for full fee payment
893 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
894 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
895 if funders_amount_msat < lower_limit {
896 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
899 let to_local_msat = msg.push_msat;
900 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
901 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
902 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
905 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
906 match &msg.shutdown_scriptpubkey {
907 &OptionalField::Present(ref script) => {
908 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
909 if script.len() == 0 {
912 match ShutdownScript::try_from((script.clone(), their_features)) {
913 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
914 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
918 // 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
919 &OptionalField::Absent => {
920 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()));
925 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
926 Some(keys_provider.get_shutdown_scriptpubkey())
929 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
930 if !shutdown_scriptpubkey.is_compatible(&their_features) {
931 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
935 let mut secp_ctx = Secp256k1::new();
936 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
940 config: local_config,
942 channel_id: msg.temporary_channel_id,
943 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
946 latest_monitor_update_id: 0,
949 shutdown_scriptpubkey,
950 destination_script: keys_provider.get_destination_script(),
952 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
953 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
954 value_to_self_msat: msg.push_msat,
956 pending_inbound_htlcs: Vec::new(),
957 pending_outbound_htlcs: Vec::new(),
958 holding_cell_htlc_updates: Vec::new(),
959 pending_update_fee: None,
960 holding_cell_update_fee: None,
961 next_holder_htlc_id: 0,
962 next_counterparty_htlc_id: 0,
963 update_time_counter: 1,
965 resend_order: RAACommitmentOrder::CommitmentFirst,
967 monitor_pending_funding_locked: false,
968 monitor_pending_revoke_and_ack: false,
969 monitor_pending_commitment_signed: false,
970 monitor_pending_forwards: Vec::new(),
971 monitor_pending_failures: Vec::new(),
973 #[cfg(debug_assertions)]
974 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
975 #[cfg(debug_assertions)]
976 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
978 last_sent_closing_fee: None,
979 pending_counterparty_closing_signed: None,
980 closing_fee_limits: None,
981 target_closing_feerate_sats_per_kw: None,
983 funding_tx_confirmed_in: None,
984 funding_tx_confirmation_height: 0,
985 short_channel_id: None,
987 feerate_per_kw: msg.feerate_per_kw,
988 channel_value_satoshis: msg.funding_satoshis,
989 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
990 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
991 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
992 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
993 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
994 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
995 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
996 minimum_depth: Some(config.own_channel_config.minimum_depth),
998 counterparty_forwarding_info: None,
1000 channel_transaction_parameters: ChannelTransactionParameters {
1001 holder_pubkeys: pubkeys,
1002 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
1003 is_outbound_from_holder: false,
1004 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
1005 selected_contest_delay: msg.to_self_delay,
1006 pubkeys: counterparty_pubkeys,
1008 funding_outpoint: None
1010 funding_transaction: None,
1012 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
1013 counterparty_prev_commitment_point: None,
1014 counterparty_node_id,
1016 counterparty_shutdown_scriptpubkey,
1018 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1020 channel_update_status: ChannelUpdateStatus::Enabled,
1021 closing_signed_in_flight: false,
1023 announcement_sigs: None,
1025 #[cfg(any(test, feature = "fuzztarget"))]
1026 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1027 #[cfg(any(test, feature = "fuzztarget"))]
1028 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1030 workaround_lnd_bug_4006: None,
1032 #[cfg(any(test, feature = "fuzztarget"))]
1033 historical_inbound_htlc_fulfills: HashSet::new(),
1039 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1040 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1041 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1042 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1043 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1045 /// @local is used only to convert relevant internal structures which refer to remote vs local
1046 /// to decide value of outputs and direction of HTLCs.
1047 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1048 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1049 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1050 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1051 /// which peer generated this transaction and "to whom" this transaction flows.
1052 /// Returns (the transaction info, the number of HTLC outputs which were present in the
1053 /// transaction, the list of HTLCs which were not ignored when building the transaction).
1054 /// Note that below-dust HTLCs are included in the fourth return value, but not the third, and
1055 /// sources are provided only for outbound HTLCs in the fourth return value.
1057 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, logger: &L) -> (CommitmentTransaction, u32, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
1058 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1059 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1060 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1062 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1063 let mut remote_htlc_total_msat = 0;
1064 let mut local_htlc_total_msat = 0;
1065 let mut value_to_self_msat_offset = 0;
1067 let mut feerate_per_kw = self.feerate_per_kw;
1068 if let Some((feerate, update_state)) = self.pending_update_fee {
1069 if match update_state {
1070 // Note that these match the inclusion criteria when scanning
1071 // pending_inbound_htlcs below.
1072 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1073 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1074 FeeUpdateState::Outbound => { assert!(self.is_outbound()); generated_by_local },
1076 feerate_per_kw = feerate;
1080 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1081 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1082 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1083 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1085 macro_rules! get_htlc_in_commitment {
1086 ($htlc: expr, $offered: expr) => {
1087 HTLCOutputInCommitment {
1089 amount_msat: $htlc.amount_msat,
1090 cltv_expiry: $htlc.cltv_expiry,
1091 payment_hash: $htlc.payment_hash,
1092 transaction_output_index: None
1097 macro_rules! add_htlc_output {
1098 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1099 if $outbound == local { // "offered HTLC output"
1100 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1101 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1102 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);
1103 included_non_dust_htlcs.push((htlc_in_tx, $source));
1105 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);
1106 included_dust_htlcs.push((htlc_in_tx, $source));
1109 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1110 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1111 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);
1112 included_non_dust_htlcs.push((htlc_in_tx, $source));
1114 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);
1115 included_dust_htlcs.push((htlc_in_tx, $source));
1121 for ref htlc in self.pending_inbound_htlcs.iter() {
1122 let (include, state_name) = match htlc.state {
1123 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1124 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1125 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1126 InboundHTLCState::Committed => (true, "Committed"),
1127 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1131 add_htlc_output!(htlc, false, None, state_name);
1132 remote_htlc_total_msat += htlc.amount_msat;
1134 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);
1136 &InboundHTLCState::LocalRemoved(ref reason) => {
1137 if generated_by_local {
1138 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1139 value_to_self_msat_offset += htlc.amount_msat as i64;
1148 for ref htlc in self.pending_outbound_htlcs.iter() {
1149 let (include, state_name) = match htlc.state {
1150 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1151 OutboundHTLCState::Committed => (true, "Committed"),
1152 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1153 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1154 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1158 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1159 local_htlc_total_msat += htlc.amount_msat;
1161 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);
1163 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1164 value_to_self_msat_offset -= htlc.amount_msat as i64;
1166 OutboundHTLCState::RemoteRemoved(None) => {
1167 if !generated_by_local {
1168 value_to_self_msat_offset -= htlc.amount_msat as i64;
1176 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1177 assert!(value_to_self_msat >= 0);
1178 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1179 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1180 // "violate" their reserve value by couting those against it. Thus, we have to convert
1181 // everything to i64 before subtracting as otherwise we can overflow.
1182 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
1183 assert!(value_to_remote_msat >= 0);
1185 #[cfg(debug_assertions)]
1187 // Make sure that the to_self/to_remote is always either past the appropriate
1188 // channel_reserve *or* it is making progress towards it.
1189 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1190 self.holder_max_commitment_tx_output.lock().unwrap()
1192 self.counterparty_max_commitment_tx_output.lock().unwrap()
1194 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);
1195 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1196 debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
1197 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1200 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (included_non_dust_htlcs.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1201 let (value_to_self, value_to_remote) = if self.is_outbound() {
1202 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1204 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1207 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1208 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1210 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1211 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1216 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1217 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1222 let num_nondust_htlcs = included_non_dust_htlcs.len();
1224 let channel_parameters =
1225 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1226 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1227 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1232 &mut included_non_dust_htlcs,
1235 let mut htlcs_included = included_non_dust_htlcs;
1236 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1237 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1238 htlcs_included.append(&mut included_dust_htlcs);
1240 (tx, feerate_per_kw, num_nondust_htlcs, htlcs_included)
1244 fn get_closing_scriptpubkey(&self) -> Script {
1245 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1246 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1247 // outside of those situations will fail.
1248 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1252 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1257 1 + // script length (0)
1261 )*4 + // * 4 for non-witness parts
1262 2 + // witness marker and flag
1263 1 + // witness element count
1264 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1265 self.get_funding_redeemscript().len() as u64 + // funding witness script
1266 2*(1 + 71); // two signatures + sighash type flags
1267 if let Some(spk) = a_scriptpubkey {
1268 ret += ((8+1) + // output values and script length
1269 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1271 if let Some(spk) = b_scriptpubkey {
1272 ret += ((8+1) + // output values and script length
1273 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1279 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1281 let mut ins: Vec<TxIn> = Vec::new();
1283 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1284 script_sig: Script::new(),
1285 sequence: 0xffffffff,
1286 witness: Vec::new(),
1291 assert!(self.pending_inbound_htlcs.is_empty());
1292 assert!(self.pending_outbound_htlcs.is_empty());
1293 assert!(self.pending_update_fee.is_none());
1294 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1296 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1297 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1298 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1300 if value_to_self < 0 {
1301 assert!(self.is_outbound());
1302 total_fee_satoshis += (-value_to_self) as u64;
1303 } else if value_to_remote < 0 {
1304 assert!(!self.is_outbound());
1305 total_fee_satoshis += (-value_to_remote) as u64;
1308 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1309 txouts.push((TxOut {
1310 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1311 value: value_to_remote as u64
1315 assert!(self.shutdown_scriptpubkey.is_some());
1316 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1317 txouts.push((TxOut {
1318 script_pubkey: self.get_closing_scriptpubkey(),
1319 value: value_to_self as u64
1323 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1325 let mut outputs: Vec<TxOut> = Vec::new();
1326 for out in txouts.drain(..) {
1327 outputs.push(out.0);
1335 }, total_fee_satoshis)
1338 fn funding_outpoint(&self) -> OutPoint {
1339 self.channel_transaction_parameters.funding_outpoint.unwrap()
1343 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1344 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1345 /// our counterparty!)
1346 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1347 /// TODO Some magic rust shit to compile-time check this?
1348 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1349 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1350 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1351 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1352 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1354 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()))
1358 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1359 /// will sign and send to our counterparty.
1360 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1361 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1362 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1363 //may see payments to it!
1364 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1365 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1366 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1368 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()))
1371 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1372 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1373 /// Panics if called before accept_channel/new_from_req
1374 pub fn get_funding_redeemscript(&self) -> Script {
1375 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1378 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1379 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1380 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1381 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1383 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1384 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1386 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1388 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1390 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1391 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1392 // these, but for now we just have to treat them as normal.
1394 let mut pending_idx = core::usize::MAX;
1395 let mut htlc_value_msat = 0;
1396 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1397 if htlc.htlc_id == htlc_id_arg {
1398 assert_eq!(htlc.payment_hash, payment_hash_calc);
1400 InboundHTLCState::Committed => {},
1401 InboundHTLCState::LocalRemoved(ref reason) => {
1402 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1404 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()));
1405 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1407 return UpdateFulfillFetch::DuplicateClaim {};
1410 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1411 // Don't return in release mode here so that we can update channel_monitor
1415 htlc_value_msat = htlc.amount_msat;
1419 if pending_idx == core::usize::MAX {
1420 #[cfg(any(test, feature = "fuzztarget"))]
1421 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1422 // this is simply a duplicate claim, not previously failed and we lost funds.
1423 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1424 return UpdateFulfillFetch::DuplicateClaim {};
1427 // Now update local state:
1429 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1430 // can claim it even if the channel hits the chain before we see their next commitment.
1431 self.latest_monitor_update_id += 1;
1432 let monitor_update = ChannelMonitorUpdate {
1433 update_id: self.latest_monitor_update_id,
1434 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1435 payment_preimage: payment_preimage_arg.clone(),
1439 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1440 for pending_update in self.holding_cell_htlc_updates.iter() {
1441 match pending_update {
1442 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1443 if htlc_id_arg == htlc_id {
1444 // Make sure we don't leave latest_monitor_update_id incremented here:
1445 self.latest_monitor_update_id -= 1;
1446 #[cfg(any(test, feature = "fuzztarget"))]
1447 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1448 return UpdateFulfillFetch::DuplicateClaim {};
1451 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1452 if htlc_id_arg == htlc_id {
1453 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1454 // TODO: We may actually be able to switch to a fulfill here, though its
1455 // rare enough it may not be worth the complexity burden.
1456 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1457 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1463 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1464 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1465 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1467 #[cfg(any(test, feature = "fuzztarget"))]
1468 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1469 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1471 #[cfg(any(test, feature = "fuzztarget"))]
1472 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1475 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1476 if let InboundHTLCState::Committed = htlc.state {
1478 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1479 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1481 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1482 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1485 UpdateFulfillFetch::NewClaim {
1488 msg: Some(msgs::UpdateFulfillHTLC {
1489 channel_id: self.channel_id(),
1490 htlc_id: htlc_id_arg,
1491 payment_preimage: payment_preimage_arg,
1496 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 {
1497 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1498 UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1499 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1500 Err(e) => return Err((e, monitor_update)),
1503 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1504 // strictly increasing by one, so decrement it here.
1505 self.latest_monitor_update_id = monitor_update.update_id;
1506 monitor_update.updates.append(&mut additional_update.updates);
1507 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1509 UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1510 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1511 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1515 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1516 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1517 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1518 /// before we fail backwards.
1519 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1520 /// Ok(_) if debug assertions are turned on or preconditions are met.
1521 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 {
1522 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1523 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1525 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1527 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1528 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1529 // these, but for now we just have to treat them as normal.
1531 let mut pending_idx = core::usize::MAX;
1532 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1533 if htlc.htlc_id == htlc_id_arg {
1535 InboundHTLCState::Committed => {},
1536 InboundHTLCState::LocalRemoved(ref reason) => {
1537 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1539 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1544 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1545 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1551 if pending_idx == core::usize::MAX {
1552 #[cfg(any(test, feature = "fuzztarget"))]
1553 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1554 // is simply a duplicate fail, not previously failed and we failed-back too early.
1555 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1559 // Now update local state:
1560 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1561 for pending_update in self.holding_cell_htlc_updates.iter() {
1562 match pending_update {
1563 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1564 if htlc_id_arg == htlc_id {
1565 #[cfg(any(test, feature = "fuzztarget"))]
1566 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1570 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1571 if htlc_id_arg == htlc_id {
1572 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1573 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1579 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1580 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1581 htlc_id: htlc_id_arg,
1587 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1589 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1590 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1593 Ok(Some(msgs::UpdateFailHTLC {
1594 channel_id: self.channel_id(),
1595 htlc_id: htlc_id_arg,
1600 // Message handlers:
1602 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: &InitFeatures) -> Result<(), ChannelError> {
1603 // Check sanity of message fields:
1604 if !self.is_outbound() {
1605 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1607 if self.channel_state != ChannelState::OurInitSent as u32 {
1608 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1610 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1611 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1613 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1614 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1616 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1617 return Err(ChannelError::Close(format!("Peer never wants payout outputs? channel_reserve_satoshis was ({}). dust_limit is ({})", msg.channel_reserve_satoshis, self.holder_dust_limit_satoshis)));
1619 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1620 if msg.dust_limit_satoshis > remote_reserve {
1621 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1623 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1624 if msg.htlc_minimum_msat >= full_channel_value_msat {
1625 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1627 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1628 if msg.to_self_delay > max_delay_acceptable {
1629 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)));
1631 if msg.max_accepted_htlcs < 1 {
1632 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1634 if msg.max_accepted_htlcs > MAX_HTLCS {
1635 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1638 // Now check against optional parameters as set by config...
1639 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1640 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)));
1642 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1643 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)));
1645 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1646 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)));
1648 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1649 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)));
1651 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1652 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1654 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1655 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1657 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1658 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)));
1660 if msg.minimum_depth == 0 {
1661 // Note that if this changes we should update the serialization minimum version to
1662 // indicate to older clients that they don't understand some features of the current
1664 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1667 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1668 match &msg.shutdown_scriptpubkey {
1669 &OptionalField::Present(ref script) => {
1670 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1671 if script.len() == 0 {
1674 match ShutdownScript::try_from((script.clone(), their_features)) {
1675 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
1676 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
1680 // 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
1681 &OptionalField::Absent => {
1682 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()));
1687 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1688 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1689 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1690 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1691 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1692 self.minimum_depth = Some(msg.minimum_depth);
1694 let counterparty_pubkeys = ChannelPublicKeys {
1695 funding_pubkey: msg.funding_pubkey,
1696 revocation_basepoint: msg.revocation_basepoint,
1697 payment_point: msg.payment_point,
1698 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1699 htlc_basepoint: msg.htlc_basepoint
1702 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1703 selected_contest_delay: msg.to_self_delay,
1704 pubkeys: counterparty_pubkeys,
1707 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1708 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1710 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1715 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1716 let funding_script = self.get_funding_redeemscript();
1718 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1719 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).0;
1721 let trusted_tx = initial_commitment_tx.trust();
1722 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1723 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1724 // They sign the holder commitment transaction...
1725 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1726 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1727 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1728 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1729 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1732 let counterparty_keys = self.build_remote_transaction_keys()?;
1733 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1735 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1736 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1737 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1738 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1740 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1741 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1743 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1744 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1747 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1748 &self.get_counterparty_pubkeys().funding_pubkey
1751 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 {
1752 if self.is_outbound() {
1753 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1755 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1756 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1757 // remember the channel, so it's safe to just send an error_message here and drop the
1759 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1761 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1762 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1763 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1764 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1767 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1768 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1769 // This is an externally observable change before we finish all our checks. In particular
1770 // funding_created_signature may fail.
1771 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1773 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1775 Err(ChannelError::Close(e)) => {
1776 self.channel_transaction_parameters.funding_outpoint = None;
1777 return Err(ChannelError::Close(e));
1780 // The only error we know how to handle is ChannelError::Close, so we fall over here
1781 // to make sure we don't continue with an inconsistent state.
1782 panic!("unexpected error type from funding_created_signature {:?}", e);
1786 let holder_commitment_tx = HolderCommitmentTransaction::new(
1787 initial_commitment_tx,
1790 &self.get_holder_pubkeys().funding_pubkey,
1791 self.counterparty_funding_pubkey()
1794 self.holder_signer.validate_holder_commitment(&holder_commitment_tx);
1796 // Now that we're past error-generating stuff, update our local state:
1798 let funding_redeemscript = self.get_funding_redeemscript();
1799 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1800 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1801 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1802 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1803 shutdown_script, self.get_holder_selected_contest_delay(),
1804 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1805 &self.channel_transaction_parameters,
1806 funding_redeemscript.clone(), self.channel_value_satoshis,
1808 holder_commitment_tx, best_block);
1810 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);
1812 self.channel_state = ChannelState::FundingSent as u32;
1813 self.channel_id = funding_txo.to_channel_id();
1814 self.cur_counterparty_commitment_transaction_number -= 1;
1815 self.cur_holder_commitment_transaction_number -= 1;
1817 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1819 Ok((msgs::FundingSigned {
1820 channel_id: self.channel_id,
1822 }, channel_monitor))
1825 /// Handles a funding_signed message from the remote end.
1826 /// If this call is successful, broadcast the funding transaction (and not before!)
1827 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 {
1828 if !self.is_outbound() {
1829 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1831 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1832 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1834 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1835 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1836 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1837 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1840 let funding_script = self.get_funding_redeemscript();
1842 let counterparty_keys = self.build_remote_transaction_keys()?;
1843 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1844 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1845 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1847 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1848 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1850 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1851 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).0;
1853 let trusted_tx = initial_commitment_tx.trust();
1854 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1855 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1856 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1857 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1858 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1862 let holder_commitment_tx = HolderCommitmentTransaction::new(
1863 initial_commitment_tx,
1866 &self.get_holder_pubkeys().funding_pubkey,
1867 self.counterparty_funding_pubkey()
1870 self.holder_signer.validate_holder_commitment(&holder_commitment_tx);
1872 let funding_redeemscript = self.get_funding_redeemscript();
1873 let funding_txo = self.get_funding_txo().unwrap();
1874 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1875 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1876 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1877 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1878 shutdown_script, self.get_holder_selected_contest_delay(),
1879 &self.destination_script, (funding_txo, funding_txo_script),
1880 &self.channel_transaction_parameters,
1881 funding_redeemscript.clone(), self.channel_value_satoshis,
1883 holder_commitment_tx, best_block);
1885 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);
1887 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1888 self.channel_state = ChannelState::FundingSent as u32;
1889 self.cur_holder_commitment_transaction_number -= 1;
1890 self.cur_counterparty_commitment_transaction_number -= 1;
1892 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1894 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1897 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1898 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1899 self.workaround_lnd_bug_4006 = Some(msg.clone());
1900 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()));
1903 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1905 if non_shutdown_state == ChannelState::FundingSent as u32 {
1906 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1907 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1908 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1909 self.update_time_counter += 1;
1910 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1911 // Note that funding_signed/funding_created will have decremented both by 1!
1912 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1913 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1914 // If we reconnected before sending our funding locked they may still resend theirs:
1915 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1916 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1917 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1918 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1920 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1923 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1926 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1927 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1929 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1934 /// Returns a HTLCStats about inbound pending htlcs
1935 fn get_inbound_pending_htlc_stats(&self) -> HTLCStats {
1936 let mut stats = HTLCStats {
1937 pending_htlcs: self.pending_inbound_htlcs.len() as u32,
1938 pending_htlcs_value_msat: 0,
1939 on_counterparty_tx_dust_exposure_msat: 0,
1940 on_holder_tx_dust_exposure_msat: 0,
1943 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1944 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1945 for ref htlc in self.pending_inbound_htlcs.iter() {
1946 stats.pending_htlcs_value_msat += htlc.amount_msat;
1947 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
1948 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1950 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
1951 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1957 /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
1958 fn get_outbound_pending_htlc_stats(&self) -> HTLCStats {
1959 let mut stats = HTLCStats {
1960 pending_htlcs: self.pending_outbound_htlcs.len() as u32,
1961 pending_htlcs_value_msat: 0,
1962 on_counterparty_tx_dust_exposure_msat: 0,
1963 on_holder_tx_dust_exposure_msat: 0,
1966 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1967 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1968 for ref htlc in self.pending_outbound_htlcs.iter() {
1969 stats.pending_htlcs_value_msat += htlc.amount_msat;
1970 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
1971 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1973 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
1974 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1978 for update in self.holding_cell_htlc_updates.iter() {
1979 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1980 stats.pending_htlcs += 1;
1981 stats.pending_htlcs_value_msat += amount_msat;
1982 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
1983 stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
1985 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
1986 stats.on_holder_tx_dust_exposure_msat += amount_msat;
1993 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1994 /// Doesn't bother handling the
1995 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1996 /// corner case properly.
1997 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1998 // Note that we have to handle overflow due to the above case.
2000 cmp::max(self.channel_value_satoshis as i64 * 1000
2001 - self.value_to_self_msat as i64
2002 - self.get_inbound_pending_htlc_stats().pending_htlcs_value_msat as i64
2003 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
2005 cmp::max(self.value_to_self_msat as i64
2006 - self.get_outbound_pending_htlc_stats().pending_htlcs_value_msat as i64
2007 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
2012 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
2013 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
2014 self.counterparty_selected_channel_reserve_satoshis)
2017 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
2018 // Note that num_htlcs should not include dust HTLCs.
2019 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
2020 // Note that we need to divide before multiplying to round properly,
2021 // since the lowest denomination of bitcoin on-chain is the satoshi.
2022 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
2025 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
2026 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
2027 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
2029 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2030 assert!(self.is_outbound());
2032 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2033 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2035 let mut addl_htlcs = 0;
2036 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2038 HTLCInitiator::LocalOffered => {
2039 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2043 HTLCInitiator::RemoteOffered => {
2044 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2050 let mut included_htlcs = 0;
2051 for ref htlc in self.pending_inbound_htlcs.iter() {
2052 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2055 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2056 // transaction including this HTLC if it times out before they RAA.
2057 included_htlcs += 1;
2060 for ref htlc in self.pending_outbound_htlcs.iter() {
2061 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2065 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2066 OutboundHTLCState::Committed => included_htlcs += 1,
2067 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2068 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2069 // transaction won't be generated until they send us their next RAA, which will mean
2070 // dropping any HTLCs in this state.
2075 for htlc in self.holding_cell_htlc_updates.iter() {
2077 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2078 if amount_msat / 1000 < real_dust_limit_timeout_sat {
2083 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2084 // ack we're guaranteed to never include them in commitment txs anymore.
2088 let num_htlcs = included_htlcs + addl_htlcs;
2089 let res = self.commit_tx_fee_msat(num_htlcs);
2090 #[cfg(any(test, feature = "fuzztarget"))]
2093 if fee_spike_buffer_htlc.is_some() {
2094 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2096 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2097 + self.holding_cell_htlc_updates.len();
2098 let commitment_tx_info = CommitmentTxInfoCached {
2100 total_pending_htlcs,
2101 next_holder_htlc_id: match htlc.origin {
2102 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2103 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2105 next_counterparty_htlc_id: match htlc.origin {
2106 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2107 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2109 feerate: self.feerate_per_kw,
2111 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2116 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2117 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2118 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2120 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2121 assert!(!self.is_outbound());
2123 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2124 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2126 let mut addl_htlcs = 0;
2127 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2129 HTLCInitiator::LocalOffered => {
2130 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2134 HTLCInitiator::RemoteOffered => {
2135 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2141 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2142 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2143 // committed outbound HTLCs, see below.
2144 let mut included_htlcs = 0;
2145 for ref htlc in self.pending_inbound_htlcs.iter() {
2146 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2149 included_htlcs += 1;
2152 for ref htlc in self.pending_outbound_htlcs.iter() {
2153 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2156 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2157 // i.e. if they've responded to us with an RAA after announcement.
2159 OutboundHTLCState::Committed => included_htlcs += 1,
2160 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2161 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2166 let num_htlcs = included_htlcs + addl_htlcs;
2167 let res = self.commit_tx_fee_msat(num_htlcs);
2168 #[cfg(any(test, feature = "fuzztarget"))]
2171 if fee_spike_buffer_htlc.is_some() {
2172 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2174 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2175 let commitment_tx_info = CommitmentTxInfoCached {
2177 total_pending_htlcs,
2178 next_holder_htlc_id: match htlc.origin {
2179 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2180 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2182 next_counterparty_htlc_id: match htlc.origin {
2183 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2184 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2186 feerate: self.feerate_per_kw,
2188 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2193 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>
2194 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2195 // We can't accept HTLCs sent after we've sent a shutdown.
2196 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2197 if local_sent_shutdown {
2198 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
2200 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2201 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2202 if remote_sent_shutdown {
2203 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2205 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2206 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2208 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2209 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2211 if msg.amount_msat == 0 {
2212 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2214 if msg.amount_msat < self.holder_htlc_minimum_msat {
2215 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)));
2218 let inbound_stats = self.get_inbound_pending_htlc_stats();
2219 let outbound_stats = self.get_outbound_pending_htlc_stats();
2220 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2221 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2223 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2224 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2225 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2227 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2228 // the reserve_satoshis we told them to always have as direct payment so that they lose
2229 // something if we punish them for broadcasting an old state).
2230 // Note that we don't really care about having a small/no to_remote output in our local
2231 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2232 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2233 // present in the next commitment transaction we send them (at least for fulfilled ones,
2234 // failed ones won't modify value_to_self).
2235 // Note that we will send HTLCs which another instance of rust-lightning would think
2236 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2237 // Channel state once they will not be present in the next received commitment
2239 let mut removed_outbound_total_msat = 0;
2240 for ref htlc in self.pending_outbound_htlcs.iter() {
2241 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2242 removed_outbound_total_msat += htlc.amount_msat;
2243 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2244 removed_outbound_total_msat += htlc.amount_msat;
2248 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2249 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2250 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;
2251 if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2252 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2253 on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2254 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2258 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2259 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2260 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;
2261 if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2262 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2263 on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2264 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2268 let pending_value_to_self_msat =
2269 self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2270 let pending_remote_value_msat =
2271 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2272 if pending_remote_value_msat < msg.amount_msat {
2273 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2276 // Check that the remote can afford to pay for this HTLC on-chain at the current
2277 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2278 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2279 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2280 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2282 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2283 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2286 let chan_reserve_msat =
2287 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2288 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2289 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2292 if !self.is_outbound() {
2293 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2294 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2295 // receiver's side, only on the sender's.
2296 // Note that when we eventually remove support for fee updates and switch to anchor output
2297 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2298 // the extra htlc when calculating the next remote commitment transaction fee as we should
2299 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2300 // sensitive to fee spikes.
2301 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2302 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2303 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2304 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2305 // the HTLC, i.e. its status is already set to failing.
2306 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2307 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2310 // Check that they won't violate our local required channel reserve by adding this HTLC.
2311 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2312 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2313 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2314 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2317 if self.next_counterparty_htlc_id != msg.htlc_id {
2318 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2320 if msg.cltv_expiry >= 500000000 {
2321 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2324 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2325 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2326 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2330 // Now update local state:
2331 self.next_counterparty_htlc_id += 1;
2332 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2333 htlc_id: msg.htlc_id,
2334 amount_msat: msg.amount_msat,
2335 payment_hash: msg.payment_hash,
2336 cltv_expiry: msg.cltv_expiry,
2337 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2342 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2344 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2345 for htlc in self.pending_outbound_htlcs.iter_mut() {
2346 if htlc.htlc_id == htlc_id {
2347 match check_preimage {
2349 Some(payment_hash) =>
2350 if payment_hash != htlc.payment_hash {
2351 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2355 OutboundHTLCState::LocalAnnounced(_) =>
2356 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2357 OutboundHTLCState::Committed => {
2358 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2360 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2361 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2366 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2369 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2370 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2371 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2373 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2374 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2377 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2378 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2381 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2382 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2383 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2385 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2386 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2389 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2393 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2394 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2395 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2397 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2398 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2401 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2405 pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2406 where L::Target: Logger
2408 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2409 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2411 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2412 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2414 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2415 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2418 let funding_script = self.get_funding_redeemscript();
2420 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2422 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid, feerate_per_kw) = {
2423 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2424 let commitment_txid = {
2425 let trusted_tx = commitment_tx.0.trust();
2426 let bitcoin_tx = trusted_tx.built_transaction();
2427 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2429 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2430 log_bytes!(msg.signature.serialize_compact()[..]),
2431 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2432 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2433 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2434 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2438 let htlcs_cloned: Vec<_> = commitment_tx.3.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2439 (commitment_tx.2, htlcs_cloned, commitment_tx.0, commitment_txid, commitment_tx.1)
2442 // If our counterparty updated the channel fee in this commitment transaction, check that
2443 // they can actually afford the new fee now.
2444 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2445 update_state == FeeUpdateState::RemoteAnnounced
2447 if update_fee { debug_assert!(!self.is_outbound()); }
2448 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2450 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2451 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2452 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2455 #[cfg(any(test, feature = "fuzztarget"))]
2457 if self.is_outbound() {
2458 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2459 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2460 if let Some(info) = projected_commit_tx_info {
2461 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2462 + self.holding_cell_htlc_updates.len();
2463 if info.total_pending_htlcs == total_pending_htlcs
2464 && info.next_holder_htlc_id == self.next_holder_htlc_id
2465 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2466 && info.feerate == self.feerate_per_kw {
2467 assert_eq!(total_fee, info.fee / 1000);
2473 if msg.htlc_signatures.len() != num_htlcs {
2474 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2477 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2478 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2479 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2480 if let Some(_) = htlc.transaction_output_index {
2481 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2482 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2483 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2485 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2486 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2487 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2488 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2489 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2490 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2491 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2493 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2495 htlcs_and_sigs.push((htlc, None, source));
2499 let holder_commitment_tx = HolderCommitmentTransaction::new(
2502 msg.htlc_signatures.clone(),
2503 &self.get_holder_pubkeys().funding_pubkey,
2504 self.counterparty_funding_pubkey()
2507 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2508 self.holder_signer.validate_holder_commitment(&holder_commitment_tx);
2509 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2511 // Update state now that we've passed all the can-fail calls...
2512 let mut need_commitment = false;
2513 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2514 if *update_state == FeeUpdateState::RemoteAnnounced {
2515 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2516 need_commitment = true;
2520 self.latest_monitor_update_id += 1;
2521 let mut monitor_update = ChannelMonitorUpdate {
2522 update_id: self.latest_monitor_update_id,
2523 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2524 commitment_tx: holder_commitment_tx,
2525 htlc_outputs: htlcs_and_sigs
2529 for htlc in self.pending_inbound_htlcs.iter_mut() {
2530 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2531 Some(forward_info.clone())
2533 if let Some(forward_info) = new_forward {
2534 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2535 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2536 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2537 need_commitment = true;
2540 for htlc in self.pending_outbound_htlcs.iter_mut() {
2541 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2542 Some(fail_reason.take())
2544 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2545 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2546 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2547 need_commitment = true;
2551 self.cur_holder_commitment_transaction_number -= 1;
2552 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2553 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2554 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2556 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2557 // In case we initially failed monitor updating without requiring a response, we need
2558 // to make sure the RAA gets sent first.
2559 self.monitor_pending_revoke_and_ack = true;
2560 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2561 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2562 // the corresponding HTLC status updates so that get_last_commitment_update
2563 // includes the right HTLCs.
2564 self.monitor_pending_commitment_signed = true;
2565 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2566 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2567 // strictly increasing by one, so decrement it here.
2568 self.latest_monitor_update_id = monitor_update.update_id;
2569 monitor_update.updates.append(&mut additional_update.updates);
2571 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2572 log_bytes!(self.channel_id));
2573 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2576 let commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2577 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2578 // we'll send one right away when we get the revoke_and_ack when we
2579 // free_holding_cell_htlcs().
2580 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2581 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2582 // strictly increasing by one, so decrement it here.
2583 self.latest_monitor_update_id = monitor_update.update_id;
2584 monitor_update.updates.append(&mut additional_update.updates);
2588 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2589 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2591 Ok((msgs::RevokeAndACK {
2592 channel_id: self.channel_id,
2593 per_commitment_secret,
2594 next_per_commitment_point,
2595 }, commitment_signed, monitor_update))
2598 /// Public version of the below, checking relevant preconditions first.
2599 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2600 /// returns `(None, Vec::new())`.
2601 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 {
2602 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2603 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2604 self.free_holding_cell_htlcs(logger)
2605 } else { Ok((None, Vec::new())) }
2608 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2609 /// fulfilling or failing the last pending HTLC)
2610 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2611 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2612 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2613 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2614 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2616 let mut monitor_update = ChannelMonitorUpdate {
2617 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2618 updates: Vec::new(),
2621 let mut htlc_updates = Vec::new();
2622 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2623 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2624 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2625 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2626 let mut htlcs_to_fail = Vec::new();
2627 for htlc_update in htlc_updates.drain(..) {
2628 // Note that this *can* fail, though it should be due to rather-rare conditions on
2629 // fee races with adding too many outputs which push our total payments just over
2630 // the limit. In case it's less rare than I anticipate, we may want to revisit
2631 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2632 // to rebalance channels.
2633 match &htlc_update {
2634 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2635 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2636 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2639 ChannelError::Ignore(ref msg) => {
2640 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2641 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2642 // If we fail to send here, then this HTLC should
2643 // be failed backwards. Failing to send here
2644 // indicates that this HTLC may keep being put back
2645 // into the holding cell without ever being
2646 // successfully forwarded/failed/fulfilled, causing
2647 // our counterparty to eventually close on us.
2648 htlcs_to_fail.push((source.clone(), *payment_hash));
2651 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2657 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2658 // If an HTLC claim was previously added to the holding cell (via
2659 // `get_update_fulfill_htlc`, then generating the claim message itself must
2660 // not fail - any in between attempts to claim the HTLC will have resulted
2661 // in it hitting the holding cell again and we cannot change the state of a
2662 // holding cell HTLC from fulfill to anything else.
2663 let (update_fulfill_msg_option, mut additional_monitor_update) =
2664 if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2665 (msg, monitor_update)
2666 } else { unreachable!() };
2667 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2668 monitor_update.updates.append(&mut additional_monitor_update.updates);
2670 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2671 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2672 Ok(update_fail_msg_option) => {
2673 // If an HTLC failure was previously added to the holding cell (via
2674 // `get_update_fail_htlc`) then generating the fail message itself
2675 // must not fail - we should never end up in a state where we
2676 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2677 // we didn't wait for a full revocation before failing.
2678 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2681 if let ChannelError::Ignore(_) = e {}
2683 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2690 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2691 return Ok((None, htlcs_to_fail));
2693 let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
2694 assert!(self.is_outbound());
2695 self.pending_update_fee = Some((feerate, FeeUpdateState::Outbound));
2696 Some(msgs::UpdateFee {
2697 channel_id: self.channel_id,
2698 feerate_per_kw: feerate as u32,
2704 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2705 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2706 // but we want them to be strictly increasing by one, so reset it here.
2707 self.latest_monitor_update_id = monitor_update.update_id;
2708 monitor_update.updates.append(&mut additional_update.updates);
2710 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2711 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2712 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2714 Ok((Some((msgs::CommitmentUpdate {
2716 update_fulfill_htlcs,
2718 update_fail_malformed_htlcs: Vec::new(),
2721 }, monitor_update)), htlcs_to_fail))
2723 Ok((None, Vec::new()))
2727 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2728 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2729 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2730 /// generating an appropriate error *after* the channel state has been updated based on the
2731 /// revoke_and_ack message.
2732 pub fn revoke_and_ack<L: Deref>(&mut self, msg: &msgs::RevokeAndACK, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2733 where L::Target: Logger,
2735 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2736 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2738 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2739 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2741 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2742 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2745 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2746 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned())) != counterparty_prev_commitment_point {
2747 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2751 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2752 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2753 // haven't given them a new commitment transaction to broadcast). We should probably
2754 // take advantage of this by updating our channel monitor, sending them an error, and
2755 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2756 // lot of work, and there's some chance this is all a misunderstanding anyway.
2757 // We have to do *something*, though, since our signer may get mad at us for otherwise
2758 // jumping a remote commitment number, so best to just force-close and move on.
2759 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2762 #[cfg(any(test, feature = "fuzztarget"))]
2764 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2765 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2768 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2769 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2770 self.latest_monitor_update_id += 1;
2771 let mut monitor_update = ChannelMonitorUpdate {
2772 update_id: self.latest_monitor_update_id,
2773 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2774 idx: self.cur_counterparty_commitment_transaction_number + 1,
2775 secret: msg.per_commitment_secret,
2779 // Update state now that we've passed all the can-fail calls...
2780 // (note that we may still fail to generate the new commitment_signed message, but that's
2781 // OK, we step the channel here and *then* if the new generation fails we can fail the
2782 // channel based on that, but stepping stuff here should be safe either way.
2783 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2784 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2785 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2786 self.cur_counterparty_commitment_transaction_number -= 1;
2788 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2789 let mut to_forward_infos = Vec::new();
2790 let mut revoked_htlcs = Vec::new();
2791 let mut update_fail_htlcs = Vec::new();
2792 let mut update_fail_malformed_htlcs = Vec::new();
2793 let mut require_commitment = false;
2794 let mut value_to_self_msat_diff: i64 = 0;
2797 // Take references explicitly so that we can hold multiple references to self.
2798 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2799 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2801 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2802 pending_inbound_htlcs.retain(|htlc| {
2803 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2804 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2805 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2806 value_to_self_msat_diff += htlc.amount_msat as i64;
2811 pending_outbound_htlcs.retain(|htlc| {
2812 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2813 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2814 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2815 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2817 // They fulfilled, so we sent them money
2818 value_to_self_msat_diff -= htlc.amount_msat as i64;
2823 for htlc in pending_inbound_htlcs.iter_mut() {
2824 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2826 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2830 let mut state = InboundHTLCState::Committed;
2831 mem::swap(&mut state, &mut htlc.state);
2833 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2834 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2835 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2836 require_commitment = true;
2837 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2838 match forward_info {
2839 PendingHTLCStatus::Fail(fail_msg) => {
2840 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2841 require_commitment = true;
2843 HTLCFailureMsg::Relay(msg) => {
2844 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2845 update_fail_htlcs.push(msg)
2847 HTLCFailureMsg::Malformed(msg) => {
2848 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2849 update_fail_malformed_htlcs.push(msg)
2853 PendingHTLCStatus::Forward(forward_info) => {
2854 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2855 to_forward_infos.push((forward_info, htlc.htlc_id));
2856 htlc.state = InboundHTLCState::Committed;
2862 for htlc in pending_outbound_htlcs.iter_mut() {
2863 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2864 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2865 htlc.state = OutboundHTLCState::Committed;
2867 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2868 Some(fail_reason.take())
2870 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2871 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2872 require_commitment = true;
2876 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2878 if let Some((feerate, update_state)) = self.pending_update_fee {
2879 match update_state {
2880 FeeUpdateState::Outbound => {
2881 debug_assert!(self.is_outbound());
2882 log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
2883 self.feerate_per_kw = feerate;
2884 self.pending_update_fee = None;
2886 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
2887 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
2888 debug_assert!(!self.is_outbound());
2889 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
2890 require_commitment = true;
2891 self.feerate_per_kw = feerate;
2892 self.pending_update_fee = None;
2897 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2898 // We can't actually generate a new commitment transaction (incl by freeing holding
2899 // cells) while we can't update the monitor, so we just return what we have.
2900 if require_commitment {
2901 self.monitor_pending_commitment_signed = true;
2902 // When the monitor updating is restored we'll call get_last_commitment_update(),
2903 // which does not update state, but we're definitely now awaiting a remote revoke
2904 // before we can step forward any more, so set it here.
2905 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2906 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2907 // strictly increasing by one, so decrement it here.
2908 self.latest_monitor_update_id = monitor_update.update_id;
2909 monitor_update.updates.append(&mut additional_update.updates);
2911 self.monitor_pending_forwards.append(&mut to_forward_infos);
2912 self.monitor_pending_failures.append(&mut revoked_htlcs);
2913 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2914 return Ok((None, Vec::new(), Vec::new(), monitor_update, Vec::new()))
2917 match self.free_holding_cell_htlcs(logger)? {
2918 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2919 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2920 for fail_msg in update_fail_htlcs.drain(..) {
2921 commitment_update.update_fail_htlcs.push(fail_msg);
2923 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2924 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2925 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2928 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2929 // strictly increasing by one, so decrement it here.
2930 self.latest_monitor_update_id = monitor_update.update_id;
2931 monitor_update.updates.append(&mut additional_update.updates);
2933 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2935 (None, htlcs_to_fail) => {
2936 if require_commitment {
2937 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2939 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2940 // strictly increasing by one, so decrement it here.
2941 self.latest_monitor_update_id = monitor_update.update_id;
2942 monitor_update.updates.append(&mut additional_update.updates);
2944 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2945 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2946 Ok((Some(msgs::CommitmentUpdate {
2947 update_add_htlcs: Vec::new(),
2948 update_fulfill_htlcs: Vec::new(),
2950 update_fail_malformed_htlcs,
2953 }), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2955 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2956 Ok((None, to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2962 /// Adds a pending update to this channel. See the doc for send_htlc for
2963 /// further details on the optionness of the return value.
2964 /// You MUST call send_commitment prior to any other calls on this Channel
2965 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2966 if !self.is_outbound() {
2967 panic!("Cannot send fee from inbound channel");
2969 if !self.is_usable() {
2970 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2972 if !self.is_live() {
2973 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2976 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
2977 self.holding_cell_update_fee = Some(feerate_per_kw);
2981 debug_assert!(self.pending_update_fee.is_none());
2982 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
2984 Some(msgs::UpdateFee {
2985 channel_id: self.channel_id,
2990 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 {
2991 match self.send_update_fee(feerate_per_kw) {
2992 Some(update_fee) => {
2993 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2994 Ok(Some((update_fee, commitment_signed, monitor_update)))
3000 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
3001 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
3003 /// No further message handling calls may be made until a channel_reestablish dance has
3005 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
3006 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3007 if self.channel_state < ChannelState::FundingSent as u32 {
3008 self.channel_state = ChannelState::ShutdownComplete as u32;
3011 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
3012 // will be retransmitted.
3013 self.last_sent_closing_fee = None;
3014 self.pending_counterparty_closing_signed = None;
3015 self.closing_fee_limits = None;
3017 let mut inbound_drop_count = 0;
3018 self.pending_inbound_htlcs.retain(|htlc| {
3020 InboundHTLCState::RemoteAnnounced(_) => {
3021 // They sent us an update_add_htlc but we never got the commitment_signed.
3022 // We'll tell them what commitment_signed we're expecting next and they'll drop
3023 // this HTLC accordingly
3024 inbound_drop_count += 1;
3027 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3028 // We received a commitment_signed updating this HTLC and (at least hopefully)
3029 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3030 // in response to it yet, so don't touch it.
3033 InboundHTLCState::Committed => true,
3034 InboundHTLCState::LocalRemoved(_) => {
3035 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3036 // re-transmit if needed) and they may have even sent a revoke_and_ack back
3037 // (that we missed). Keep this around for now and if they tell us they missed
3038 // the commitment_signed we can re-transmit the update then.
3043 self.next_counterparty_htlc_id -= inbound_drop_count;
3045 if let Some((_, update_state)) = self.pending_update_fee {
3046 if update_state == FeeUpdateState::RemoteAnnounced {
3047 debug_assert!(!self.is_outbound());
3048 self.pending_update_fee = None;
3052 for htlc in self.pending_outbound_htlcs.iter_mut() {
3053 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3054 // They sent us an update to remove this but haven't yet sent the corresponding
3055 // commitment_signed, we need to move it back to Committed and they can re-send
3056 // the update upon reconnection.
3057 htlc.state = OutboundHTLCState::Committed;
3061 self.channel_state |= ChannelState::PeerDisconnected as u32;
3062 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3065 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3066 /// updates are partially paused.
3067 /// This must be called immediately after the call which generated the ChannelMonitor update
3068 /// which failed. The messages which were generated from that call which generated the
3069 /// monitor update failure must *not* have been sent to the remote end, and must instead
3070 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3071 pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
3072 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
3073 self.monitor_pending_revoke_and_ack = resend_raa;
3074 self.monitor_pending_commitment_signed = resend_commitment;
3075 assert!(self.monitor_pending_forwards.is_empty());
3076 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
3077 assert!(self.monitor_pending_failures.is_empty());
3078 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
3079 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3082 /// Indicates that the latest ChannelMonitor update has been committed by the client
3083 /// successfully and we should restore normal operation. Returns messages which should be sent
3084 /// to the remote side.
3085 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<Transaction>, Option<msgs::FundingLocked>) where L::Target: Logger {
3086 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3087 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3089 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
3090 self.funding_transaction.take()
3093 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3094 // we assume the user never directly broadcasts the funding transaction and waits for us to
3095 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
3096 // channel which failed to persist the monitor on funding_created, and we got the funding
3097 // transaction confirmed before the monitor was persisted.
3098 let funding_locked = if self.monitor_pending_funding_locked {
3099 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3100 self.monitor_pending_funding_locked = false;
3101 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3102 Some(msgs::FundingLocked {
3103 channel_id: self.channel_id(),
3104 next_per_commitment_point,
3108 let mut forwards = Vec::new();
3109 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
3110 let mut failures = Vec::new();
3111 mem::swap(&mut failures, &mut self.monitor_pending_failures);
3113 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3114 self.monitor_pending_revoke_and_ack = false;
3115 self.monitor_pending_commitment_signed = false;
3116 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
3119 let raa = if self.monitor_pending_revoke_and_ack {
3120 Some(self.get_last_revoke_and_ack())
3122 let commitment_update = if self.monitor_pending_commitment_signed {
3123 Some(self.get_last_commitment_update(logger))
3126 self.monitor_pending_revoke_and_ack = false;
3127 self.monitor_pending_commitment_signed = false;
3128 let order = self.resend_order.clone();
3129 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3130 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3131 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3132 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3133 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
3136 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3137 where F::Target: FeeEstimator
3139 if self.is_outbound() {
3140 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3142 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3143 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3145 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3146 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate();
3148 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3149 self.update_time_counter += 1;
3150 // If the feerate has increased over the previous dust buffer (note that
3151 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3152 // won't be pushed over our dust exposure limit by the feerate increase.
3153 if feerate_over_dust_buffer {
3154 let inbound_stats = self.get_inbound_pending_htlc_stats();
3155 let outbound_stats = self.get_outbound_pending_htlc_stats();
3156 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3157 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3158 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3159 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)",
3160 msg.feerate_per_kw, holder_tx_dust_exposure)));
3162 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3163 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)",
3164 msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3170 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3171 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3172 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3173 msgs::RevokeAndACK {
3174 channel_id: self.channel_id,
3175 per_commitment_secret,
3176 next_per_commitment_point,
3180 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3181 let mut update_add_htlcs = Vec::new();
3182 let mut update_fulfill_htlcs = Vec::new();
3183 let mut update_fail_htlcs = Vec::new();
3184 let mut update_fail_malformed_htlcs = Vec::new();
3186 for htlc in self.pending_outbound_htlcs.iter() {
3187 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3188 update_add_htlcs.push(msgs::UpdateAddHTLC {
3189 channel_id: self.channel_id(),
3190 htlc_id: htlc.htlc_id,
3191 amount_msat: htlc.amount_msat,
3192 payment_hash: htlc.payment_hash,
3193 cltv_expiry: htlc.cltv_expiry,
3194 onion_routing_packet: (**onion_packet).clone(),
3199 for htlc in self.pending_inbound_htlcs.iter() {
3200 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3202 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3203 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3204 channel_id: self.channel_id(),
3205 htlc_id: htlc.htlc_id,
3206 reason: err_packet.clone()
3209 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3210 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3211 channel_id: self.channel_id(),
3212 htlc_id: htlc.htlc_id,
3213 sha256_of_onion: sha256_of_onion.clone(),
3214 failure_code: failure_code.clone(),
3217 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3218 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3219 channel_id: self.channel_id(),
3220 htlc_id: htlc.htlc_id,
3221 payment_preimage: payment_preimage.clone(),
3228 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3229 Some(msgs::UpdateFee {
3230 channel_id: self.channel_id(),
3231 feerate_per_kw: self.pending_update_fee.unwrap().0,
3235 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3236 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3237 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3238 msgs::CommitmentUpdate {
3239 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3240 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,
3244 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3245 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3246 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 {
3247 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3248 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3249 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3250 // just close here instead of trying to recover.
3251 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3254 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3255 msg.next_local_commitment_number == 0 {
3256 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3259 if msg.next_remote_commitment_number > 0 {
3260 match msg.data_loss_protect {
3261 OptionalField::Present(ref data_loss) => {
3262 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3263 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3264 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3265 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3266 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3268 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3269 return Err(ChannelError::CloseDelayBroadcast(
3270 "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()
3274 OptionalField::Absent => {}
3278 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3279 // remaining cases either succeed or ErrorMessage-fail).
3280 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3282 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3283 assert!(self.shutdown_scriptpubkey.is_some());
3284 Some(msgs::Shutdown {
3285 channel_id: self.channel_id,
3286 scriptpubkey: self.get_closing_scriptpubkey(),
3290 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3291 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3292 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3293 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3294 if msg.next_remote_commitment_number != 0 {
3295 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3297 // Short circuit the whole handler as there is nothing we can resend them
3298 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3301 // We have OurFundingLocked set!
3302 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3303 return Ok((Some(msgs::FundingLocked {
3304 channel_id: self.channel_id(),
3305 next_per_commitment_point,
3306 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3309 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3310 // Remote isn't waiting on any RevokeAndACK from us!
3311 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3313 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3314 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3315 self.monitor_pending_revoke_and_ack = true;
3318 Some(self.get_last_revoke_and_ack())
3321 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3324 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3325 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3326 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3327 // the corresponding revoke_and_ack back yet.
3328 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 };
3330 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3331 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3332 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3333 Some(msgs::FundingLocked {
3334 channel_id: self.channel_id(),
3335 next_per_commitment_point,
3339 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3340 if required_revoke.is_some() {
3341 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3343 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3346 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3347 // We're up-to-date and not waiting on a remote revoke (if we are our
3348 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3349 // have received some updates while we were disconnected. Free the holding cell
3351 match self.free_holding_cell_htlcs(logger) {
3352 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3353 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
3354 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3355 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3356 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3358 Ok((None, htlcs_to_fail)) => {
3359 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3363 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3365 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3366 if required_revoke.is_some() {
3367 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3369 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3372 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3373 self.monitor_pending_commitment_signed = true;
3374 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3377 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3379 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3383 /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
3384 /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
3385 /// at which point they will be recalculated.
3386 fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &F) -> (u64, u64)
3387 where F::Target: FeeEstimator
3389 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
3391 // Propose a range from our current Background feerate to our Normal feerate plus our
3392 // force_close_avoidance_max_fee_satoshis.
3393 // If we fail to come to consensus, we'll have to force-close.
3394 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3395 let normal_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3396 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
3398 // The spec requires that (when the channel does not have anchors) we only send absolute
3399 // channel fees no greater than the absolute channel fee on the current commitment
3400 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
3401 // very good reason to apply such a limit in any case. We don't bother doing so, risking
3402 // some force-closure by old nodes, but we wanted to close the channel anyway.
3404 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
3405 let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
3406 proposed_feerate = cmp::max(proposed_feerate, min_feerate);
3407 proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
3410 // Note that technically we could end up with a lower minimum fee if one sides' balance is
3411 // below our dust limit, causing the output to disappear. We don't bother handling this
3412 // case, however, as this should only happen if a channel is closed before any (material)
3413 // payments have been made on it. This may cause slight fee overpayment and/or failure to
3414 // come to consensus with our counterparty on appropriate fees, however it should be a
3415 // relatively rare case. We can revisit this later, though note that in order to determine
3416 // if the funders' output is dust we have to know the absolute fee we're going to use.
3417 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3418 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3419 let proposed_max_total_fee_satoshis = if self.is_outbound() {
3420 // We always add force_close_avoidance_max_fee_satoshis to our normal
3421 // feerate-calculated fee, but allow the max to be overridden if we're using a
3422 // target feerate-calculated fee.
3423 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.force_close_avoidance_max_fee_satoshis,
3424 proposed_max_feerate as u64 * tx_weight / 1000)
3429 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
3430 self.closing_fee_limits.clone().unwrap()
3433 /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
3434 /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
3435 /// this point if we're the funder we should send the initial closing_signed, and in any case
3436 /// shutdown should complete within a reasonable timeframe.
3437 fn closing_negotiation_ready(&self) -> bool {
3438 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
3439 self.channel_state &
3440 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
3441 ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)
3442 == BOTH_SIDES_SHUTDOWN_MASK &&
3443 self.pending_update_fee.is_none()
3446 /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
3447 /// an Err if no progress is being made and the channel should be force-closed instead.
3448 /// Should be called on a one-minute timer.
3449 pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
3450 if self.closing_negotiation_ready() {
3451 if self.closing_signed_in_flight {
3452 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
3454 self.closing_signed_in_flight = true;
3460 pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(&mut self, fee_estimator: &F, logger: &L)
3461 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3462 where F::Target: FeeEstimator, L::Target: Logger
3464 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
3465 return Ok((None, None));
3468 if !self.is_outbound() {
3469 if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
3470 return self.closing_signed(fee_estimator, &msg);
3472 return Ok((None, None));
3475 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3477 assert!(self.shutdown_scriptpubkey.is_some());
3478 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
3479 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
3480 our_min_fee, our_max_fee, total_fee_satoshis);
3482 let sig = self.holder_signer
3483 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3484 .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
3486 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
3487 Ok((Some(msgs::ClosingSigned {
3488 channel_id: self.channel_id,
3489 fee_satoshis: total_fee_satoshis,
3491 fee_range: Some(msgs::ClosingSignedFeeRange {
3492 min_fee_satoshis: our_min_fee,
3493 max_fee_satoshis: our_max_fee,
3498 pub fn shutdown<K: Deref>(
3499 &mut self, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3500 ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3501 where K::Target: KeysInterface<Signer = Signer>
3503 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3504 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3506 if self.channel_state < ChannelState::FundingSent as u32 {
3507 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3508 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3509 // can do that via error message without getting a connection fail anyway...
3510 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3512 for htlc in self.pending_inbound_htlcs.iter() {
3513 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3514 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3517 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3519 let shutdown_scriptpubkey = match ShutdownScript::try_from((msg.scriptpubkey.clone(), their_features)) {
3520 Ok(script) => script.into_inner(),
3521 Err(_) => return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex()))),
3524 if self.counterparty_shutdown_scriptpubkey.is_some() {
3525 if Some(&shutdown_scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3526 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", shutdown_scriptpubkey.to_bytes().to_hex())));
3529 self.counterparty_shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3532 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
3533 // immediately after the commitment dance, but we can send a Shutdown because we won't send
3534 // any further commitment updates after we set LocalShutdownSent.
3535 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3537 let update_shutdown_script = match self.shutdown_scriptpubkey {
3540 assert!(send_shutdown);
3541 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3542 if !shutdown_scriptpubkey.is_compatible(their_features) {
3543 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
3545 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3550 // From here on out, we may not fail!
3552 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3553 self.update_time_counter += 1;
3555 let monitor_update = if update_shutdown_script {
3556 self.latest_monitor_update_id += 1;
3557 Some(ChannelMonitorUpdate {
3558 update_id: self.latest_monitor_update_id,
3559 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3560 scriptpubkey: self.get_closing_scriptpubkey(),
3564 let shutdown = if send_shutdown {
3565 Some(msgs::Shutdown {
3566 channel_id: self.channel_id,
3567 scriptpubkey: self.get_closing_scriptpubkey(),
3571 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3572 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3573 // cell HTLCs and return them to fail the payment.
3574 self.holding_cell_update_fee = None;
3575 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3576 self.holding_cell_htlc_updates.retain(|htlc_update| {
3578 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3579 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3586 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3587 self.update_time_counter += 1;
3589 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
3592 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3593 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3594 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3595 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3597 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3599 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3600 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3601 if funding_key[..] < counterparty_funding_key[..] {
3602 tx.input[0].witness.push(sig.serialize_der().to_vec());
3603 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3605 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3606 tx.input[0].witness.push(sig.serialize_der().to_vec());
3608 tx.input[0].witness[1].push(SigHashType::All as u8);
3609 tx.input[0].witness[2].push(SigHashType::All as u8);
3611 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3614 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3615 where F::Target: FeeEstimator
3617 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3618 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3620 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3621 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3623 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3624 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3626 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3627 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3630 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
3631 return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
3634 if self.channel_state & ChannelState::MonitorUpdateFailed as u32 != 0 {
3635 self.pending_counterparty_closing_signed = Some(msg.clone());
3636 return Ok((None, None));
3639 let funding_redeemscript = self.get_funding_redeemscript();
3640 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3641 if used_total_fee != msg.fee_satoshis {
3642 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)));
3644 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3646 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3649 // The remote end may have decided to revoke their output due to inconsistent dust
3650 // limits, so check for that case by re-checking the signature here.
3651 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3652 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3653 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3657 assert!(self.shutdown_scriptpubkey.is_some());
3658 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
3659 if last_fee == msg.fee_satoshis {
3660 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3661 self.channel_state = ChannelState::ShutdownComplete as u32;
3662 self.update_time_counter += 1;
3663 return Ok((None, Some(closing_tx)));
3667 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3669 macro_rules! propose_fee {
3670 ($new_fee: expr) => {
3671 let (mut tx, used_fee) = if $new_fee == msg.fee_satoshis {
3672 (closing_tx, $new_fee)
3674 self.build_closing_transaction($new_fee, false)
3677 let sig = self.holder_signer
3678 .sign_closing_transaction(&tx, &self.secp_ctx)
3679 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3681 let signed_tx = if $new_fee == msg.fee_satoshis {
3682 self.channel_state = ChannelState::ShutdownComplete as u32;
3683 self.update_time_counter += 1;
3684 self.build_signed_closing_transaction(&mut tx, &msg.signature, &sig);
3688 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
3689 return Ok((Some(msgs::ClosingSigned {
3690 channel_id: self.channel_id,
3691 fee_satoshis: used_fee,
3693 fee_range: Some(msgs::ClosingSignedFeeRange {
3694 min_fee_satoshis: our_min_fee,
3695 max_fee_satoshis: our_max_fee,
3701 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
3702 if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
3703 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)));
3705 if max_fee_satoshis < our_min_fee {
3706 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)));
3708 if min_fee_satoshis > our_max_fee {
3709 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)));
3712 if !self.is_outbound() {
3713 // They have to pay, so pick the highest fee in the overlapping range.
3714 debug_assert_eq!(our_max_fee, u64::max_value()); // We should never set an upper bound
3715 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
3717 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
3718 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.",
3719 msg.fee_satoshis, our_min_fee, our_max_fee)));
3721 // The proposed fee is in our acceptable range, accept it and broadcast!
3722 propose_fee!(msg.fee_satoshis);
3725 // Old fee style negotiation. We don't bother to enforce whether they are complying
3726 // with the "making progress" requirements, we just comply and hope for the best.
3727 if let Some((last_fee, _)) = self.last_sent_closing_fee {
3728 if msg.fee_satoshis > last_fee {
3729 if msg.fee_satoshis < our_max_fee {
3730 propose_fee!(msg.fee_satoshis);
3731 } else if last_fee < our_max_fee {
3732 propose_fee!(our_max_fee);
3734 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)));
3737 if msg.fee_satoshis > our_min_fee {
3738 propose_fee!(msg.fee_satoshis);
3739 } else if last_fee > our_min_fee {
3740 propose_fee!(our_min_fee);
3742 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)));
3746 if msg.fee_satoshis < our_min_fee {
3747 propose_fee!(our_min_fee);
3748 } else if msg.fee_satoshis > our_max_fee {
3749 propose_fee!(our_max_fee);
3751 propose_fee!(msg.fee_satoshis);
3757 // Public utilities:
3759 pub fn channel_id(&self) -> [u8; 32] {
3763 pub fn minimum_depth(&self) -> Option<u32> {
3767 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3768 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3769 pub fn get_user_id(&self) -> u64 {
3773 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3774 /// is_usable() returns true).
3775 /// Allowed in any state (including after shutdown)
3776 pub fn get_short_channel_id(&self) -> Option<u64> {
3777 self.short_channel_id
3780 /// Returns the funding_txo we either got from our peer, or were given by
3781 /// get_outbound_funding_created.
3782 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3783 self.channel_transaction_parameters.funding_outpoint
3786 fn get_holder_selected_contest_delay(&self) -> u16 {
3787 self.channel_transaction_parameters.holder_selected_contest_delay
3790 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3791 &self.channel_transaction_parameters.holder_pubkeys
3794 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3795 self.channel_transaction_parameters.counterparty_parameters
3796 .as_ref().map(|params| params.selected_contest_delay)
3799 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3800 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3803 /// Allowed in any state (including after shutdown)
3804 pub fn get_counterparty_node_id(&self) -> PublicKey {
3805 self.counterparty_node_id
3808 /// Allowed in any state (including after shutdown)
3810 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3811 self.holder_htlc_minimum_msat
3814 /// Allowed in any state (including after shutdown)
3815 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3817 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3818 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3819 // channel might have been used to route very small values (either by honest users or as DoS).
3820 self.channel_value_satoshis * 1000 * 9 / 10,
3822 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3826 /// Allowed in any state (including after shutdown)
3827 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3828 self.counterparty_htlc_minimum_msat
3831 pub fn get_value_satoshis(&self) -> u64 {
3832 self.channel_value_satoshis
3835 pub fn get_fee_proportional_millionths(&self) -> u32 {
3836 self.config.forwarding_fee_proportional_millionths
3839 pub fn get_cltv_expiry_delta(&self) -> u16 {
3840 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3843 pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
3844 self.config.max_dust_htlc_exposure_msat
3847 pub fn get_feerate(&self) -> u32 {
3851 pub fn get_dust_buffer_feerate(&self) -> u32 {
3852 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
3853 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
3854 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
3855 // more dust balance if the feerate increases when we have several HTLCs pending
3856 // which are near the dust limit.
3857 let mut feerate_per_kw = self.feerate_per_kw;
3858 if let Some((feerate, _)) = self.pending_update_fee {
3859 feerate_per_kw = cmp::max(feerate_per_kw, feerate);
3861 cmp::max(2530, feerate_per_kw * 1250 / 1000)
3864 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3865 self.cur_holder_commitment_transaction_number + 1
3868 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3869 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3872 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3873 self.cur_counterparty_commitment_transaction_number + 2
3877 pub fn get_signer(&self) -> &Signer {
3882 pub fn get_value_stat(&self) -> ChannelValueStat {
3884 value_to_self_msat: self.value_to_self_msat,
3885 channel_value_msat: self.channel_value_satoshis * 1000,
3886 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3887 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3888 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3889 holding_cell_outbound_amount_msat: {
3891 for h in self.holding_cell_htlc_updates.iter() {
3893 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3901 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3902 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3906 /// Allowed in any state (including after shutdown)
3907 pub fn get_update_time_counter(&self) -> u32 {
3908 self.update_time_counter
3911 pub fn get_latest_monitor_update_id(&self) -> u64 {
3912 self.latest_monitor_update_id
3915 pub fn should_announce(&self) -> bool {
3916 self.config.announced_channel
3919 pub fn is_outbound(&self) -> bool {
3920 self.channel_transaction_parameters.is_outbound_from_holder
3923 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3924 /// Allowed in any state (including after shutdown)
3925 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3926 self.config.forwarding_fee_base_msat
3929 /// Returns true if we've ever received a message from the remote end for this Channel
3930 pub fn have_received_message(&self) -> bool {
3931 self.channel_state > (ChannelState::OurInitSent as u32)
3934 /// Returns true if this channel is fully established and not known to be closing.
3935 /// Allowed in any state (including after shutdown)
3936 pub fn is_usable(&self) -> bool {
3937 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3938 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3941 /// Returns true if this channel is currently available for use. This is a superset of
3942 /// is_usable() and considers things like the channel being temporarily disabled.
3943 /// Allowed in any state (including after shutdown)
3944 pub fn is_live(&self) -> bool {
3945 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3948 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3949 /// Allowed in any state (including after shutdown)
3950 pub fn is_awaiting_monitor_update(&self) -> bool {
3951 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3954 /// Returns true if funding_created was sent/received.
3955 pub fn is_funding_initiated(&self) -> bool {
3956 self.channel_state >= ChannelState::FundingSent as u32
3959 /// Returns true if our peer has either initiated or agreed to shut down the channel.
3960 pub fn received_shutdown(&self) -> bool {
3961 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
3964 /// Returns true if we either initiated or agreed to shut down the channel.
3965 pub fn sent_shutdown(&self) -> bool {
3966 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
3969 /// Returns true if this channel is fully shut down. True here implies that no further actions
3970 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3971 /// will be handled appropriately by the chain monitor.
3972 pub fn is_shutdown(&self) -> bool {
3973 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3974 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3979 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3980 self.channel_update_status
3983 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3984 self.channel_update_status = status;
3987 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3988 if self.funding_tx_confirmation_height == 0 {
3992 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3993 if funding_tx_confirmations <= 0 {
3994 self.funding_tx_confirmation_height = 0;
3997 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
4001 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4002 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
4003 self.channel_state |= ChannelState::OurFundingLocked as u32;
4005 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
4006 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
4007 self.update_time_counter += 1;
4009 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
4010 // We got a reorg but not enough to trigger a force close, just ignore.
4012 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
4013 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
4015 // We got a reorg but not enough to trigger a force close, just ignore.
4019 if need_commitment_update {
4020 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
4021 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4022 return Some(msgs::FundingLocked {
4023 channel_id: self.channel_id,
4024 next_per_commitment_point,
4027 self.monitor_pending_funding_locked = true;
4033 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
4034 /// In the first case, we store the confirmation height and calculating the short channel id.
4035 /// In the second, we simply return an Err indicating we need to be force-closed now.
4036 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
4037 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
4038 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4039 for &(index_in_block, tx) in txdata.iter() {
4040 if let Some(funding_txo) = self.get_funding_txo() {
4041 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
4042 // whether they've sent a funding_locked or not), check if we should send one.
4043 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
4044 if tx.txid() == funding_txo.txid {
4045 let txo_idx = funding_txo.index as usize;
4046 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
4047 tx.output[txo_idx].value != self.channel_value_satoshis {
4048 if self.is_outbound() {
4049 // If we generated the funding transaction and it doesn't match what it
4050 // should, the client is really broken and we should just panic and
4051 // tell them off. That said, because hash collisions happen with high
4052 // probability in fuzztarget mode, if we're fuzzing we just close the
4053 // channel and move on.
4054 #[cfg(not(feature = "fuzztarget"))]
4055 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4057 self.update_time_counter += 1;
4058 return Err(msgs::ErrorMessage {
4059 channel_id: self.channel_id(),
4060 data: "funding tx had wrong script/value or output index".to_owned()
4063 if self.is_outbound() {
4064 for input in tx.input.iter() {
4065 if input.witness.is_empty() {
4066 // We generated a malleable funding transaction, implying we've
4067 // just exposed ourselves to funds loss to our counterparty.
4068 #[cfg(not(feature = "fuzztarget"))]
4069 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4073 self.funding_tx_confirmation_height = height;
4074 self.funding_tx_confirmed_in = Some(*block_hash);
4075 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
4076 Ok(scid) => Some(scid),
4077 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
4081 // If we allow 1-conf funding, we may need to check for funding_locked here and
4082 // send it immediately instead of waiting for a best_block_updated call (which
4083 // may have already happened for this block).
4084 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4085 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4086 return Ok(Some(funding_locked));
4089 for inp in tx.input.iter() {
4090 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
4091 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()));
4092 return Err(msgs::ErrorMessage {
4093 channel_id: self.channel_id(),
4094 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
4103 /// When a new block is connected, we check the height of the block against outbound holding
4104 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
4105 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
4106 /// handled by the ChannelMonitor.
4108 /// If we return Err, the channel may have been closed, at which point the standard
4109 /// requirements apply - no calls may be made except those explicitly stated to be allowed
4112 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
4114 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
4115 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
4116 let mut timed_out_htlcs = Vec::new();
4117 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
4118 self.holding_cell_htlc_updates.retain(|htlc_update| {
4120 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
4121 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
4122 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
4130 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
4132 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4133 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4134 return Ok((Some(funding_locked), timed_out_htlcs));
4137 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4138 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
4139 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
4140 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4141 if self.funding_tx_confirmation_height == 0 {
4142 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
4143 // zero if it has been reorged out, however in either case, our state flags
4144 // indicate we've already sent a funding_locked
4145 funding_tx_confirmations = 0;
4148 // If we've sent funding_locked (or have both sent and received funding_locked), and
4149 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
4150 // close the channel and hope we can get the latest state on chain (because presumably
4151 // the funding transaction is at least still in the mempool of most nodes).
4152 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
4153 return Err(msgs::ErrorMessage {
4154 channel_id: self.channel_id(),
4155 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
4160 Ok((None, timed_out_htlcs))
4163 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4164 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4165 /// before the channel has reached funding_locked and we can just wait for more blocks.
4166 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
4167 if self.funding_tx_confirmation_height != 0 {
4168 // We handle the funding disconnection by calling best_block_updated with a height one
4169 // below where our funding was connected, implying a reorg back to conf_height - 1.
4170 let reorg_height = self.funding_tx_confirmation_height - 1;
4171 // We use the time field to bump the current time we set on channel updates if its
4172 // larger. If we don't know that time has moved forward, we can just set it to the last
4173 // time we saw and it will be ignored.
4174 let best_time = self.update_time_counter;
4175 match self.best_block_updated(reorg_height, best_time, logger) {
4176 Ok((funding_locked, timed_out_htlcs)) => {
4177 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
4178 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4184 // We never learned about the funding confirmation anyway, just ignore
4189 // Methods to get unprompted messages to send to the remote end (or where we already returned
4190 // something in the handler for the message that prompted this message):
4192 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
4193 if !self.is_outbound() {
4194 panic!("Tried to open a channel for an inbound channel?");
4196 if self.channel_state != ChannelState::OurInitSent as u32 {
4197 panic!("Cannot generate an open_channel after we've moved forward");
4200 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4201 panic!("Tried to send an open_channel for a channel that has already advanced");
4204 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4205 let keys = self.get_holder_pubkeys();
4209 temporary_channel_id: self.channel_id,
4210 funding_satoshis: self.channel_value_satoshis,
4211 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
4212 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4213 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4214 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4215 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4216 feerate_per_kw: self.feerate_per_kw as u32,
4217 to_self_delay: self.get_holder_selected_contest_delay(),
4218 max_accepted_htlcs: OUR_MAX_HTLCS,
4219 funding_pubkey: keys.funding_pubkey,
4220 revocation_basepoint: keys.revocation_basepoint,
4221 payment_point: keys.payment_point,
4222 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4223 htlc_basepoint: keys.htlc_basepoint,
4224 first_per_commitment_point,
4225 channel_flags: if self.config.announced_channel {1} else {0},
4226 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4227 Some(script) => script.clone().into_inner(),
4228 None => Builder::new().into_script(),
4233 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
4234 if self.is_outbound() {
4235 panic!("Tried to send accept_channel for an outbound channel?");
4237 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
4238 panic!("Tried to send accept_channel after channel had moved forward");
4240 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4241 panic!("Tried to send an accept_channel for a channel that has already advanced");
4244 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4245 let keys = self.get_holder_pubkeys();
4247 msgs::AcceptChannel {
4248 temporary_channel_id: self.channel_id,
4249 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4250 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4251 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4252 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4253 minimum_depth: self.minimum_depth.unwrap(),
4254 to_self_delay: self.get_holder_selected_contest_delay(),
4255 max_accepted_htlcs: OUR_MAX_HTLCS,
4256 funding_pubkey: keys.funding_pubkey,
4257 revocation_basepoint: keys.revocation_basepoint,
4258 payment_point: keys.payment_point,
4259 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4260 htlc_basepoint: keys.htlc_basepoint,
4261 first_per_commitment_point,
4262 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4263 Some(script) => script.clone().into_inner(),
4264 None => Builder::new().into_script(),
4269 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
4270 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
4271 let counterparty_keys = self.build_remote_transaction_keys()?;
4272 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
4273 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
4274 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
4277 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
4278 /// a funding_created message for the remote peer.
4279 /// Panics if called at some time other than immediately after initial handshake, if called twice,
4280 /// or if called on an inbound channel.
4281 /// Note that channel_id changes during this call!
4282 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
4283 /// If an Err is returned, it is a ChannelError::Close.
4284 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 {
4285 if !self.is_outbound() {
4286 panic!("Tried to create outbound funding_created message on an inbound channel!");
4288 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
4289 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)");
4291 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
4292 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
4293 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4294 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
4297 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
4298 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
4300 let signature = match self.get_outbound_funding_created_signature(logger) {
4303 log_error!(logger, "Got bad signatures: {:?}!", e);
4304 self.channel_transaction_parameters.funding_outpoint = None;
4309 let temporary_channel_id = self.channel_id;
4311 // Now that we're past error-generating stuff, update our local state:
4313 self.channel_state = ChannelState::FundingCreated as u32;
4314 self.channel_id = funding_txo.to_channel_id();
4315 self.funding_transaction = Some(funding_transaction);
4317 Ok(msgs::FundingCreated {
4318 temporary_channel_id,
4319 funding_txid: funding_txo.txid,
4320 funding_output_index: funding_txo.index,
4325 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4326 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4327 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4328 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4329 /// Will only fail if we're not in a state where channel_announcement may be sent (including
4331 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4332 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4334 /// This will only return ChannelError::Ignore upon failure.
4335 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4336 if !self.config.announced_channel {
4337 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4339 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4340 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4342 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4343 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4346 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4348 let msg = msgs::UnsignedChannelAnnouncement {
4349 features: ChannelFeatures::known(),
4351 short_channel_id: self.get_short_channel_id().unwrap(),
4352 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4353 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4354 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4355 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4356 excess_data: Vec::new(),
4359 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4360 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4365 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4367 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> {
4368 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4369 let were_node_one = announcement.node_id_1 == our_node_id;
4371 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4372 Ok(msgs::ChannelAnnouncement {
4373 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4374 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4375 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4376 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4377 contents: announcement,
4380 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4384 /// Processes an incoming announcement_signatures message, providing a fully-signed
4385 /// channel_announcement message which we can broadcast and storing our counterparty's
4386 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4387 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4388 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4390 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4392 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4393 return Err(ChannelError::Close(format!(
4394 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4395 &announcement, self.get_counterparty_node_id())));
4397 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4398 return Err(ChannelError::Close(format!(
4399 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4400 &announcement, self.counterparty_funding_pubkey())));
4403 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4405 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4408 /// Gets a signed channel_announcement for this channel, if we previously received an
4409 /// announcement_signatures from our counterparty.
4410 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4411 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4413 Err(_) => return None,
4415 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4416 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4417 Ok(res) => Some(res),
4422 /// May panic if called on a channel that wasn't immediately-previously
4423 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4424 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4425 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4426 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4427 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4428 // current to_remote balances. However, it no longer has any use, and thus is now simply
4429 // set to a dummy (but valid, as required by the spec) public key.
4430 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4431 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4432 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4433 let mut pk = [2; 33]; pk[1] = 0xff;
4434 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4435 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4436 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4437 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()));
4438 OptionalField::Present(DataLossProtect {
4439 your_last_per_commitment_secret: remote_last_secret,
4440 my_current_per_commitment_point: dummy_pubkey
4443 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4444 OptionalField::Present(DataLossProtect {
4445 your_last_per_commitment_secret: [0;32],
4446 my_current_per_commitment_point: dummy_pubkey,
4449 msgs::ChannelReestablish {
4450 channel_id: self.channel_id(),
4451 // The protocol has two different commitment number concepts - the "commitment
4452 // transaction number", which starts from 0 and counts up, and the "revocation key
4453 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4454 // commitment transaction numbers by the index which will be used to reveal the
4455 // revocation key for that commitment transaction, which means we have to convert them
4456 // to protocol-level commitment numbers here...
4458 // next_local_commitment_number is the next commitment_signed number we expect to
4459 // receive (indicating if they need to resend one that we missed).
4460 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4461 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4462 // receive, however we track it by the next commitment number for a remote transaction
4463 // (which is one further, as they always revoke previous commitment transaction, not
4464 // the one we send) so we have to decrement by 1. Note that if
4465 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4466 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4468 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4474 // Send stuff to our remote peers:
4476 /// Adds a pending outbound HTLC to this channel, note that you probably want
4477 /// send_htlc_and_commit instead cause you'll want both messages at once.
4479 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4481 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4482 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4484 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4485 /// may not yet have sent the previous commitment update messages and will need to regenerate
4488 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4490 /// If an Err is returned, it's a ChannelError::Ignore!
4491 pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
4492 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4493 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4495 let channel_total_msat = self.channel_value_satoshis * 1000;
4496 if amount_msat > channel_total_msat {
4497 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4500 if amount_msat == 0 {
4501 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4504 if amount_msat < self.counterparty_htlc_minimum_msat {
4505 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4508 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4509 // Note that this should never really happen, if we're !is_live() on receipt of an
4510 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4511 // the user to send directly into a !is_live() channel. However, if we
4512 // disconnected during the time the previous hop was doing the commitment dance we may
4513 // end up getting here after the forwarding delay. In any case, returning an
4514 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4515 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4518 let inbound_stats = self.get_inbound_pending_htlc_stats();
4519 let outbound_stats = self.get_outbound_pending_htlc_stats();
4520 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
4521 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4523 // Check their_max_htlc_value_in_flight_msat
4524 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4525 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)));
4528 if !self.is_outbound() {
4529 // Check that we won't violate the remote channel reserve by adding this HTLC.
4530 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4531 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4532 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4533 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4534 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4535 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4539 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
4540 if amount_msat / 1000 < exposure_dust_limit_success_sats {
4541 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;
4542 if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4543 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
4544 on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4548 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
4549 if amount_msat / 1000 < exposure_dust_limit_timeout_sats {
4550 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;
4551 if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4552 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
4553 on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4557 let pending_value_to_self_msat = self.value_to_self_msat - outbound_stats.pending_htlcs_value_msat;
4558 if pending_value_to_self_msat < amount_msat {
4559 return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, pending_value_to_self_msat)));
4562 // `2 *` and extra HTLC are for the fee spike buffer.
4563 let commit_tx_fee_msat = if self.is_outbound() {
4564 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4565 FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4567 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4568 return Err(ChannelError::Ignore(format!("Cannot send value that would not leave enough to pay for fees. Pending value to self: {}. local_commit_tx_fee {}", pending_value_to_self_msat, commit_tx_fee_msat)));
4571 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4572 // reserve for the remote to have something to claim if we misbehave)
4573 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4574 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4575 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4578 // Now update local state:
4579 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4580 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4585 onion_routing_packet,
4590 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4591 htlc_id: self.next_holder_htlc_id,
4593 payment_hash: payment_hash.clone(),
4595 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4599 let res = msgs::UpdateAddHTLC {
4600 channel_id: self.channel_id,
4601 htlc_id: self.next_holder_htlc_id,
4605 onion_routing_packet,
4607 self.next_holder_htlc_id += 1;
4612 /// Creates a signed commitment transaction to send to the remote peer.
4613 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4614 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4615 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4616 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4617 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4618 panic!("Cannot create commitment tx until channel is fully established");
4620 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4621 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4623 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4624 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4626 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4627 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");
4629 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
4630 for htlc in self.pending_outbound_htlcs.iter() {
4631 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4632 have_updates = true;
4634 if have_updates { break; }
4636 for htlc in self.pending_inbound_htlcs.iter() {
4637 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4638 have_updates = true;
4640 if have_updates { break; }
4643 panic!("Cannot create commitment tx until we have some updates to send");
4645 self.send_commitment_no_status_check(logger)
4647 /// Only fails in case of bad keys
4648 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4649 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
4650 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4651 // fail to generate this, we still are at least at a position where upgrading their status
4653 for htlc in self.pending_inbound_htlcs.iter_mut() {
4654 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4655 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4657 if let Some(state) = new_state {
4658 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4662 for htlc in self.pending_outbound_htlcs.iter_mut() {
4663 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4664 Some(fail_reason.take())
4666 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4667 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4670 if let Some((feerate, update_state)) = self.pending_update_fee {
4671 if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
4672 debug_assert!(!self.is_outbound());
4673 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4674 self.feerate_per_kw = feerate;
4675 self.pending_update_fee = None;
4678 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4680 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4681 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4682 // Update state now that we've passed all the can-fail calls...
4683 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4684 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4685 (res, counterparty_commitment_tx, htlcs_no_ref)
4687 Err(e) => return Err(e),
4690 self.latest_monitor_update_id += 1;
4691 let monitor_update = ChannelMonitorUpdate {
4692 update_id: self.latest_monitor_update_id,
4693 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4694 commitment_txid: counterparty_commitment_txid,
4695 htlc_outputs: htlcs.clone(),
4696 commitment_number: self.cur_counterparty_commitment_transaction_number,
4697 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4700 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4701 Ok((res, monitor_update))
4704 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4705 /// when we shouldn't change HTLC/channel state.
4706 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4707 let counterparty_keys = self.build_remote_transaction_keys()?;
4708 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
4709 let feerate_per_kw = counterparty_commitment_tx.1;
4710 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4711 let (signature, htlc_signatures);
4713 #[cfg(any(test, feature = "fuzztarget"))]
4715 if !self.is_outbound() {
4716 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4717 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4718 if let Some(info) = projected_commit_tx_info {
4719 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4720 if info.total_pending_htlcs == total_pending_htlcs
4721 && info.next_holder_htlc_id == self.next_holder_htlc_id
4722 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4723 && info.feerate == self.feerate_per_kw {
4724 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.2);
4725 assert_eq!(actual_fee, info.fee);
4732 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.3.len());
4733 for &(ref htlc, _) in counterparty_commitment_tx.3.iter() {
4737 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4738 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4740 htlc_signatures = res.1;
4742 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4743 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4744 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4745 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4747 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4748 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4749 encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
4750 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4751 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4752 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4756 Ok((msgs::CommitmentSigned {
4757 channel_id: self.channel_id,
4760 }, (counterparty_commitment_txid, counterparty_commitment_tx.3)))
4763 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4764 /// to send to the remote peer in one go.
4765 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4767 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 {
4768 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4769 Some(update_add_htlc) => {
4770 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4771 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4777 /// Get forwarding information for the counterparty.
4778 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4779 self.counterparty_forwarding_info.clone()
4782 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4783 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4784 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4786 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4787 fee_base_msat: msg.contents.fee_base_msat,
4788 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4789 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4795 /// Begins the shutdown process, getting a message for the remote peer and returning all
4796 /// holding cell HTLCs for payment failure.
4797 pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures, target_feerate_sats_per_kw: Option<u32>)
4798 -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
4799 where K::Target: KeysInterface<Signer = Signer> {
4800 for htlc in self.pending_outbound_htlcs.iter() {
4801 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4802 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4805 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4806 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4807 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4809 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4810 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4813 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4814 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4815 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()});
4818 let update_shutdown_script = match self.shutdown_scriptpubkey {
4821 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
4822 if !shutdown_scriptpubkey.is_compatible(their_features) {
4823 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
4825 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4830 // From here on out, we may not fail!
4831 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
4832 if self.channel_state < ChannelState::FundingSent as u32 {
4833 self.channel_state = ChannelState::ShutdownComplete as u32;
4835 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4837 self.update_time_counter += 1;
4839 let monitor_update = if update_shutdown_script {
4840 self.latest_monitor_update_id += 1;
4841 Some(ChannelMonitorUpdate {
4842 update_id: self.latest_monitor_update_id,
4843 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4844 scriptpubkey: self.get_closing_scriptpubkey(),
4848 let shutdown = msgs::Shutdown {
4849 channel_id: self.channel_id,
4850 scriptpubkey: self.get_closing_scriptpubkey(),
4853 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4854 // our shutdown until we've committed all of the pending changes.
4855 self.holding_cell_update_fee = None;
4856 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4857 self.holding_cell_htlc_updates.retain(|htlc_update| {
4859 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4860 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4867 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4870 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4871 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4872 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4873 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4874 /// immediately (others we will have to allow to time out).
4875 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4876 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4877 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4878 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4879 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4880 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4882 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4883 // return them to fail the payment.
4884 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4885 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4887 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4888 dropped_outbound_htlcs.push((source, payment_hash));
4893 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4894 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4895 // returning a channel monitor update here would imply a channel monitor update before
4896 // we even registered the channel monitor to begin with, which is invalid.
4897 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4898 // funding transaction, don't return a funding txo (which prevents providing the
4899 // monitor update to the user, even if we return one).
4900 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4901 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4902 self.latest_monitor_update_id += 1;
4903 Some((funding_txo, ChannelMonitorUpdate {
4904 update_id: self.latest_monitor_update_id,
4905 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4910 self.channel_state = ChannelState::ShutdownComplete as u32;
4911 self.update_time_counter += 1;
4912 (monitor_update, dropped_outbound_htlcs)
4916 const SERIALIZATION_VERSION: u8 = 2;
4917 const MIN_SERIALIZATION_VERSION: u8 = 1;
4919 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4925 impl Writeable for ChannelUpdateStatus {
4926 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4927 // We only care about writing out the current state as it was announced, ie only either
4928 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4929 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4931 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4932 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4933 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4934 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4940 impl Readable for ChannelUpdateStatus {
4941 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4942 Ok(match <u8 as Readable>::read(reader)? {
4943 0 => ChannelUpdateStatus::Enabled,
4944 1 => ChannelUpdateStatus::Disabled,
4945 _ => return Err(DecodeError::InvalidValue),
4950 impl<Signer: Sign> Writeable for Channel<Signer> {
4951 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4952 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4955 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4957 self.user_id.write(writer)?;
4959 // Write out the old serialization for the config object. This is read by version-1
4960 // deserializers, but we will read the version in the TLV at the end instead.
4961 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4962 self.config.cltv_expiry_delta.write(writer)?;
4963 self.config.announced_channel.write(writer)?;
4964 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4966 self.channel_id.write(writer)?;
4967 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4968 self.channel_value_satoshis.write(writer)?;
4970 self.latest_monitor_update_id.write(writer)?;
4972 let mut key_data = VecWriter(Vec::new());
4973 self.holder_signer.write(&mut key_data)?;
4974 assert!(key_data.0.len() < core::usize::MAX);
4975 assert!(key_data.0.len() < core::u32::MAX as usize);
4976 (key_data.0.len() as u32).write(writer)?;
4977 writer.write_all(&key_data.0[..])?;
4979 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4980 // deserialized from that format.
4981 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4982 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4983 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4985 self.destination_script.write(writer)?;
4987 self.cur_holder_commitment_transaction_number.write(writer)?;
4988 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4989 self.value_to_self_msat.write(writer)?;
4991 let mut dropped_inbound_htlcs = 0;
4992 for htlc in self.pending_inbound_htlcs.iter() {
4993 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4994 dropped_inbound_htlcs += 1;
4997 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4998 for htlc in self.pending_inbound_htlcs.iter() {
4999 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
5002 htlc.htlc_id.write(writer)?;
5003 htlc.amount_msat.write(writer)?;
5004 htlc.cltv_expiry.write(writer)?;
5005 htlc.payment_hash.write(writer)?;
5007 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
5008 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
5010 htlc_state.write(writer)?;
5012 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
5014 htlc_state.write(writer)?;
5016 &InboundHTLCState::Committed => {
5019 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
5021 removal_reason.write(writer)?;
5026 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
5027 for htlc in self.pending_outbound_htlcs.iter() {
5028 htlc.htlc_id.write(writer)?;
5029 htlc.amount_msat.write(writer)?;
5030 htlc.cltv_expiry.write(writer)?;
5031 htlc.payment_hash.write(writer)?;
5032 htlc.source.write(writer)?;
5034 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
5036 onion_packet.write(writer)?;
5038 &OutboundHTLCState::Committed => {
5041 &OutboundHTLCState::RemoteRemoved(_) => {
5042 // Treat this as a Committed because we haven't received the CS - they'll
5043 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
5046 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
5048 fail_reason.write(writer)?;
5050 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
5052 fail_reason.write(writer)?;
5057 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
5058 for update in self.holding_cell_htlc_updates.iter() {
5060 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
5062 amount_msat.write(writer)?;
5063 cltv_expiry.write(writer)?;
5064 payment_hash.write(writer)?;
5065 source.write(writer)?;
5066 onion_routing_packet.write(writer)?;
5068 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
5070 payment_preimage.write(writer)?;
5071 htlc_id.write(writer)?;
5073 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
5075 htlc_id.write(writer)?;
5076 err_packet.write(writer)?;
5081 match self.resend_order {
5082 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
5083 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
5086 self.monitor_pending_funding_locked.write(writer)?;
5087 self.monitor_pending_revoke_and_ack.write(writer)?;
5088 self.monitor_pending_commitment_signed.write(writer)?;
5090 (self.monitor_pending_forwards.len() as u64).write(writer)?;
5091 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
5092 pending_forward.write(writer)?;
5093 htlc_id.write(writer)?;
5096 (self.monitor_pending_failures.len() as u64).write(writer)?;
5097 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
5098 htlc_source.write(writer)?;
5099 payment_hash.write(writer)?;
5100 fail_reason.write(writer)?;
5103 if self.is_outbound() {
5104 self.pending_update_fee.map(|(a, _)| a).write(writer)?;
5105 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
5106 // As for inbound HTLCs, if the update was only announced and never committed, drop it.
5107 Some(feerate).write(writer)?;
5109 None::<u32>.write(writer)?;
5111 self.holding_cell_update_fee.write(writer)?;
5113 self.next_holder_htlc_id.write(writer)?;
5114 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
5115 self.update_time_counter.write(writer)?;
5116 self.feerate_per_kw.write(writer)?;
5118 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5119 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5120 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5121 // consider the stale state on reload.
5124 self.funding_tx_confirmed_in.write(writer)?;
5125 self.funding_tx_confirmation_height.write(writer)?;
5126 self.short_channel_id.write(writer)?;
5128 self.counterparty_dust_limit_satoshis.write(writer)?;
5129 self.holder_dust_limit_satoshis.write(writer)?;
5130 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
5132 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5133 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
5135 self.counterparty_htlc_minimum_msat.write(writer)?;
5136 self.holder_htlc_minimum_msat.write(writer)?;
5137 self.counterparty_max_accepted_htlcs.write(writer)?;
5139 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5140 self.minimum_depth.unwrap_or(0).write(writer)?;
5142 match &self.counterparty_forwarding_info {
5145 info.fee_base_msat.write(writer)?;
5146 info.fee_proportional_millionths.write(writer)?;
5147 info.cltv_expiry_delta.write(writer)?;
5149 None => 0u8.write(writer)?
5152 self.channel_transaction_parameters.write(writer)?;
5153 self.funding_transaction.write(writer)?;
5155 self.counterparty_cur_commitment_point.write(writer)?;
5156 self.counterparty_prev_commitment_point.write(writer)?;
5157 self.counterparty_node_id.write(writer)?;
5159 self.counterparty_shutdown_scriptpubkey.write(writer)?;
5161 self.commitment_secrets.write(writer)?;
5163 self.channel_update_status.write(writer)?;
5165 #[cfg(any(test, feature = "fuzztarget"))]
5166 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
5167 #[cfg(any(test, feature = "fuzztarget"))]
5168 for htlc in self.historical_inbound_htlc_fulfills.iter() {
5169 htlc.write(writer)?;
5172 write_tlv_fields!(writer, {
5173 (0, self.announcement_sigs, option),
5174 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
5175 // default value instead of being Option<>al. Thus, to maintain compatibility we write
5176 // them twice, once with their original default values above, and once as an option
5177 // here. On the read side, old versions will simply ignore the odd-type entries here,
5178 // and new versions map the default values to None and allow the TLV entries here to
5180 (1, self.minimum_depth, option),
5181 (3, self.counterparty_selected_channel_reserve_satoshis, option),
5182 (5, self.config, required),
5183 (7, self.shutdown_scriptpubkey, option),
5184 (9, self.target_closing_feerate_sats_per_kw, option),
5191 const MAX_ALLOC_SIZE: usize = 64*1024;
5192 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
5193 where K::Target: KeysInterface<Signer = Signer> {
5194 fn read<R : io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
5195 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5197 let user_id = Readable::read(reader)?;
5199 let mut config = Some(ChannelConfig::default());
5201 // Read the old serialization of the ChannelConfig from version 0.0.98.
5202 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
5203 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
5204 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5205 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5207 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
5208 let mut _val: u64 = Readable::read(reader)?;
5211 let channel_id = Readable::read(reader)?;
5212 let channel_state = Readable::read(reader)?;
5213 let channel_value_satoshis = Readable::read(reader)?;
5215 let latest_monitor_update_id = Readable::read(reader)?;
5217 let keys_len: u32 = Readable::read(reader)?;
5218 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
5219 while keys_data.len() != keys_len as usize {
5220 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
5221 let mut data = [0; 1024];
5222 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
5223 reader.read_exact(read_slice)?;
5224 keys_data.extend_from_slice(read_slice);
5226 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
5228 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
5229 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
5230 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
5233 let destination_script = Readable::read(reader)?;
5235 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
5236 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
5237 let value_to_self_msat = Readable::read(reader)?;
5239 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
5240 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5241 for _ in 0..pending_inbound_htlc_count {
5242 pending_inbound_htlcs.push(InboundHTLCOutput {
5243 htlc_id: Readable::read(reader)?,
5244 amount_msat: Readable::read(reader)?,
5245 cltv_expiry: Readable::read(reader)?,
5246 payment_hash: Readable::read(reader)?,
5247 state: match <u8 as Readable>::read(reader)? {
5248 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
5249 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
5250 3 => InboundHTLCState::Committed,
5251 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
5252 _ => return Err(DecodeError::InvalidValue),
5257 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
5258 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5259 for _ in 0..pending_outbound_htlc_count {
5260 pending_outbound_htlcs.push(OutboundHTLCOutput {
5261 htlc_id: Readable::read(reader)?,
5262 amount_msat: Readable::read(reader)?,
5263 cltv_expiry: Readable::read(reader)?,
5264 payment_hash: Readable::read(reader)?,
5265 source: Readable::read(reader)?,
5266 state: match <u8 as Readable>::read(reader)? {
5267 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
5268 1 => OutboundHTLCState::Committed,
5269 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
5270 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
5271 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
5272 _ => return Err(DecodeError::InvalidValue),
5277 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
5278 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
5279 for _ in 0..holding_cell_htlc_update_count {
5280 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
5281 0 => HTLCUpdateAwaitingACK::AddHTLC {
5282 amount_msat: Readable::read(reader)?,
5283 cltv_expiry: Readable::read(reader)?,
5284 payment_hash: Readable::read(reader)?,
5285 source: Readable::read(reader)?,
5286 onion_routing_packet: Readable::read(reader)?,
5288 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
5289 payment_preimage: Readable::read(reader)?,
5290 htlc_id: Readable::read(reader)?,
5292 2 => HTLCUpdateAwaitingACK::FailHTLC {
5293 htlc_id: Readable::read(reader)?,
5294 err_packet: Readable::read(reader)?,
5296 _ => return Err(DecodeError::InvalidValue),
5300 let resend_order = match <u8 as Readable>::read(reader)? {
5301 0 => RAACommitmentOrder::CommitmentFirst,
5302 1 => RAACommitmentOrder::RevokeAndACKFirst,
5303 _ => return Err(DecodeError::InvalidValue),
5306 let monitor_pending_funding_locked = Readable::read(reader)?;
5307 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
5308 let monitor_pending_commitment_signed = Readable::read(reader)?;
5310 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
5311 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
5312 for _ in 0..monitor_pending_forwards_count {
5313 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
5316 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
5317 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
5318 for _ in 0..monitor_pending_failures_count {
5319 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
5322 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
5324 let holding_cell_update_fee = Readable::read(reader)?;
5326 let next_holder_htlc_id = Readable::read(reader)?;
5327 let next_counterparty_htlc_id = Readable::read(reader)?;
5328 let update_time_counter = Readable::read(reader)?;
5329 let feerate_per_kw = Readable::read(reader)?;
5331 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5332 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5333 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5334 // consider the stale state on reload.
5335 match <u8 as Readable>::read(reader)? {
5338 let _: u32 = Readable::read(reader)?;
5339 let _: u64 = Readable::read(reader)?;
5340 let _: Signature = Readable::read(reader)?;
5342 _ => return Err(DecodeError::InvalidValue),
5345 let funding_tx_confirmed_in = Readable::read(reader)?;
5346 let funding_tx_confirmation_height = Readable::read(reader)?;
5347 let short_channel_id = Readable::read(reader)?;
5349 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
5350 let holder_dust_limit_satoshis = Readable::read(reader)?;
5351 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
5352 let mut counterparty_selected_channel_reserve_satoshis = None;
5354 // Read the old serialization from version 0.0.98.
5355 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
5357 // Read the 8 bytes of backwards-compatibility data.
5358 let _dummy: u64 = Readable::read(reader)?;
5360 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
5361 let holder_htlc_minimum_msat = Readable::read(reader)?;
5362 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
5364 let mut minimum_depth = None;
5366 // Read the old serialization from version 0.0.98.
5367 minimum_depth = Some(Readable::read(reader)?);
5369 // Read the 4 bytes of backwards-compatibility data.
5370 let _dummy: u32 = Readable::read(reader)?;
5373 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5375 1 => Some(CounterpartyForwardingInfo {
5376 fee_base_msat: Readable::read(reader)?,
5377 fee_proportional_millionths: Readable::read(reader)?,
5378 cltv_expiry_delta: Readable::read(reader)?,
5380 _ => return Err(DecodeError::InvalidValue),
5383 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
5384 let funding_transaction = Readable::read(reader)?;
5386 let counterparty_cur_commitment_point = Readable::read(reader)?;
5388 let counterparty_prev_commitment_point = Readable::read(reader)?;
5389 let counterparty_node_id = Readable::read(reader)?;
5391 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5392 let commitment_secrets = Readable::read(reader)?;
5394 let channel_update_status = Readable::read(reader)?;
5396 #[cfg(any(test, feature = "fuzztarget"))]
5397 let mut historical_inbound_htlc_fulfills = HashSet::new();
5398 #[cfg(any(test, feature = "fuzztarget"))]
5400 let htlc_fulfills_len: u64 = Readable::read(reader)?;
5401 for _ in 0..htlc_fulfills_len {
5402 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5406 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
5407 Some((feerate, if channel_parameters.is_outbound_from_holder {
5408 FeeUpdateState::Outbound
5410 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
5416 let mut announcement_sigs = None;
5417 let mut target_closing_feerate_sats_per_kw = None;
5418 read_tlv_fields!(reader, {
5419 (0, announcement_sigs, option),
5420 (1, minimum_depth, option),
5421 (3, counterparty_selected_channel_reserve_satoshis, option),
5422 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5423 (7, shutdown_scriptpubkey, option),
5424 (9, target_closing_feerate_sats_per_kw, option),
5427 let mut secp_ctx = Secp256k1::new();
5428 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5433 config: config.unwrap(),
5437 channel_value_satoshis,
5439 latest_monitor_update_id,
5442 shutdown_scriptpubkey,
5445 cur_holder_commitment_transaction_number,
5446 cur_counterparty_commitment_transaction_number,
5449 pending_inbound_htlcs,
5450 pending_outbound_htlcs,
5451 holding_cell_htlc_updates,
5455 monitor_pending_funding_locked,
5456 monitor_pending_revoke_and_ack,
5457 monitor_pending_commitment_signed,
5458 monitor_pending_forwards,
5459 monitor_pending_failures,
5462 holding_cell_update_fee,
5463 next_holder_htlc_id,
5464 next_counterparty_htlc_id,
5465 update_time_counter,
5468 #[cfg(debug_assertions)]
5469 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5470 #[cfg(debug_assertions)]
5471 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5473 last_sent_closing_fee: None,
5474 pending_counterparty_closing_signed: None,
5475 closing_fee_limits: None,
5476 target_closing_feerate_sats_per_kw,
5478 funding_tx_confirmed_in,
5479 funding_tx_confirmation_height,
5482 counterparty_dust_limit_satoshis,
5483 holder_dust_limit_satoshis,
5484 counterparty_max_htlc_value_in_flight_msat,
5485 counterparty_selected_channel_reserve_satoshis,
5486 counterparty_htlc_minimum_msat,
5487 holder_htlc_minimum_msat,
5488 counterparty_max_accepted_htlcs,
5491 counterparty_forwarding_info,
5493 channel_transaction_parameters: channel_parameters,
5494 funding_transaction,
5496 counterparty_cur_commitment_point,
5497 counterparty_prev_commitment_point,
5498 counterparty_node_id,
5500 counterparty_shutdown_scriptpubkey,
5504 channel_update_status,
5505 closing_signed_in_flight: false,
5509 #[cfg(any(test, feature = "fuzztarget"))]
5510 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5511 #[cfg(any(test, feature = "fuzztarget"))]
5512 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5514 workaround_lnd_bug_4006: None,
5516 #[cfg(any(test, feature = "fuzztarget"))]
5517 historical_inbound_htlc_fulfills,
5524 use bitcoin::util::bip143;
5525 use bitcoin::consensus::encode::serialize;
5526 use bitcoin::blockdata::script::{Script, Builder};
5527 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5528 use bitcoin::blockdata::constants::genesis_block;
5529 use bitcoin::blockdata::opcodes;
5530 use bitcoin::network::constants::Network;
5531 use bitcoin::hashes::hex::FromHex;
5533 use ln::{PaymentPreimage, PaymentHash};
5534 use ln::channelmanager::HTLCSource;
5535 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5536 use ln::channel::MAX_FUNDING_SATOSHIS;
5537 use ln::features::InitFeatures;
5538 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5539 use ln::script::ShutdownScript;
5541 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5542 use chain::BestBlock;
5543 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5544 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5545 use chain::transaction::OutPoint;
5546 use util::config::UserConfig;
5547 use util::enforcing_trait_impls::EnforcingSigner;
5548 use util::errors::APIError;
5549 use util::test_utils;
5550 use util::test_utils::OnGetShutdownScriptpubkey;
5551 use util::logger::Logger;
5552 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5553 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5554 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5555 use bitcoin::secp256k1::recovery::RecoverableSignature;
5556 use bitcoin::hashes::sha256::Hash as Sha256;
5557 use bitcoin::hashes::Hash;
5558 use bitcoin::hash_types::{Txid, WPubkeyHash};
5559 use core::num::NonZeroU8;
5563 struct TestFeeEstimator {
5566 impl FeeEstimator for TestFeeEstimator {
5567 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5573 fn test_max_funding_satoshis() {
5574 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5575 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5579 signer: InMemorySigner,
5581 impl KeysInterface for Keys {
5582 type Signer = InMemorySigner;
5584 fn get_node_secret(&self) -> SecretKey { panic!(); }
5585 fn get_destination_script(&self) -> Script {
5586 let secp_ctx = Secp256k1::signing_only();
5587 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5588 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5589 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5592 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5593 let secp_ctx = Secp256k1::signing_only();
5594 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5595 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5598 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5601 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5602 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5603 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5606 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5607 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5611 fn upfront_shutdown_script_incompatibility() {
5612 let features = InitFeatures::known().clear_shutdown_anysegwit();
5613 let non_v0_segwit_shutdown_script =
5614 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
5616 let seed = [42; 32];
5617 let network = Network::Testnet;
5618 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5619 keys_provider.expect(OnGetShutdownScriptpubkey {
5620 returns: non_v0_segwit_shutdown_script.clone(),
5623 let fee_estimator = TestFeeEstimator { fee_est: 253 };
5624 let secp_ctx = Secp256k1::new();
5625 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5626 let config = UserConfig::default();
5627 match Channel::<EnforcingSigner>::new_outbound(&&fee_estimator, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config) {
5628 Err(APIError::IncompatibleShutdownScript { script }) => {
5629 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
5631 Err(e) => panic!("Unexpected error: {:?}", e),
5632 Ok(_) => panic!("Expected error"),
5636 // Check that, during channel creation, we use the same feerate in the open channel message
5637 // as we do in the Channel object creation itself.
5639 fn test_open_channel_msg_fee() {
5640 let original_fee = 253;
5641 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5642 let secp_ctx = Secp256k1::new();
5643 let seed = [42; 32];
5644 let network = Network::Testnet;
5645 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5647 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5648 let config = UserConfig::default();
5649 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5651 // Now change the fee so we can check that the fee in the open_channel message is the
5652 // same as the old fee.
5653 fee_est.fee_est = 500;
5654 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5655 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5659 fn test_holder_vs_counterparty_dust_limit() {
5660 // Test that when calculating the local and remote commitment transaction fees, the correct
5661 // dust limits are used.
5662 let feeest = TestFeeEstimator{fee_est: 15000};
5663 let secp_ctx = Secp256k1::new();
5664 let seed = [42; 32];
5665 let network = Network::Testnet;
5666 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5668 // Go through the flow of opening a channel between two nodes, making sure
5669 // they have different dust limits.
5671 // Create Node A's channel pointing to Node B's pubkey
5672 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5673 let config = UserConfig::default();
5674 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5676 // Create Node B's channel by receiving Node A's open_channel message
5677 // Make sure A's dust limit is as we expect.
5678 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5679 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5680 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5682 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5683 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5684 accept_channel_msg.dust_limit_satoshis = 546;
5685 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5686 node_a_chan.holder_dust_limit_satoshis = 1560;
5688 // Put some inbound and outbound HTLCs in A's channel.
5689 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5690 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5692 amount_msat: htlc_amount_msat,
5693 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5694 cltv_expiry: 300000000,
5695 state: InboundHTLCState::Committed,
5698 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5700 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5701 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5702 cltv_expiry: 200000000,
5703 state: OutboundHTLCState::Committed,
5704 source: HTLCSource::OutboundRoute {
5706 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5707 first_hop_htlc_msat: 548,
5711 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5712 // the dust limit check.
5713 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5714 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5715 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5716 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5718 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5719 // of the HTLCs are seen to be above the dust limit.
5720 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5721 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5722 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5723 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5724 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5728 fn test_timeout_vs_success_htlc_dust_limit() {
5729 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5730 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5731 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5732 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5733 let fee_est = TestFeeEstimator{fee_est: 253 };
5734 let secp_ctx = Secp256k1::new();
5735 let seed = [42; 32];
5736 let network = Network::Testnet;
5737 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5739 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5740 let config = UserConfig::default();
5741 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5743 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5744 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5746 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5747 // counted as dust when it shouldn't be.
5748 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5749 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5750 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5751 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5753 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5754 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5755 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5756 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5757 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5759 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5761 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5762 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5763 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5764 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5765 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5767 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5768 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5769 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5770 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5771 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5775 fn channel_reestablish_no_updates() {
5776 let feeest = TestFeeEstimator{fee_est: 15000};
5777 let logger = test_utils::TestLogger::new();
5778 let secp_ctx = Secp256k1::new();
5779 let seed = [42; 32];
5780 let network = Network::Testnet;
5781 let best_block = BestBlock::from_genesis(network);
5782 let chain_hash = best_block.block_hash();
5783 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5785 // Go through the flow of opening a channel between two nodes.
5787 // Create Node A's channel pointing to Node B's pubkey
5788 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5789 let config = UserConfig::default();
5790 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5792 // Create Node B's channel by receiving Node A's open_channel message
5793 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5794 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5795 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5797 // Node B --> Node A: accept channel
5798 let accept_channel_msg = node_b_chan.get_accept_channel();
5799 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5801 // Node A --> Node B: funding created
5802 let output_script = node_a_chan.get_funding_redeemscript();
5803 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5804 value: 10000000, script_pubkey: output_script.clone(),
5806 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5807 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5808 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5810 // Node B --> Node A: funding signed
5811 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5813 // Now disconnect the two nodes and check that the commitment point in
5814 // Node B's channel_reestablish message is sane.
5815 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5816 let msg = node_b_chan.get_channel_reestablish(&&logger);
5817 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5818 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5819 match msg.data_loss_protect {
5820 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5821 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5826 // Check that the commitment point in Node A's channel_reestablish message
5828 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5829 let msg = node_a_chan.get_channel_reestablish(&&logger);
5830 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5831 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5832 match msg.data_loss_protect {
5833 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5834 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5841 fn channel_update() {
5842 let feeest = TestFeeEstimator{fee_est: 15000};
5843 let secp_ctx = Secp256k1::new();
5844 let seed = [42; 32];
5845 let network = Network::Testnet;
5846 let chain_hash = genesis_block(network).header.block_hash();
5847 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5849 // Create a channel.
5850 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5851 let config = UserConfig::default();
5852 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5853 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5854 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5855 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5857 // Make sure that receiving a channel update will update the Channel as expected.
5858 let update = ChannelUpdate {
5859 contents: UnsignedChannelUpdate {
5861 short_channel_id: 0,
5864 cltv_expiry_delta: 100,
5865 htlc_minimum_msat: 5,
5866 htlc_maximum_msat: OptionalField::Absent,
5868 fee_proportional_millionths: 11,
5869 excess_data: Vec::new(),
5871 signature: Signature::from(unsafe { FFISignature::new() })
5873 node_a_chan.channel_update(&update).unwrap();
5875 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5876 // change our official htlc_minimum_msat.
5877 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5878 match node_a_chan.counterparty_forwarding_info() {
5880 assert_eq!(info.cltv_expiry_delta, 100);
5881 assert_eq!(info.fee_base_msat, 110);
5882 assert_eq!(info.fee_proportional_millionths, 11);
5884 None => panic!("expected counterparty forwarding info to be Some")
5889 fn outbound_commitment_test() {
5890 // Test vectors from BOLT 3 Appendix C:
5891 let feeest = TestFeeEstimator{fee_est: 15000};
5892 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5893 let secp_ctx = Secp256k1::new();
5895 let mut signer = InMemorySigner::new(
5897 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5898 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5899 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5900 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5901 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5903 // These aren't set in the test vectors:
5904 [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],
5909 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5910 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5911 let keys_provider = Keys { signer: signer.clone() };
5913 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5914 let mut config = UserConfig::default();
5915 config.channel_options.announced_channel = false;
5916 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, &InitFeatures::known(), 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5917 chan.holder_dust_limit_satoshis = 546;
5918 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5920 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5922 let counterparty_pubkeys = ChannelPublicKeys {
5923 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5924 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5925 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5926 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5927 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5929 chan.channel_transaction_parameters.counterparty_parameters = Some(
5930 CounterpartyChannelTransactionParameters {
5931 pubkeys: counterparty_pubkeys.clone(),
5932 selected_contest_delay: 144
5934 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5935 signer.ready_channel(&chan.channel_transaction_parameters);
5937 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5938 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5940 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5941 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5943 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5944 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5946 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5947 // derived from a commitment_seed, so instead we copy it here and call
5948 // build_commitment_transaction.
5949 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5950 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5951 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5952 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5953 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5955 macro_rules! test_commitment {
5956 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5957 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5959 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5960 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
5962 let htlcs = res.3.drain(..)
5963 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5967 let trusted_tx = commitment_tx.trust();
5968 let unsigned_tx = trusted_tx.built_transaction();
5969 let redeemscript = chan.get_funding_redeemscript();
5970 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5971 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5972 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5974 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5975 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5976 let mut counterparty_htlc_sigs = Vec::new();
5977 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5979 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5980 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5981 counterparty_htlc_sigs.push(remote_signature);
5983 assert_eq!(htlcs.len(), per_htlc.len());
5985 let holder_commitment_tx = HolderCommitmentTransaction::new(
5986 commitment_tx.clone(),
5987 counterparty_signature,
5988 counterparty_htlc_sigs,
5989 &chan.holder_signer.pubkeys().funding_pubkey,
5990 chan.counterparty_funding_pubkey()
5992 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5993 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5995 let funding_redeemscript = chan.get_funding_redeemscript();
5996 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5997 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5999 // ((htlc, counterparty_sig), (index, holder_sig))
6000 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
6003 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
6005 let ref htlc = htlcs[$htlc_idx];
6006 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
6007 chan.get_counterparty_selected_contest_delay().unwrap(),
6008 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
6009 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
6010 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
6011 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
6013 let mut preimage: Option<PaymentPreimage> = None;
6016 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
6017 if out == htlc.payment_hash {
6018 preimage = Some(PaymentPreimage([i; 32]));
6022 assert!(preimage.is_some());
6025 let htlc_sig = htlc_sig_iter.next().unwrap();
6026 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
6028 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
6029 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
6030 let index = (htlc_sig.1).0;
6031 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
6032 let trusted_tx = holder_commitment_tx.trust();
6033 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
6034 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
6036 assert!(htlc_sig_iter.next().is_none());
6040 // simple commitment tx with no HTLCs
6041 chan.value_to_self_msat = 7000000000;
6043 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
6044 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
6045 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6047 chan.pending_inbound_htlcs.push({
6048 let mut out = InboundHTLCOutput{
6050 amount_msat: 1000000,
6052 payment_hash: PaymentHash([0; 32]),
6053 state: InboundHTLCState::Committed,
6055 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
6058 chan.pending_inbound_htlcs.push({
6059 let mut out = InboundHTLCOutput{
6061 amount_msat: 2000000,
6063 payment_hash: PaymentHash([0; 32]),
6064 state: InboundHTLCState::Committed,
6066 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6069 chan.pending_outbound_htlcs.push({
6070 let mut out = OutboundHTLCOutput{
6072 amount_msat: 2000000,
6074 payment_hash: PaymentHash([0; 32]),
6075 state: OutboundHTLCState::Committed,
6076 source: HTLCSource::dummy(),
6078 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
6081 chan.pending_outbound_htlcs.push({
6082 let mut out = OutboundHTLCOutput{
6084 amount_msat: 3000000,
6086 payment_hash: PaymentHash([0; 32]),
6087 state: OutboundHTLCState::Committed,
6088 source: HTLCSource::dummy(),
6090 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
6093 chan.pending_inbound_htlcs.push({
6094 let mut out = InboundHTLCOutput{
6096 amount_msat: 4000000,
6098 payment_hash: PaymentHash([0; 32]),
6099 state: InboundHTLCState::Committed,
6101 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
6105 // commitment tx with all five HTLCs untrimmed (minimum feerate)
6106 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6107 chan.feerate_per_kw = 0;
6109 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
6110 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
6111 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6114 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
6115 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
6116 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6119 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
6120 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
6121 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6124 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
6125 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
6126 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6129 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
6130 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
6131 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6134 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
6135 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
6136 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6139 // commitment tx with seven outputs untrimmed (maximum feerate)
6140 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6141 chan.feerate_per_kw = 647;
6143 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
6144 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
6145 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6148 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
6149 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
6150 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6153 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
6154 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
6155 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6158 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
6159 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
6160 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6163 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
6164 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
6165 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6168 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
6169 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
6170 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6173 // commitment tx with six outputs untrimmed (minimum feerate)
6174 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6175 chan.feerate_per_kw = 648;
6177 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
6178 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
6179 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6182 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
6183 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
6184 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6187 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
6188 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
6189 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6192 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
6193 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
6194 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6197 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
6198 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
6199 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6202 // commitment tx with six outputs untrimmed (maximum feerate)
6203 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6204 chan.feerate_per_kw = 2069;
6206 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
6207 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
6208 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6211 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
6212 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
6213 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6216 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
6217 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
6218 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6221 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
6222 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
6223 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6226 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
6227 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
6228 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6231 // commitment tx with five outputs untrimmed (minimum feerate)
6232 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6233 chan.feerate_per_kw = 2070;
6235 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
6236 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
6237 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6240 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
6241 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
6242 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6245 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
6246 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
6247 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6250 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
6251 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
6252 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6255 // commitment tx with five outputs untrimmed (maximum feerate)
6256 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6257 chan.feerate_per_kw = 2194;
6259 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
6260 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
6261 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6264 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
6265 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
6266 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6269 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
6270 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
6271 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6274 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
6275 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
6276 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6279 // commitment tx with four outputs untrimmed (minimum feerate)
6280 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6281 chan.feerate_per_kw = 2195;
6283 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
6284 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
6285 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6288 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
6289 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
6290 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6293 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
6294 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
6295 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6298 // commitment tx with four outputs untrimmed (maximum feerate)
6299 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6300 chan.feerate_per_kw = 3702;
6302 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
6303 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
6304 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6307 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
6308 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
6309 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6312 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
6313 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
6314 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6317 // commitment tx with three outputs untrimmed (minimum feerate)
6318 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6319 chan.feerate_per_kw = 3703;
6321 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
6322 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
6323 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6326 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
6327 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
6328 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6331 // commitment tx with three outputs untrimmed (maximum feerate)
6332 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6333 chan.feerate_per_kw = 4914;
6335 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
6336 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
6337 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6340 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
6341 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
6342 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6345 // commitment tx with two outputs untrimmed (minimum feerate)
6346 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6347 chan.feerate_per_kw = 4915;
6349 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
6350 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
6351 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6353 // commitment tx with two outputs untrimmed (maximum feerate)
6354 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6355 chan.feerate_per_kw = 9651180;
6357 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
6358 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
6359 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6361 // commitment tx with one output untrimmed (minimum feerate)
6362 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6363 chan.feerate_per_kw = 9651181;
6365 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6366 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6367 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6369 // commitment tx with fee greater than funder amount
6370 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6371 chan.feerate_per_kw = 9651936;
6373 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6374 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6375 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6377 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
6378 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
6379 chan.feerate_per_kw = 253;
6380 chan.pending_inbound_htlcs.clear();
6381 chan.pending_inbound_htlcs.push({
6382 let mut out = InboundHTLCOutput{
6384 amount_msat: 2000000,
6386 payment_hash: PaymentHash([0; 32]),
6387 state: InboundHTLCState::Committed,
6389 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6392 chan.pending_outbound_htlcs.clear();
6393 chan.pending_outbound_htlcs.push({
6394 let mut out = OutboundHTLCOutput{
6396 amount_msat: 5000000,
6398 payment_hash: PaymentHash([0; 32]),
6399 state: OutboundHTLCState::Committed,
6400 source: HTLCSource::dummy(),
6402 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6405 chan.pending_outbound_htlcs.push({
6406 let mut out = OutboundHTLCOutput{
6408 amount_msat: 5000000,
6410 payment_hash: PaymentHash([0; 32]),
6411 state: OutboundHTLCState::Committed,
6412 source: HTLCSource::dummy(),
6414 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6418 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6419 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6420 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6423 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6424 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6425 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6427 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6428 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6429 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6431 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6432 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6433 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6438 fn test_per_commitment_secret_gen() {
6439 // Test vectors from BOLT 3 Appendix D:
6441 let mut seed = [0; 32];
6442 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6443 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6444 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6446 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6447 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6448 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6450 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6451 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6453 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6454 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6456 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6457 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6458 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6462 fn test_key_derivation() {
6463 // Test vectors from BOLT 3 Appendix E:
6464 let secp_ctx = Secp256k1::new();
6466 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6467 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6469 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6470 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6472 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6473 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6475 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6476 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6478 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6479 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6481 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6482 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6484 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6485 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());