1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{Transaction, SigHashType};
12 use bitcoin::util::bip143;
13 use bitcoin::consensus::encode;
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, InitFeatures};
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::ShutdownScript;
30 use ln::channelmanager::{CounterpartyForwardingInfo, PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor, ClosingTransaction};
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
39 use util::logger::Logger;
40 use util::errors::APIError;
41 use util::config::{UserConfig,ChannelConfig};
42 use util::scid_utils::scid_from_parts;
46 use core::{cmp,mem,fmt};
47 use core::convert::TryFrom;
49 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
51 use bitcoin::hashes::hex::ToHex;
54 pub struct ChannelValueStat {
55 pub value_to_self_msat: u64,
56 pub channel_value_msat: u64,
57 pub channel_reserve_msat: u64,
58 pub pending_outbound_htlcs_amount_msat: u64,
59 pub pending_inbound_htlcs_amount_msat: u64,
60 pub holding_cell_outbound_amount_msat: u64,
61 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
62 pub counterparty_dust_limit_msat: u64,
65 #[derive(Clone, Copy, PartialEq)]
67 // Inbound states mirroring InboundHTLCState
69 AwaitingRemoteRevokeToAnnounce,
70 // Note that we do not have a AwaitingAnnouncedRemoteRevoke variant here as it is universally
71 // handled the same as `Committed`, with the only exception in `InboundHTLCState` being the
72 // distinction of when we allow ourselves to forward the HTLC. Because we aren't "forwarding"
73 // the fee update anywhere, we can simply consider the fee update `Committed` immediately
74 // instead of setting it to AwaitingAnnouncedRemoteRevoke.
76 // Outbound state can only be `LocalAnnounced` or `Committed`
80 enum InboundHTLCRemovalReason {
81 FailRelay(msgs::OnionErrorPacket),
82 FailMalformed(([u8; 32], u16)),
83 Fulfill(PaymentPreimage),
86 enum InboundHTLCState {
87 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
88 /// update_add_htlc message for this HTLC.
89 RemoteAnnounced(PendingHTLCStatus),
90 /// Included in a received commitment_signed message (implying we've
91 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
92 /// state (see the example below). We have not yet included this HTLC in a
93 /// commitment_signed message because we are waiting on the remote's
94 /// aforementioned state revocation. One reason this missing remote RAA
95 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
96 /// is because every time we create a new "state", i.e. every time we sign a
97 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
98 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
99 /// sent provided the per_commitment_point for our current commitment tx.
100 /// The other reason we should not send a commitment_signed without their RAA
101 /// is because their RAA serves to ACK our previous commitment_signed.
103 /// Here's an example of how an HTLC could come to be in this state:
104 /// remote --> update_add_htlc(prev_htlc) --> local
105 /// remote --> commitment_signed(prev_htlc) --> local
106 /// remote <-- revoke_and_ack <-- local
107 /// remote <-- commitment_signed(prev_htlc) <-- local
108 /// [note that here, the remote does not respond with a RAA]
109 /// remote --> update_add_htlc(this_htlc) --> local
110 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
111 /// Now `this_htlc` will be assigned this state. It's unable to be officially
112 /// accepted, i.e. included in a commitment_signed, because we're missing the
113 /// RAA that provides our next per_commitment_point. The per_commitment_point
114 /// is used to derive commitment keys, which are used to construct the
115 /// signatures in a commitment_signed message.
116 /// Implies AwaitingRemoteRevoke.
118 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
119 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
120 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
121 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
122 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
123 /// channel (before it can then get forwarded and/or removed).
124 /// Implies AwaitingRemoteRevoke.
125 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
127 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
128 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
130 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
131 /// commitment transaction without it as otherwise we'll have to force-close the channel to
132 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
133 /// anyway). That said, ChannelMonitor does this for us (see
134 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
135 /// our own local state before then, once we're sure that the next commitment_signed and
136 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
137 LocalRemoved(InboundHTLCRemovalReason),
140 struct InboundHTLCOutput {
144 payment_hash: PaymentHash,
145 state: InboundHTLCState,
148 enum OutboundHTLCState {
149 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
150 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
151 /// we will promote to Committed (note that they may not accept it until the next time we
152 /// revoke, but we don't really care about that:
153 /// * they've revoked, so worst case we can announce an old state and get our (option on)
154 /// money back (though we won't), and,
155 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
156 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
157 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
158 /// we'll never get out of sync).
159 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
160 /// OutboundHTLCOutput's size just for a temporary bit
161 LocalAnnounced(Box<msgs::OnionPacket>),
163 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
164 /// the change (though they'll need to revoke before we fail the payment).
165 RemoteRemoved(Option<HTLCFailReason>),
166 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
167 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
168 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
169 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
170 /// remote revoke_and_ack on a previous state before we can do so.
171 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
172 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
173 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
174 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
175 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
176 /// revoke_and_ack to drop completely.
177 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
180 struct OutboundHTLCOutput {
184 payment_hash: PaymentHash,
185 state: OutboundHTLCState,
189 /// See AwaitingRemoteRevoke ChannelState for more info
190 enum HTLCUpdateAwaitingACK {
191 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
195 payment_hash: PaymentHash,
197 onion_routing_packet: msgs::OnionPacket,
200 payment_preimage: PaymentPreimage,
205 err_packet: msgs::OnionErrorPacket,
209 /// There are a few "states" and then a number of flags which can be applied:
210 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
211 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
212 /// move on to ChannelFunded.
213 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
214 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
215 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
217 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
218 OurInitSent = 1 << 0,
219 /// Implies we have received their open_channel/accept_channel message
220 TheirInitSent = 1 << 1,
221 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
222 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
223 /// upon receipt of funding_created, so simply skip this state.
225 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
226 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
227 /// and our counterparty consider the funding transaction confirmed.
229 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
230 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
231 TheirFundingLocked = 1 << 4,
232 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
233 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
234 OurFundingLocked = 1 << 5,
236 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
237 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
239 PeerDisconnected = 1 << 7,
240 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
241 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
242 /// outbound messages until they've managed to do so.
243 MonitorUpdateFailed = 1 << 8,
244 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
245 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
246 /// messages as then we will be unable to determine which HTLCs they included in their
247 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
249 /// Flag is set on ChannelFunded.
250 AwaitingRemoteRevoke = 1 << 9,
251 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
252 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
253 /// to respond with our own shutdown message when possible.
254 RemoteShutdownSent = 1 << 10,
255 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
256 /// point, we may not add any new HTLCs to the channel.
257 LocalShutdownSent = 1 << 11,
258 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
259 /// to drop us, but we store this anyway.
260 ShutdownComplete = 4096,
262 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
263 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
265 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
267 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
268 /// our counterparty or not. However, we don't want to announce updates right away to avoid
269 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
270 /// our channel_update message and track the current state here.
271 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
272 #[derive(Clone, Copy, PartialEq)]
273 pub(super) enum ChannelUpdateStatus {
274 /// We've announced the channel as enabled and are connected to our peer.
276 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
278 /// Our channel is live again, but we haven't announced the channel as enabled yet.
280 /// We've announced the channel as disabled.
284 /// An enum indicating whether the local or remote side offered a given HTLC.
290 /// An enum gathering stats on pending HTLCs, either inbound or outbound side.
293 pending_htlcs_value_msat: u64,
294 on_counterparty_tx_dust_exposure_msat: u64,
295 on_holder_tx_dust_exposure_msat: u64,
298 /// Used when calculating whether we or the remote can afford an additional HTLC.
299 struct HTLCCandidate {
301 origin: HTLCInitiator,
305 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
313 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
315 enum UpdateFulfillFetch {
317 monitor_update: ChannelMonitorUpdate,
318 htlc_value_msat: u64,
319 msg: Option<msgs::UpdateFulfillHTLC>,
324 /// The return type of get_update_fulfill_htlc_and_commit.
325 pub enum UpdateFulfillCommitFetch {
326 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
327 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
328 /// previously placed in the holding cell (and has since been removed).
330 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
331 monitor_update: ChannelMonitorUpdate,
332 /// The value of the HTLC which was claimed, in msat.
333 htlc_value_msat: u64,
334 /// The update_fulfill message and commitment_signed message (if the claim was not placed
335 /// in the holding cell).
336 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
338 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
339 /// or has been forgotten (presumably previously claimed).
343 /// If the majority of the channels funds are to the fundee and the initiator holds only just
344 /// enough funds to cover their reserve value, channels are at risk of getting "stuck". Because the
345 /// initiator controls the feerate, if they then go to increase the channel fee, they may have no
346 /// balance but the fundee is unable to send a payment as the increase in fee more than drains
347 /// their reserve value. Thus, neither side can send a new HTLC and the channel becomes useless.
348 /// Thus, before sending an HTLC when we are the initiator, we check that the feerate can increase
349 /// by this multiple without hitting this case, before sending.
350 /// This multiple is effectively the maximum feerate "jump" we expect until more HTLCs flow over
351 /// the channel. Sadly, there isn't really a good number for this - if we expect to have no new
352 /// HTLCs for days we may need this to suffice for feerate increases across days, but that may
353 /// leave the channel less usable as we hold a bigger reserve.
355 pub const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
357 const FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE: u64 = 2;
359 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
360 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
361 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
364 // Holder designates channel data owned for the benefice of the user client.
365 // Counterparty designates channel data owned by the another channel participant entity.
366 pub(super) struct Channel<Signer: Sign> {
367 #[cfg(any(test, feature = "_test_utils"))]
368 pub(crate) config: ChannelConfig,
369 #[cfg(not(any(test, feature = "_test_utils")))]
370 config: ChannelConfig,
374 channel_id: [u8; 32],
376 secp_ctx: Secp256k1<secp256k1::All>,
377 channel_value_satoshis: u64,
379 latest_monitor_update_id: u64,
381 holder_signer: Signer,
382 shutdown_scriptpubkey: Option<ShutdownScript>,
383 destination_script: Script,
385 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
386 // generation start at 0 and count up...this simplifies some parts of implementation at the
387 // cost of others, but should really just be changed.
389 cur_holder_commitment_transaction_number: u64,
390 cur_counterparty_commitment_transaction_number: u64,
391 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
392 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
393 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
394 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
396 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
397 /// need to ensure we resend them in the order we originally generated them. Note that because
398 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
399 /// sufficient to simply set this to the opposite of any message we are generating as we
400 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
401 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
403 resend_order: RAACommitmentOrder,
405 monitor_pending_funding_locked: bool,
406 monitor_pending_revoke_and_ack: bool,
407 monitor_pending_commitment_signed: bool,
408 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
409 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
411 // pending_update_fee is filled when sending and receiving update_fee.
413 // Because it follows the same commitment flow as HTLCs, `FeeUpdateState` is either `Outbound`
414 // or matches a subset of the `InboundHTLCOutput` variants. It is then updated/used when
415 // generating new commitment transactions with exactly the same criteria as inbound/outbound
416 // HTLCs with similar state.
417 pending_update_fee: Option<(u32, FeeUpdateState)>,
418 // If a `send_update_fee()` call is made with ChannelState::AwaitingRemoteRevoke set, we place
419 // it here instead of `pending_update_fee` in the same way as we place outbound HTLC updates in
420 // `holding_cell_htlc_updates` instead of `pending_outbound_htlcs`. It is released into
421 // `pending_update_fee` with the same criteria as outbound HTLC updates but can be updated by
422 // further `send_update_fee` calls, dropping the previous holding cell update entirely.
423 holding_cell_update_fee: Option<u32>,
424 next_holder_htlc_id: u64,
425 next_counterparty_htlc_id: u64,
426 update_time_counter: u32,
429 #[cfg(debug_assertions)]
430 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
431 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
432 #[cfg(debug_assertions)]
433 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
434 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
436 last_sent_closing_fee: Option<(u64, Signature)>, // (fee, holder_sig)
437 target_closing_feerate_sats_per_kw: Option<u32>,
439 /// If our counterparty sent us a closing_signed while we were waiting for a `ChannelMonitor`
440 /// update, we need to delay processing it until later. We do that here by simply storing the
441 /// closing_signed message and handling it in `maybe_propose_closing_signed`.
442 pending_counterparty_closing_signed: Option<msgs::ClosingSigned>,
444 /// The minimum and maximum absolute fee, in satoshis, we are willing to place on the closing
445 /// transaction. These are set once we reach `closing_negotiation_ready`.
447 pub(crate) closing_fee_limits: Option<(u64, u64)>,
449 closing_fee_limits: Option<(u64, u64)>,
451 /// The hash of the block in which the funding transaction was included.
452 funding_tx_confirmed_in: Option<BlockHash>,
453 funding_tx_confirmation_height: u32,
454 short_channel_id: Option<u64>,
456 counterparty_dust_limit_satoshis: u64,
458 pub(super) holder_dust_limit_satoshis: u64,
460 holder_dust_limit_satoshis: u64,
462 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
464 counterparty_max_htlc_value_in_flight_msat: u64,
465 //get_holder_max_htlc_value_in_flight_msat(): u64,
466 /// minimum channel reserve for self to maintain - set by them.
467 counterparty_selected_channel_reserve_satoshis: Option<u64>,
468 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
469 counterparty_htlc_minimum_msat: u64,
470 holder_htlc_minimum_msat: u64,
472 pub counterparty_max_accepted_htlcs: u16,
474 counterparty_max_accepted_htlcs: u16,
475 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
476 minimum_depth: Option<u32>,
478 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
480 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
481 funding_transaction: Option<Transaction>,
483 counterparty_cur_commitment_point: Option<PublicKey>,
484 counterparty_prev_commitment_point: Option<PublicKey>,
485 counterparty_node_id: PublicKey,
487 counterparty_shutdown_scriptpubkey: Option<Script>,
489 commitment_secrets: CounterpartyCommitmentSecrets,
491 channel_update_status: ChannelUpdateStatus,
492 /// Once we reach `closing_negotiation_ready`, we set this, indicating if closing_signed does
493 /// not complete within a single timer tick (one minute), we should force-close the channel.
494 /// This prevents us from keeping unusable channels around forever if our counterparty wishes
496 /// Note that this field is reset to false on deserialization to give us a chance to connect to
497 /// our peer and start the closing_signed negotiation fresh.
498 closing_signed_in_flight: bool,
500 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
501 /// This can be used to rebroadcast the channel_announcement message later.
502 announcement_sigs: Option<(Signature, Signature)>,
504 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
505 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
506 // be, by comparing the cached values to the fee of the tranaction generated by
507 // `build_commitment_transaction`.
508 #[cfg(any(test, feature = "fuzztarget"))]
509 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
510 #[cfg(any(test, feature = "fuzztarget"))]
511 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
513 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
514 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
515 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
516 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
517 /// message until we receive a channel_reestablish.
519 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
520 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
522 #[cfg(any(test, feature = "fuzztarget"))]
523 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
524 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
525 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
526 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
527 // is fine, but as a sanity check in our failure to generate the second claim, we check here
528 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
529 historical_inbound_htlc_fulfills: HashSet<u64>,
532 #[cfg(any(test, feature = "fuzztarget"))]
533 struct CommitmentTxInfoCached {
535 total_pending_htlcs: usize,
536 next_holder_htlc_id: u64,
537 next_counterparty_htlc_id: u64,
541 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
544 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
546 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
548 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
550 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
552 pub const ANCHOR_OUTPUT_VALUE_SATOSHI: u64 = 330;
554 /// Maximum `funding_satoshis` value, according to the BOLT #2 specification
556 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
558 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
559 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
560 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
561 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
562 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
563 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
564 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
565 /// upper bound to avoid negotiation conflicts with other implementations.
566 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
568 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
569 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
570 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
571 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
572 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
574 /// Used to return a simple Error back to ChannelManager. Will get converted to a
575 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
576 /// channel_id in ChannelManager.
577 pub(super) enum ChannelError {
581 CloseDelayBroadcast(String),
584 impl fmt::Debug for ChannelError {
585 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
587 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
588 &ChannelError::Warn(ref e) => write!(f, "Warn : {}", e),
589 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
590 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
595 macro_rules! secp_check {
596 ($res: expr, $err: expr) => {
599 Err(_) => return Err(ChannelError::Close($err)),
604 impl<Signer: Sign> Channel<Signer> {
605 // Convert constants + channel value to limits:
606 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
607 channel_value_satoshis * 1000 / 10 //TODO
610 /// Returns a minimum channel reserve value the remote needs to maintain,
613 /// Guaranteed to return a value no larger than channel_value_satoshis
614 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
615 let (q, _) = channel_value_satoshis.overflowing_div(100);
616 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
620 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>
621 where K::Target: KeysInterface<Signer = Signer>,
622 F::Target: FeeEstimator,
624 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
625 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
626 let pubkeys = holder_signer.pubkeys().clone();
628 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
629 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
631 let channel_value_msat = channel_value_satoshis * 1000;
632 if push_msat > channel_value_msat {
633 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
635 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
636 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
638 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
639 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
640 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
643 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
645 let mut secp_ctx = Secp256k1::new();
646 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
648 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
649 Some(keys_provider.get_shutdown_scriptpubkey())
652 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
653 if !shutdown_scriptpubkey.is_compatible(&their_features) {
654 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
660 config: config.channel_options.clone(),
662 channel_id: keys_provider.get_secure_random_bytes(),
663 channel_state: ChannelState::OurInitSent as u32,
665 channel_value_satoshis,
667 latest_monitor_update_id: 0,
670 shutdown_scriptpubkey,
671 destination_script: keys_provider.get_destination_script(),
673 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
674 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
675 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
677 pending_inbound_htlcs: Vec::new(),
678 pending_outbound_htlcs: Vec::new(),
679 holding_cell_htlc_updates: Vec::new(),
680 pending_update_fee: None,
681 holding_cell_update_fee: None,
682 next_holder_htlc_id: 0,
683 next_counterparty_htlc_id: 0,
684 update_time_counter: 1,
686 resend_order: RAACommitmentOrder::CommitmentFirst,
688 monitor_pending_funding_locked: false,
689 monitor_pending_revoke_and_ack: false,
690 monitor_pending_commitment_signed: false,
691 monitor_pending_forwards: Vec::new(),
692 monitor_pending_failures: Vec::new(),
694 #[cfg(debug_assertions)]
695 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
696 #[cfg(debug_assertions)]
697 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
699 last_sent_closing_fee: None,
700 pending_counterparty_closing_signed: None,
701 closing_fee_limits: None,
702 target_closing_feerate_sats_per_kw: None,
704 funding_tx_confirmed_in: None,
705 funding_tx_confirmation_height: 0,
706 short_channel_id: None,
708 feerate_per_kw: feerate,
709 counterparty_dust_limit_satoshis: 0,
710 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
711 counterparty_max_htlc_value_in_flight_msat: 0,
712 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
713 counterparty_htlc_minimum_msat: 0,
714 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
715 counterparty_max_accepted_htlcs: 0,
716 minimum_depth: None, // Filled in in accept_channel
718 counterparty_forwarding_info: None,
720 channel_transaction_parameters: ChannelTransactionParameters {
721 holder_pubkeys: pubkeys,
722 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
723 is_outbound_from_holder: true,
724 counterparty_parameters: None,
725 funding_outpoint: None
727 funding_transaction: None,
729 counterparty_cur_commitment_point: None,
730 counterparty_prev_commitment_point: None,
731 counterparty_node_id,
733 counterparty_shutdown_scriptpubkey: None,
735 commitment_secrets: CounterpartyCommitmentSecrets::new(),
737 channel_update_status: ChannelUpdateStatus::Enabled,
738 closing_signed_in_flight: false,
740 announcement_sigs: None,
742 #[cfg(any(test, feature = "fuzztarget"))]
743 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
744 #[cfg(any(test, feature = "fuzztarget"))]
745 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
747 workaround_lnd_bug_4006: None,
749 #[cfg(any(test, feature = "fuzztarget"))]
750 historical_inbound_htlc_fulfills: HashSet::new(),
754 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
755 where F::Target: FeeEstimator
757 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
758 if feerate_per_kw < lower_limit {
759 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
761 // We only bound the fee updates on the upper side to prevent completely absurd feerates,
762 // always accepting up to 25 sat/vByte or 10x our fee estimator's "High Priority" fee.
763 // We generally don't care too much if they set the feerate to something very high, but it
764 // could result in the channel being useless due to everything being dust.
765 let upper_limit = cmp::max(250 * 25,
766 fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 10);
767 if feerate_per_kw as u64 > upper_limit {
768 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
773 /// Creates a new channel from a remote sides' request for one.
774 /// Assumes chain_hash has already been checked and corresponds with what we expect!
775 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>
776 where K::Target: KeysInterface<Signer = Signer>,
777 F::Target: FeeEstimator
779 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
780 let pubkeys = holder_signer.pubkeys().clone();
781 let counterparty_pubkeys = ChannelPublicKeys {
782 funding_pubkey: msg.funding_pubkey,
783 revocation_basepoint: msg.revocation_basepoint,
784 payment_point: msg.payment_point,
785 delayed_payment_basepoint: msg.delayed_payment_basepoint,
786 htlc_basepoint: msg.htlc_basepoint
788 let mut local_config = (*config).channel_options.clone();
790 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
791 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)));
794 // Check sanity of message fields:
795 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
796 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
798 if msg.channel_reserve_satoshis > msg.funding_satoshis {
799 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
801 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
802 if msg.push_msat > funding_value {
803 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
805 if msg.dust_limit_satoshis > msg.funding_satoshis {
806 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)));
808 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
809 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
811 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
812 if msg.htlc_minimum_msat >= full_channel_value_msat {
813 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
815 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
817 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
818 if msg.to_self_delay > max_counterparty_selected_contest_delay {
819 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)));
821 if msg.max_accepted_htlcs < 1 {
822 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
824 if msg.max_accepted_htlcs > MAX_HTLCS {
825 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
828 // Now check against optional parameters as set by config...
829 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
830 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)));
832 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
833 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)));
835 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
836 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)));
838 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
839 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)));
841 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
842 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)));
844 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
845 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
847 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
848 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
851 // Convert things into internal flags and prep our state:
853 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
854 if config.peer_channel_config_limits.force_announced_channel_preference {
855 if local_config.announced_channel != announce {
856 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
859 // we either accept their preference or the preferences match
860 local_config.announced_channel = announce;
862 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
864 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
865 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
866 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)));
868 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
869 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
871 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
872 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)));
875 // check if the funder's amount for the initial commitment tx is sufficient
876 // for full fee payment
877 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
878 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
879 if funders_amount_msat < lower_limit {
880 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
883 let to_local_msat = msg.push_msat;
884 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
885 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
886 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
889 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
890 match &msg.shutdown_scriptpubkey {
891 &OptionalField::Present(ref script) => {
892 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
893 if script.len() == 0 {
896 match ShutdownScript::try_from((script.clone(), their_features)) {
897 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
898 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
902 // 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
903 &OptionalField::Absent => {
904 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()));
909 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
910 Some(keys_provider.get_shutdown_scriptpubkey())
913 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
914 if !shutdown_scriptpubkey.is_compatible(&their_features) {
915 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
919 let mut secp_ctx = Secp256k1::new();
920 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
924 config: local_config,
926 channel_id: msg.temporary_channel_id,
927 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
930 latest_monitor_update_id: 0,
933 shutdown_scriptpubkey,
934 destination_script: keys_provider.get_destination_script(),
936 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
937 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
938 value_to_self_msat: msg.push_msat,
940 pending_inbound_htlcs: Vec::new(),
941 pending_outbound_htlcs: Vec::new(),
942 holding_cell_htlc_updates: Vec::new(),
943 pending_update_fee: None,
944 holding_cell_update_fee: None,
945 next_holder_htlc_id: 0,
946 next_counterparty_htlc_id: 0,
947 update_time_counter: 1,
949 resend_order: RAACommitmentOrder::CommitmentFirst,
951 monitor_pending_funding_locked: false,
952 monitor_pending_revoke_and_ack: false,
953 monitor_pending_commitment_signed: false,
954 monitor_pending_forwards: Vec::new(),
955 monitor_pending_failures: Vec::new(),
957 #[cfg(debug_assertions)]
958 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
959 #[cfg(debug_assertions)]
960 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
962 last_sent_closing_fee: None,
963 pending_counterparty_closing_signed: None,
964 closing_fee_limits: None,
965 target_closing_feerate_sats_per_kw: None,
967 funding_tx_confirmed_in: None,
968 funding_tx_confirmation_height: 0,
969 short_channel_id: None,
971 feerate_per_kw: msg.feerate_per_kw,
972 channel_value_satoshis: msg.funding_satoshis,
973 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
974 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
975 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
976 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
977 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
978 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
979 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
980 minimum_depth: Some(config.own_channel_config.minimum_depth),
982 counterparty_forwarding_info: None,
984 channel_transaction_parameters: ChannelTransactionParameters {
985 holder_pubkeys: pubkeys,
986 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
987 is_outbound_from_holder: false,
988 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
989 selected_contest_delay: msg.to_self_delay,
990 pubkeys: counterparty_pubkeys,
992 funding_outpoint: None
994 funding_transaction: None,
996 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
997 counterparty_prev_commitment_point: None,
998 counterparty_node_id,
1000 counterparty_shutdown_scriptpubkey,
1002 commitment_secrets: CounterpartyCommitmentSecrets::new(),
1004 channel_update_status: ChannelUpdateStatus::Enabled,
1005 closing_signed_in_flight: false,
1007 announcement_sigs: None,
1009 #[cfg(any(test, feature = "fuzztarget"))]
1010 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
1011 #[cfg(any(test, feature = "fuzztarget"))]
1012 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
1014 workaround_lnd_bug_4006: None,
1016 #[cfg(any(test, feature = "fuzztarget"))]
1017 historical_inbound_htlc_fulfills: HashSet::new(),
1023 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
1024 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
1025 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
1026 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
1027 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
1029 /// @local is used only to convert relevant internal structures which refer to remote vs local
1030 /// to decide value of outputs and direction of HTLCs.
1031 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
1032 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
1033 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
1034 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
1035 /// which peer generated this transaction and "to whom" this transaction flows.
1036 /// Returns (the transaction info, the number of HTLC outputs which were present in the
1037 /// transaction, the list of HTLCs which were not ignored when building the transaction).
1038 /// Note that below-dust HTLCs are included in the fourth return value, but not the third, and
1039 /// sources are provided only for outbound HTLCs in the fourth return value.
1041 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 {
1042 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
1043 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1044 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
1046 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
1047 let mut remote_htlc_total_msat = 0;
1048 let mut local_htlc_total_msat = 0;
1049 let mut value_to_self_msat_offset = 0;
1051 let mut feerate_per_kw = self.feerate_per_kw;
1052 if let Some((feerate, update_state)) = self.pending_update_fee {
1053 if match update_state {
1054 // Note that these match the inclusion criteria when scanning
1055 // pending_inbound_htlcs below.
1056 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); !generated_by_local },
1057 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => { debug_assert!(!self.is_outbound()); !generated_by_local },
1058 FeeUpdateState::Outbound => { assert!(self.is_outbound()); generated_by_local },
1060 feerate_per_kw = feerate;
1064 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
1065 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
1066 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
1067 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
1069 macro_rules! get_htlc_in_commitment {
1070 ($htlc: expr, $offered: expr) => {
1071 HTLCOutputInCommitment {
1073 amount_msat: $htlc.amount_msat,
1074 cltv_expiry: $htlc.cltv_expiry,
1075 payment_hash: $htlc.payment_hash,
1076 transaction_output_index: None
1081 macro_rules! add_htlc_output {
1082 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1083 if $outbound == local { // "offered HTLC output"
1084 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1085 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1086 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);
1087 included_non_dust_htlcs.push((htlc_in_tx, $source));
1089 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);
1090 included_dust_htlcs.push((htlc_in_tx, $source));
1093 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1094 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1095 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);
1096 included_non_dust_htlcs.push((htlc_in_tx, $source));
1098 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);
1099 included_dust_htlcs.push((htlc_in_tx, $source));
1105 for ref htlc in self.pending_inbound_htlcs.iter() {
1106 let (include, state_name) = match htlc.state {
1107 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1108 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1109 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1110 InboundHTLCState::Committed => (true, "Committed"),
1111 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1115 add_htlc_output!(htlc, false, None, state_name);
1116 remote_htlc_total_msat += htlc.amount_msat;
1118 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);
1120 &InboundHTLCState::LocalRemoved(ref reason) => {
1121 if generated_by_local {
1122 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1123 value_to_self_msat_offset += htlc.amount_msat as i64;
1132 for ref htlc in self.pending_outbound_htlcs.iter() {
1133 let (include, state_name) = match htlc.state {
1134 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1135 OutboundHTLCState::Committed => (true, "Committed"),
1136 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1137 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1138 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1142 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1143 local_htlc_total_msat += htlc.amount_msat;
1145 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);
1147 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1148 value_to_self_msat_offset -= htlc.amount_msat as i64;
1150 OutboundHTLCState::RemoteRemoved(None) => {
1151 if !generated_by_local {
1152 value_to_self_msat_offset -= htlc.amount_msat as i64;
1160 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1161 assert!(value_to_self_msat >= 0);
1162 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1163 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1164 // "violate" their reserve value by couting those against it. Thus, we have to convert
1165 // everything to i64 before subtracting as otherwise we can overflow.
1166 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;
1167 assert!(value_to_remote_msat >= 0);
1169 #[cfg(debug_assertions)]
1171 // Make sure that the to_self/to_remote is always either past the appropriate
1172 // channel_reserve *or* it is making progress towards it.
1173 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1174 self.holder_max_commitment_tx_output.lock().unwrap()
1176 self.counterparty_max_commitment_tx_output.lock().unwrap()
1178 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);
1179 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1180 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);
1181 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1184 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;
1185 let (value_to_self, value_to_remote) = if self.is_outbound() {
1186 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1188 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1191 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1192 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1193 let (funding_pubkey_a, funding_pubkey_b) = if local {
1194 (self.get_holder_pubkeys().funding_pubkey, self.get_counterparty_pubkeys().funding_pubkey)
1196 (self.get_counterparty_pubkeys().funding_pubkey, self.get_holder_pubkeys().funding_pubkey)
1199 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1200 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1205 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1206 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1211 let num_nondust_htlcs = included_non_dust_htlcs.len();
1213 let channel_parameters =
1214 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1215 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1216 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1224 &mut included_non_dust_htlcs,
1227 let mut htlcs_included = included_non_dust_htlcs;
1228 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1229 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1230 htlcs_included.append(&mut included_dust_htlcs);
1232 (tx, feerate_per_kw, num_nondust_htlcs, htlcs_included)
1236 fn get_closing_scriptpubkey(&self) -> Script {
1237 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1238 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1239 // outside of those situations will fail.
1240 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1244 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1249 1 + // script length (0)
1253 )*4 + // * 4 for non-witness parts
1254 2 + // witness marker and flag
1255 1 + // witness element count
1256 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1257 self.get_funding_redeemscript().len() as u64 + // funding witness script
1258 2*(1 + 71); // two signatures + sighash type flags
1259 if let Some(spk) = a_scriptpubkey {
1260 ret += ((8+1) + // output values and script length
1261 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1263 if let Some(spk) = b_scriptpubkey {
1264 ret += ((8+1) + // output values and script length
1265 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1271 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (ClosingTransaction, u64) {
1272 assert!(self.pending_inbound_htlcs.is_empty());
1273 assert!(self.pending_outbound_htlcs.is_empty());
1274 assert!(self.pending_update_fee.is_none());
1276 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1277 let mut value_to_holder: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1278 let mut value_to_counterparty: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1280 if value_to_holder < 0 {
1281 assert!(self.is_outbound());
1282 total_fee_satoshis += (-value_to_holder) as u64;
1283 } else if value_to_counterparty < 0 {
1284 assert!(!self.is_outbound());
1285 total_fee_satoshis += (-value_to_counterparty) as u64;
1288 if skip_remote_output || value_to_counterparty as u64 <= self.holder_dust_limit_satoshis {
1289 value_to_counterparty = 0;
1292 if value_to_holder as u64 <= self.holder_dust_limit_satoshis {
1293 value_to_holder = 0;
1296 assert!(self.shutdown_scriptpubkey.is_some());
1297 let holder_shutdown_script = self.get_closing_scriptpubkey();
1298 let counterparty_shutdown_script = self.counterparty_shutdown_scriptpubkey.clone().unwrap();
1299 let funding_outpoint = self.funding_outpoint().into_bitcoin_outpoint();
1301 let closing_transaction = ClosingTransaction::new(value_to_holder as u64, value_to_counterparty as u64, holder_shutdown_script, counterparty_shutdown_script, funding_outpoint);
1302 (closing_transaction, total_fee_satoshis)
1305 fn funding_outpoint(&self) -> OutPoint {
1306 self.channel_transaction_parameters.funding_outpoint.unwrap()
1310 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1311 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1312 /// our counterparty!)
1313 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1314 /// TODO Some magic rust shit to compile-time check this?
1315 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1316 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1317 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1318 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1319 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1321 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()))
1325 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1326 /// will sign and send to our counterparty.
1327 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1328 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1329 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1330 //may see payments to it!
1331 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1332 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1333 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1335 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()))
1338 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1339 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1340 /// Panics if called before accept_channel/new_from_req
1341 pub fn get_funding_redeemscript(&self) -> Script {
1342 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1345 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1346 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1347 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1348 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1350 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1351 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1353 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1355 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1357 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1358 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1359 // these, but for now we just have to treat them as normal.
1361 let mut pending_idx = core::usize::MAX;
1362 let mut htlc_value_msat = 0;
1363 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1364 if htlc.htlc_id == htlc_id_arg {
1365 assert_eq!(htlc.payment_hash, payment_hash_calc);
1367 InboundHTLCState::Committed => {},
1368 InboundHTLCState::LocalRemoved(ref reason) => {
1369 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1371 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()));
1372 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1374 return UpdateFulfillFetch::DuplicateClaim {};
1377 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1378 // Don't return in release mode here so that we can update channel_monitor
1382 htlc_value_msat = htlc.amount_msat;
1386 if pending_idx == core::usize::MAX {
1387 #[cfg(any(test, feature = "fuzztarget"))]
1388 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1389 // this is simply a duplicate claim, not previously failed and we lost funds.
1390 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1391 return UpdateFulfillFetch::DuplicateClaim {};
1394 // Now update local state:
1396 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1397 // can claim it even if the channel hits the chain before we see their next commitment.
1398 self.latest_monitor_update_id += 1;
1399 let monitor_update = ChannelMonitorUpdate {
1400 update_id: self.latest_monitor_update_id,
1401 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1402 payment_preimage: payment_preimage_arg.clone(),
1406 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1407 for pending_update in self.holding_cell_htlc_updates.iter() {
1408 match pending_update {
1409 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1410 if htlc_id_arg == htlc_id {
1411 // Make sure we don't leave latest_monitor_update_id incremented here:
1412 self.latest_monitor_update_id -= 1;
1413 #[cfg(any(test, feature = "fuzztarget"))]
1414 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1415 return UpdateFulfillFetch::DuplicateClaim {};
1418 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1419 if htlc_id_arg == htlc_id {
1420 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1421 // TODO: We may actually be able to switch to a fulfill here, though its
1422 // rare enough it may not be worth the complexity burden.
1423 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1424 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1430 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1431 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1432 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1434 #[cfg(any(test, feature = "fuzztarget"))]
1435 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1436 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1438 #[cfg(any(test, feature = "fuzztarget"))]
1439 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1442 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1443 if let InboundHTLCState::Committed = htlc.state {
1445 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1446 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1448 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1449 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1452 UpdateFulfillFetch::NewClaim {
1455 msg: Some(msgs::UpdateFulfillHTLC {
1456 channel_id: self.channel_id(),
1457 htlc_id: htlc_id_arg,
1458 payment_preimage: payment_preimage_arg,
1463 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 {
1464 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1465 UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1466 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1467 Err(e) => return Err((e, monitor_update)),
1470 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1471 // strictly increasing by one, so decrement it here.
1472 self.latest_monitor_update_id = monitor_update.update_id;
1473 monitor_update.updates.append(&mut additional_update.updates);
1474 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1476 UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1477 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1478 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1482 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1483 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1484 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1485 /// before we fail backwards.
1486 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1487 /// Ok(_) if debug assertions are turned on or preconditions are met.
1488 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 {
1489 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1490 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1492 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1494 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1495 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1496 // these, but for now we just have to treat them as normal.
1498 let mut pending_idx = core::usize::MAX;
1499 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1500 if htlc.htlc_id == htlc_id_arg {
1502 InboundHTLCState::Committed => {},
1503 InboundHTLCState::LocalRemoved(ref reason) => {
1504 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1506 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1511 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1512 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1518 if pending_idx == core::usize::MAX {
1519 #[cfg(any(test, feature = "fuzztarget"))]
1520 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1521 // is simply a duplicate fail, not previously failed and we failed-back too early.
1522 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1526 // Now update local state:
1527 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1528 for pending_update in self.holding_cell_htlc_updates.iter() {
1529 match pending_update {
1530 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1531 if htlc_id_arg == htlc_id {
1532 #[cfg(any(test, feature = "fuzztarget"))]
1533 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1537 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1538 if htlc_id_arg == htlc_id {
1539 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1540 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1546 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1547 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1548 htlc_id: htlc_id_arg,
1554 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1556 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1557 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1560 Ok(Some(msgs::UpdateFailHTLC {
1561 channel_id: self.channel_id(),
1562 htlc_id: htlc_id_arg,
1567 // Message handlers:
1569 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: &InitFeatures) -> Result<(), ChannelError> {
1570 // Check sanity of message fields:
1571 if !self.is_outbound() {
1572 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1574 if self.channel_state != ChannelState::OurInitSent as u32 {
1575 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1577 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1578 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1580 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1581 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1583 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1584 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)));
1586 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1587 if msg.dust_limit_satoshis > remote_reserve {
1588 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1590 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1591 if msg.htlc_minimum_msat >= full_channel_value_msat {
1592 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1594 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1595 if msg.to_self_delay > max_delay_acceptable {
1596 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)));
1598 if msg.max_accepted_htlcs < 1 {
1599 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1601 if msg.max_accepted_htlcs > MAX_HTLCS {
1602 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1605 // Now check against optional parameters as set by config...
1606 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1607 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)));
1609 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1610 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)));
1612 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1613 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)));
1615 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1616 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)));
1618 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1619 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1621 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1622 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1624 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1625 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)));
1627 if msg.minimum_depth == 0 {
1628 // Note that if this changes we should update the serialization minimum version to
1629 // indicate to older clients that they don't understand some features of the current
1631 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1634 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1635 match &msg.shutdown_scriptpubkey {
1636 &OptionalField::Present(ref script) => {
1637 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1638 if script.len() == 0 {
1641 match ShutdownScript::try_from((script.clone(), their_features)) {
1642 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
1643 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format: {}", script))),
1647 // 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
1648 &OptionalField::Absent => {
1649 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()));
1654 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1655 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1656 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1657 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1658 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1659 self.minimum_depth = Some(msg.minimum_depth);
1661 let counterparty_pubkeys = ChannelPublicKeys {
1662 funding_pubkey: msg.funding_pubkey,
1663 revocation_basepoint: msg.revocation_basepoint,
1664 payment_point: msg.payment_point,
1665 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1666 htlc_basepoint: msg.htlc_basepoint
1669 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1670 selected_contest_delay: msg.to_self_delay,
1671 pubkeys: counterparty_pubkeys,
1674 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1675 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1677 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1682 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1683 let funding_script = self.get_funding_redeemscript();
1685 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1686 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger).0;
1688 let trusted_tx = initial_commitment_tx.trust();
1689 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1690 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1691 // They sign the holder commitment transaction...
1692 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1693 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1694 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1695 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1696 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1699 let counterparty_keys = self.build_remote_transaction_keys()?;
1700 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1702 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1703 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1704 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1705 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1707 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1708 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1710 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1711 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1714 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1715 &self.get_counterparty_pubkeys().funding_pubkey
1718 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 {
1719 if self.is_outbound() {
1720 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1722 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1723 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1724 // remember the channel, so it's safe to just send an error_message here and drop the
1726 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1728 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1729 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1730 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1731 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1734 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1735 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1736 // This is an externally observable change before we finish all our checks. In particular
1737 // funding_created_signature may fail.
1738 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1740 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1742 Err(ChannelError::Close(e)) => {
1743 self.channel_transaction_parameters.funding_outpoint = None;
1744 return Err(ChannelError::Close(e));
1747 // The only error we know how to handle is ChannelError::Close, so we fall over here
1748 // to make sure we don't continue with an inconsistent state.
1749 panic!("unexpected error type from funding_created_signature {:?}", e);
1753 let holder_commitment_tx = HolderCommitmentTransaction::new(
1754 initial_commitment_tx,
1757 &self.get_holder_pubkeys().funding_pubkey,
1758 self.counterparty_funding_pubkey()
1761 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1762 .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1764 // Now that we're past error-generating stuff, update our local state:
1766 let funding_redeemscript = self.get_funding_redeemscript();
1767 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1768 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1769 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1770 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1771 shutdown_script, self.get_holder_selected_contest_delay(),
1772 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1773 &self.channel_transaction_parameters,
1774 funding_redeemscript.clone(), self.channel_value_satoshis,
1776 holder_commitment_tx, best_block);
1778 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);
1780 self.channel_state = ChannelState::FundingSent as u32;
1781 self.channel_id = funding_txo.to_channel_id();
1782 self.cur_counterparty_commitment_transaction_number -= 1;
1783 self.cur_holder_commitment_transaction_number -= 1;
1785 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1787 Ok((msgs::FundingSigned {
1788 channel_id: self.channel_id,
1790 }, channel_monitor))
1793 /// Handles a funding_signed message from the remote end.
1794 /// If this call is successful, broadcast the funding transaction (and not before!)
1795 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 {
1796 if !self.is_outbound() {
1797 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1799 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1800 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1802 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1803 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1804 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1805 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1808 let funding_script = self.get_funding_redeemscript();
1810 let counterparty_keys = self.build_remote_transaction_keys()?;
1811 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
1812 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1813 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1815 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1816 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1818 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1819 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, logger).0;
1821 let trusted_tx = initial_commitment_tx.trust();
1822 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1823 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1824 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1825 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1826 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1830 let holder_commitment_tx = HolderCommitmentTransaction::new(
1831 initial_commitment_tx,
1834 &self.get_holder_pubkeys().funding_pubkey,
1835 self.counterparty_funding_pubkey()
1838 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
1839 .map_err(|_| ChannelError::Close("Failed to validate our commitment".to_owned()))?;
1842 let funding_redeemscript = self.get_funding_redeemscript();
1843 let funding_txo = self.get_funding_txo().unwrap();
1844 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1845 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1846 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1847 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1848 shutdown_script, self.get_holder_selected_contest_delay(),
1849 &self.destination_script, (funding_txo, funding_txo_script),
1850 &self.channel_transaction_parameters,
1851 funding_redeemscript.clone(), self.channel_value_satoshis,
1853 holder_commitment_tx, best_block);
1855 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);
1857 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1858 self.channel_state = ChannelState::FundingSent as u32;
1859 self.cur_holder_commitment_transaction_number -= 1;
1860 self.cur_counterparty_commitment_transaction_number -= 1;
1862 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1864 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1867 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1868 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1869 self.workaround_lnd_bug_4006 = Some(msg.clone());
1870 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()));
1873 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1875 if non_shutdown_state == ChannelState::FundingSent as u32 {
1876 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1877 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1878 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1879 self.update_time_counter += 1;
1880 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1881 // Note that funding_signed/funding_created will have decremented both by 1!
1882 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1883 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1884 // If we reconnected before sending our funding locked they may still resend theirs:
1885 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1886 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1887 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1888 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1890 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1893 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1896 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1897 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1899 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1904 /// Returns a HTLCStats about inbound pending htlcs
1905 fn get_inbound_pending_htlc_stats(&self) -> HTLCStats {
1906 let mut stats = HTLCStats {
1907 pending_htlcs: self.pending_inbound_htlcs.len() as u32,
1908 pending_htlcs_value_msat: 0,
1909 on_counterparty_tx_dust_exposure_msat: 0,
1910 on_holder_tx_dust_exposure_msat: 0,
1913 let counterparty_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1914 let holder_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1915 for ref htlc in self.pending_inbound_htlcs.iter() {
1916 stats.pending_htlcs_value_msat += htlc.amount_msat;
1917 if htlc.amount_msat / 1000 < counterparty_dust_limit_timeout_sat {
1918 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1920 if htlc.amount_msat / 1000 < holder_dust_limit_success_sat {
1921 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1927 /// Returns a HTLCStats about pending outbound htlcs, *including* pending adds in our holding cell.
1928 fn get_outbound_pending_htlc_stats(&self) -> HTLCStats {
1929 let mut stats = HTLCStats {
1930 pending_htlcs: self.pending_outbound_htlcs.len() as u32,
1931 pending_htlcs_value_msat: 0,
1932 on_counterparty_tx_dust_exposure_msat: 0,
1933 on_holder_tx_dust_exposure_msat: 0,
1936 let counterparty_dust_limit_success_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1937 let holder_dust_limit_timeout_sat = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1938 for ref htlc in self.pending_outbound_htlcs.iter() {
1939 stats.pending_htlcs_value_msat += htlc.amount_msat;
1940 if htlc.amount_msat / 1000 < counterparty_dust_limit_success_sat {
1941 stats.on_counterparty_tx_dust_exposure_msat += htlc.amount_msat;
1943 if htlc.amount_msat / 1000 < holder_dust_limit_timeout_sat {
1944 stats.on_holder_tx_dust_exposure_msat += htlc.amount_msat;
1948 for update in self.holding_cell_htlc_updates.iter() {
1949 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1950 stats.pending_htlcs += 1;
1951 stats.pending_htlcs_value_msat += amount_msat;
1952 if *amount_msat / 1000 < counterparty_dust_limit_success_sat {
1953 stats.on_counterparty_tx_dust_exposure_msat += amount_msat;
1955 if *amount_msat / 1000 < holder_dust_limit_timeout_sat {
1956 stats.on_holder_tx_dust_exposure_msat += amount_msat;
1963 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1964 /// Doesn't bother handling the
1965 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1966 /// corner case properly.
1967 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1968 // Note that we have to handle overflow due to the above case.
1970 cmp::max(self.channel_value_satoshis as i64 * 1000
1971 - self.value_to_self_msat as i64
1972 - self.get_inbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1973 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1975 cmp::max(self.value_to_self_msat as i64
1976 - self.get_outbound_pending_htlc_stats().pending_htlcs_value_msat as i64
1977 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1982 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1983 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1984 self.counterparty_selected_channel_reserve_satoshis)
1987 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1988 // Note that num_htlcs should not include dust HTLCs.
1989 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1990 // Note that we need to divide before multiplying to round properly,
1991 // since the lowest denomination of bitcoin on-chain is the satoshi.
1992 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1995 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1996 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1997 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1999 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2000 assert!(self.is_outbound());
2002 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2003 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2005 let mut addl_htlcs = 0;
2006 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2008 HTLCInitiator::LocalOffered => {
2009 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2013 HTLCInitiator::RemoteOffered => {
2014 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2020 let mut included_htlcs = 0;
2021 for ref htlc in self.pending_inbound_htlcs.iter() {
2022 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
2025 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
2026 // transaction including this HTLC if it times out before they RAA.
2027 included_htlcs += 1;
2030 for ref htlc in self.pending_outbound_htlcs.iter() {
2031 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
2035 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
2036 OutboundHTLCState::Committed => included_htlcs += 1,
2037 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2038 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
2039 // transaction won't be generated until they send us their next RAA, which will mean
2040 // dropping any HTLCs in this state.
2045 for htlc in self.holding_cell_htlc_updates.iter() {
2047 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
2048 if amount_msat / 1000 < real_dust_limit_timeout_sat {
2053 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
2054 // ack we're guaranteed to never include them in commitment txs anymore.
2058 let num_htlcs = included_htlcs + addl_htlcs;
2059 let res = self.commit_tx_fee_msat(num_htlcs);
2060 #[cfg(any(test, feature = "fuzztarget"))]
2063 if fee_spike_buffer_htlc.is_some() {
2064 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2066 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2067 + self.holding_cell_htlc_updates.len();
2068 let commitment_tx_info = CommitmentTxInfoCached {
2070 total_pending_htlcs,
2071 next_holder_htlc_id: match htlc.origin {
2072 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2073 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2075 next_counterparty_htlc_id: match htlc.origin {
2076 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2077 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2079 feerate: self.feerate_per_kw,
2081 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2086 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
2087 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
2088 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
2090 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
2091 assert!(!self.is_outbound());
2093 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2094 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2096 let mut addl_htlcs = 0;
2097 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
2099 HTLCInitiator::LocalOffered => {
2100 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2104 HTLCInitiator::RemoteOffered => {
2105 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2111 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2112 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2113 // committed outbound HTLCs, see below.
2114 let mut included_htlcs = 0;
2115 for ref htlc in self.pending_inbound_htlcs.iter() {
2116 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2119 included_htlcs += 1;
2122 for ref htlc in self.pending_outbound_htlcs.iter() {
2123 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2126 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2127 // i.e. if they've responded to us with an RAA after announcement.
2129 OutboundHTLCState::Committed => included_htlcs += 1,
2130 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2131 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2136 let num_htlcs = included_htlcs + addl_htlcs;
2137 let res = self.commit_tx_fee_msat(num_htlcs);
2138 #[cfg(any(test, feature = "fuzztarget"))]
2141 if fee_spike_buffer_htlc.is_some() {
2142 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2144 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2145 let commitment_tx_info = CommitmentTxInfoCached {
2147 total_pending_htlcs,
2148 next_holder_htlc_id: match htlc.origin {
2149 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2150 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2152 next_counterparty_htlc_id: match htlc.origin {
2153 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2154 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2156 feerate: self.feerate_per_kw,
2158 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2163 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>
2164 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2165 // We can't accept HTLCs sent after we've sent a shutdown.
2166 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2167 if local_sent_shutdown {
2168 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x4000|8);
2170 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2171 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2172 if remote_sent_shutdown {
2173 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2175 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2176 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2178 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2179 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2181 if msg.amount_msat == 0 {
2182 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2184 if msg.amount_msat < self.holder_htlc_minimum_msat {
2185 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)));
2188 let inbound_stats = self.get_inbound_pending_htlc_stats();
2189 let outbound_stats = self.get_outbound_pending_htlc_stats();
2190 if inbound_stats.pending_htlcs + 1 > OUR_MAX_HTLCS as u32 {
2191 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2193 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2194 if inbound_stats.pending_htlcs_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2195 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2197 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2198 // the reserve_satoshis we told them to always have as direct payment so that they lose
2199 // something if we punish them for broadcasting an old state).
2200 // Note that we don't really care about having a small/no to_remote output in our local
2201 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2202 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2203 // present in the next commitment transaction we send them (at least for fulfilled ones,
2204 // failed ones won't modify value_to_self).
2205 // Note that we will send HTLCs which another instance of rust-lightning would think
2206 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2207 // Channel state once they will not be present in the next received commitment
2209 let mut removed_outbound_total_msat = 0;
2210 for ref htlc in self.pending_outbound_htlcs.iter() {
2211 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2212 removed_outbound_total_msat += htlc.amount_msat;
2213 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2214 removed_outbound_total_msat += htlc.amount_msat;
2218 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
2219 if msg.amount_msat / 1000 < exposure_dust_limit_timeout_sats {
2220 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;
2221 if on_counterparty_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2222 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
2223 on_counterparty_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2224 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2228 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
2229 if msg.amount_msat / 1000 < exposure_dust_limit_success_sats {
2230 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;
2231 if on_holder_tx_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
2232 log_info!(logger, "Cannot accept value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
2233 on_holder_tx_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat());
2234 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2238 let pending_value_to_self_msat =
2239 self.value_to_self_msat + inbound_stats.pending_htlcs_value_msat - removed_outbound_total_msat;
2240 let pending_remote_value_msat =
2241 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2242 if pending_remote_value_msat < msg.amount_msat {
2243 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2246 // Check that the remote can afford to pay for this HTLC on-chain at the current
2247 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2248 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2249 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2250 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2252 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2253 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2256 let chan_reserve_msat =
2257 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2258 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2259 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2262 if !self.is_outbound() {
2263 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2264 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2265 // receiver's side, only on the sender's.
2266 // Note that when we eventually remove support for fee updates and switch to anchor output
2267 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2268 // the extra htlc when calculating the next remote commitment transaction fee as we should
2269 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2270 // sensitive to fee spikes.
2271 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2272 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2273 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2274 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2275 // the HTLC, i.e. its status is already set to failing.
2276 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2277 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2280 // Check that they won't violate our local required channel reserve by adding this HTLC.
2281 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2282 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2283 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2284 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2287 if self.next_counterparty_htlc_id != msg.htlc_id {
2288 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2290 if msg.cltv_expiry >= 500000000 {
2291 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2294 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2295 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2296 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2300 // Now update local state:
2301 self.next_counterparty_htlc_id += 1;
2302 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2303 htlc_id: msg.htlc_id,
2304 amount_msat: msg.amount_msat,
2305 payment_hash: msg.payment_hash,
2306 cltv_expiry: msg.cltv_expiry,
2307 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2312 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2314 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2315 for htlc in self.pending_outbound_htlcs.iter_mut() {
2316 if htlc.htlc_id == htlc_id {
2317 match check_preimage {
2319 Some(payment_hash) =>
2320 if payment_hash != htlc.payment_hash {
2321 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2325 OutboundHTLCState::LocalAnnounced(_) =>
2326 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2327 OutboundHTLCState::Committed => {
2328 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2330 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2331 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2336 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2339 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2340 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2341 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2343 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2344 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2347 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2348 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2351 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2352 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2353 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2355 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2356 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2359 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2363 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2364 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2365 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2367 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2368 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2371 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2375 pub fn commitment_signed<L: Deref>(&mut self, msg: &msgs::CommitmentSigned, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2376 where L::Target: Logger
2378 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2379 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2381 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2382 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2384 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2385 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2388 let funding_script = self.get_funding_redeemscript();
2390 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2392 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid, feerate_per_kw) = {
2393 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, logger);
2394 let commitment_txid = {
2395 let trusted_tx = commitment_tx.0.trust();
2396 let bitcoin_tx = trusted_tx.built_transaction();
2397 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2399 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2400 log_bytes!(msg.signature.serialize_compact()[..]),
2401 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2402 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2403 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2404 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2408 let htlcs_cloned: Vec<_> = commitment_tx.3.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2409 (commitment_tx.2, htlcs_cloned, commitment_tx.0, commitment_txid, commitment_tx.1)
2412 // If our counterparty updated the channel fee in this commitment transaction, check that
2413 // they can actually afford the new fee now.
2414 let update_fee = if let Some((_, update_state)) = self.pending_update_fee {
2415 update_state == FeeUpdateState::RemoteAnnounced
2417 if update_fee { debug_assert!(!self.is_outbound()); }
2418 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2420 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2421 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2422 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2425 #[cfg(any(test, feature = "fuzztarget"))]
2427 if self.is_outbound() {
2428 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2429 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2430 if let Some(info) = projected_commit_tx_info {
2431 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2432 + self.holding_cell_htlc_updates.len();
2433 if info.total_pending_htlcs == total_pending_htlcs
2434 && info.next_holder_htlc_id == self.next_holder_htlc_id
2435 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2436 && info.feerate == self.feerate_per_kw {
2437 assert_eq!(total_fee, info.fee / 1000);
2443 if msg.htlc_signatures.len() != num_htlcs {
2444 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2447 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2448 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2449 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2450 if let Some(_) = htlc.transaction_output_index {
2451 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2452 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2453 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2455 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2456 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2457 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2458 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2459 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2460 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2461 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2463 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2465 htlcs_and_sigs.push((htlc, None, source));
2469 let holder_commitment_tx = HolderCommitmentTransaction::new(
2472 msg.htlc_signatures.clone(),
2473 &self.get_holder_pubkeys().funding_pubkey,
2474 self.counterparty_funding_pubkey()
2477 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2478 self.holder_signer.validate_holder_commitment(&holder_commitment_tx)
2479 .map_err(|_| (None, ChannelError::Close("Failed to validate our commitment".to_owned())))?;
2480 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2482 // Update state now that we've passed all the can-fail calls...
2483 let mut need_commitment = false;
2484 if let &mut Some((_, ref mut update_state)) = &mut self.pending_update_fee {
2485 if *update_state == FeeUpdateState::RemoteAnnounced {
2486 *update_state = FeeUpdateState::AwaitingRemoteRevokeToAnnounce;
2487 need_commitment = true;
2491 self.latest_monitor_update_id += 1;
2492 let mut monitor_update = ChannelMonitorUpdate {
2493 update_id: self.latest_monitor_update_id,
2494 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2495 commitment_tx: holder_commitment_tx,
2496 htlc_outputs: htlcs_and_sigs
2500 for htlc in self.pending_inbound_htlcs.iter_mut() {
2501 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2502 Some(forward_info.clone())
2504 if let Some(forward_info) = new_forward {
2505 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2506 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2507 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2508 need_commitment = true;
2511 for htlc in self.pending_outbound_htlcs.iter_mut() {
2512 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2513 Some(fail_reason.take())
2515 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2516 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2517 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2518 need_commitment = true;
2522 self.cur_holder_commitment_transaction_number -= 1;
2523 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2524 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2525 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2527 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2528 // In case we initially failed monitor updating without requiring a response, we need
2529 // to make sure the RAA gets sent first.
2530 self.monitor_pending_revoke_and_ack = true;
2531 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2532 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2533 // the corresponding HTLC status updates so that get_last_commitment_update
2534 // includes the right HTLCs.
2535 self.monitor_pending_commitment_signed = true;
2536 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2537 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2538 // strictly increasing by one, so decrement it here.
2539 self.latest_monitor_update_id = monitor_update.update_id;
2540 monitor_update.updates.append(&mut additional_update.updates);
2542 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2543 log_bytes!(self.channel_id));
2544 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2547 let commitment_signed = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2548 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2549 // we'll send one right away when we get the revoke_and_ack when we
2550 // free_holding_cell_htlcs().
2551 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2552 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2553 // strictly increasing by one, so decrement it here.
2554 self.latest_monitor_update_id = monitor_update.update_id;
2555 monitor_update.updates.append(&mut additional_update.updates);
2559 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2560 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2562 Ok((msgs::RevokeAndACK {
2563 channel_id: self.channel_id,
2564 per_commitment_secret,
2565 next_per_commitment_point,
2566 }, commitment_signed, monitor_update))
2569 /// Public version of the below, checking relevant preconditions first.
2570 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2571 /// returns `(None, Vec::new())`.
2572 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 {
2573 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2574 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2575 self.free_holding_cell_htlcs(logger)
2576 } else { Ok((None, Vec::new())) }
2579 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2580 /// fulfilling or failing the last pending HTLC)
2581 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2582 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2583 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2584 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2585 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2587 let mut monitor_update = ChannelMonitorUpdate {
2588 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2589 updates: Vec::new(),
2592 let mut htlc_updates = Vec::new();
2593 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2594 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2595 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2596 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2597 let mut htlcs_to_fail = Vec::new();
2598 for htlc_update in htlc_updates.drain(..) {
2599 // Note that this *can* fail, though it should be due to rather-rare conditions on
2600 // fee races with adding too many outputs which push our total payments just over
2601 // the limit. In case it's less rare than I anticipate, we may want to revisit
2602 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2603 // to rebalance channels.
2604 match &htlc_update {
2605 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2606 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2607 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2610 ChannelError::Ignore(ref msg) => {
2611 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2612 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2613 // If we fail to send here, then this HTLC should
2614 // be failed backwards. Failing to send here
2615 // indicates that this HTLC may keep being put back
2616 // into the holding cell without ever being
2617 // successfully forwarded/failed/fulfilled, causing
2618 // our counterparty to eventually close on us.
2619 htlcs_to_fail.push((source.clone(), *payment_hash));
2622 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2628 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2629 // If an HTLC claim was previously added to the holding cell (via
2630 // `get_update_fulfill_htlc`, then generating the claim message itself must
2631 // not fail - any in between attempts to claim the HTLC will have resulted
2632 // in it hitting the holding cell again and we cannot change the state of a
2633 // holding cell HTLC from fulfill to anything else.
2634 let (update_fulfill_msg_option, mut additional_monitor_update) =
2635 if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2636 (msg, monitor_update)
2637 } else { unreachable!() };
2638 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2639 monitor_update.updates.append(&mut additional_monitor_update.updates);
2641 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2642 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2643 Ok(update_fail_msg_option) => {
2644 // If an HTLC failure was previously added to the holding cell (via
2645 // `get_update_fail_htlc`) then generating the fail message itself
2646 // must not fail - we should never end up in a state where we
2647 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2648 // we didn't wait for a full revocation before failing.
2649 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2652 if let ChannelError::Ignore(_) = e {}
2654 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2661 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2662 return Ok((None, htlcs_to_fail));
2664 let update_fee = if let Some(feerate) = self.holding_cell_update_fee.take() {
2665 assert!(self.is_outbound());
2666 self.pending_update_fee = Some((feerate, FeeUpdateState::Outbound));
2667 Some(msgs::UpdateFee {
2668 channel_id: self.channel_id,
2669 feerate_per_kw: feerate as u32,
2675 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2676 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2677 // but we want them to be strictly increasing by one, so reset it here.
2678 self.latest_monitor_update_id = monitor_update.update_id;
2679 monitor_update.updates.append(&mut additional_update.updates);
2681 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2682 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2683 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2685 Ok((Some((msgs::CommitmentUpdate {
2687 update_fulfill_htlcs,
2689 update_fail_malformed_htlcs: Vec::new(),
2692 }, monitor_update)), htlcs_to_fail))
2694 Ok((None, Vec::new()))
2698 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2699 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2700 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2701 /// generating an appropriate error *after* the channel state has been updated based on the
2702 /// revoke_and_ack message.
2703 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>
2704 where L::Target: Logger,
2706 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2707 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2709 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2710 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2712 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2713 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2716 let secret = secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned());
2718 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2719 if PublicKey::from_secret_key(&self.secp_ctx, &secret) != counterparty_prev_commitment_point {
2720 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2724 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2725 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2726 // haven't given them a new commitment transaction to broadcast). We should probably
2727 // take advantage of this by updating our channel monitor, sending them an error, and
2728 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2729 // lot of work, and there's some chance this is all a misunderstanding anyway.
2730 // We have to do *something*, though, since our signer may get mad at us for otherwise
2731 // jumping a remote commitment number, so best to just force-close and move on.
2732 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2735 #[cfg(any(test, feature = "fuzztarget"))]
2737 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2738 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2741 self.holder_signer.validate_counterparty_revocation(
2742 self.cur_counterparty_commitment_transaction_number + 1,
2744 ).map_err(|_| ChannelError::Close("Failed to validate revocation from peer".to_owned()))?;
2746 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2747 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2748 self.latest_monitor_update_id += 1;
2749 let mut monitor_update = ChannelMonitorUpdate {
2750 update_id: self.latest_monitor_update_id,
2751 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2752 idx: self.cur_counterparty_commitment_transaction_number + 1,
2753 secret: msg.per_commitment_secret,
2757 // Update state now that we've passed all the can-fail calls...
2758 // (note that we may still fail to generate the new commitment_signed message, but that's
2759 // OK, we step the channel here and *then* if the new generation fails we can fail the
2760 // channel based on that, but stepping stuff here should be safe either way.
2761 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2762 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2763 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2764 self.cur_counterparty_commitment_transaction_number -= 1;
2766 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2767 let mut to_forward_infos = Vec::new();
2768 let mut revoked_htlcs = Vec::new();
2769 let mut update_fail_htlcs = Vec::new();
2770 let mut update_fail_malformed_htlcs = Vec::new();
2771 let mut require_commitment = false;
2772 let mut value_to_self_msat_diff: i64 = 0;
2775 // Take references explicitly so that we can hold multiple references to self.
2776 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2777 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2779 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2780 pending_inbound_htlcs.retain(|htlc| {
2781 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2782 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2783 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2784 value_to_self_msat_diff += htlc.amount_msat as i64;
2789 pending_outbound_htlcs.retain(|htlc| {
2790 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2791 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2792 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2793 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2795 // They fulfilled, so we sent them money
2796 value_to_self_msat_diff -= htlc.amount_msat as i64;
2801 for htlc in pending_inbound_htlcs.iter_mut() {
2802 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2804 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2808 let mut state = InboundHTLCState::Committed;
2809 mem::swap(&mut state, &mut htlc.state);
2811 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2812 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2813 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2814 require_commitment = true;
2815 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2816 match forward_info {
2817 PendingHTLCStatus::Fail(fail_msg) => {
2818 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2819 require_commitment = true;
2821 HTLCFailureMsg::Relay(msg) => {
2822 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2823 update_fail_htlcs.push(msg)
2825 HTLCFailureMsg::Malformed(msg) => {
2826 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2827 update_fail_malformed_htlcs.push(msg)
2831 PendingHTLCStatus::Forward(forward_info) => {
2832 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2833 to_forward_infos.push((forward_info, htlc.htlc_id));
2834 htlc.state = InboundHTLCState::Committed;
2840 for htlc in pending_outbound_htlcs.iter_mut() {
2841 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2842 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2843 htlc.state = OutboundHTLCState::Committed;
2845 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2846 Some(fail_reason.take())
2848 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2849 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2850 require_commitment = true;
2854 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2856 if let Some((feerate, update_state)) = self.pending_update_fee {
2857 match update_state {
2858 FeeUpdateState::Outbound => {
2859 debug_assert!(self.is_outbound());
2860 log_trace!(logger, " ...promoting outbound fee update {} to Committed", feerate);
2861 self.feerate_per_kw = feerate;
2862 self.pending_update_fee = None;
2864 FeeUpdateState::RemoteAnnounced => { debug_assert!(!self.is_outbound()); },
2865 FeeUpdateState::AwaitingRemoteRevokeToAnnounce => {
2866 debug_assert!(!self.is_outbound());
2867 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
2868 require_commitment = true;
2869 self.feerate_per_kw = feerate;
2870 self.pending_update_fee = None;
2875 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2876 // We can't actually generate a new commitment transaction (incl by freeing holding
2877 // cells) while we can't update the monitor, so we just return what we have.
2878 if require_commitment {
2879 self.monitor_pending_commitment_signed = true;
2880 // When the monitor updating is restored we'll call get_last_commitment_update(),
2881 // which does not update state, but we're definitely now awaiting a remote revoke
2882 // before we can step forward any more, so set it here.
2883 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2884 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2885 // strictly increasing by one, so decrement it here.
2886 self.latest_monitor_update_id = monitor_update.update_id;
2887 monitor_update.updates.append(&mut additional_update.updates);
2889 self.monitor_pending_forwards.append(&mut to_forward_infos);
2890 self.monitor_pending_failures.append(&mut revoked_htlcs);
2891 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2892 return Ok((None, Vec::new(), Vec::new(), monitor_update, Vec::new()))
2895 match self.free_holding_cell_htlcs(logger)? {
2896 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2897 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2898 for fail_msg in update_fail_htlcs.drain(..) {
2899 commitment_update.update_fail_htlcs.push(fail_msg);
2901 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2902 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2903 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2906 // free_holding_cell_htlcs may bump latest_monitor_id multiple times 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 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2913 (None, htlcs_to_fail) => {
2914 if require_commitment {
2915 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2917 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2918 // strictly increasing by one, so decrement it here.
2919 self.latest_monitor_update_id = monitor_update.update_id;
2920 monitor_update.updates.append(&mut additional_update.updates);
2922 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2923 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2924 Ok((Some(msgs::CommitmentUpdate {
2925 update_add_htlcs: Vec::new(),
2926 update_fulfill_htlcs: Vec::new(),
2928 update_fail_malformed_htlcs,
2931 }), to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2933 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2934 Ok((None, to_forward_infos, revoked_htlcs, monitor_update, htlcs_to_fail))
2940 /// Adds a pending update to this channel. See the doc for send_htlc for
2941 /// further details on the optionness of the return value.
2942 /// You MUST call send_commitment prior to any other calls on this Channel
2943 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2944 if !self.is_outbound() {
2945 panic!("Cannot send fee from inbound channel");
2947 if !self.is_usable() {
2948 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2950 if !self.is_live() {
2951 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2954 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
2955 self.holding_cell_update_fee = Some(feerate_per_kw);
2959 debug_assert!(self.pending_update_fee.is_none());
2960 self.pending_update_fee = Some((feerate_per_kw, FeeUpdateState::Outbound));
2962 Some(msgs::UpdateFee {
2963 channel_id: self.channel_id,
2968 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 {
2969 match self.send_update_fee(feerate_per_kw) {
2970 Some(update_fee) => {
2971 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2972 Ok(Some((update_fee, commitment_signed, monitor_update)))
2978 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2979 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2981 /// No further message handling calls may be made until a channel_reestablish dance has
2983 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
2984 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2985 if self.channel_state < ChannelState::FundingSent as u32 {
2986 self.channel_state = ChannelState::ShutdownComplete as u32;
2989 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2990 // will be retransmitted.
2991 self.last_sent_closing_fee = None;
2992 self.pending_counterparty_closing_signed = None;
2993 self.closing_fee_limits = None;
2995 let mut inbound_drop_count = 0;
2996 self.pending_inbound_htlcs.retain(|htlc| {
2998 InboundHTLCState::RemoteAnnounced(_) => {
2999 // They sent us an update_add_htlc but we never got the commitment_signed.
3000 // We'll tell them what commitment_signed we're expecting next and they'll drop
3001 // this HTLC accordingly
3002 inbound_drop_count += 1;
3005 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
3006 // We received a commitment_signed updating this HTLC and (at least hopefully)
3007 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
3008 // in response to it yet, so don't touch it.
3011 InboundHTLCState::Committed => true,
3012 InboundHTLCState::LocalRemoved(_) => {
3013 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
3014 // re-transmit if needed) and they may have even sent a revoke_and_ack back
3015 // (that we missed). Keep this around for now and if they tell us they missed
3016 // the commitment_signed we can re-transmit the update then.
3021 self.next_counterparty_htlc_id -= inbound_drop_count;
3023 if let Some((_, update_state)) = self.pending_update_fee {
3024 if update_state == FeeUpdateState::RemoteAnnounced {
3025 debug_assert!(!self.is_outbound());
3026 self.pending_update_fee = None;
3030 for htlc in self.pending_outbound_htlcs.iter_mut() {
3031 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
3032 // They sent us an update to remove this but haven't yet sent the corresponding
3033 // commitment_signed, we need to move it back to Committed and they can re-send
3034 // the update upon reconnection.
3035 htlc.state = OutboundHTLCState::Committed;
3039 self.channel_state |= ChannelState::PeerDisconnected as u32;
3040 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
3043 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
3044 /// updates are partially paused.
3045 /// This must be called immediately after the call which generated the ChannelMonitor update
3046 /// which failed. The messages which were generated from that call which generated the
3047 /// monitor update failure must *not* have been sent to the remote end, and must instead
3048 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
3049 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)>) {
3050 self.monitor_pending_revoke_and_ack |= resend_raa;
3051 self.monitor_pending_commitment_signed |= resend_commitment;
3052 self.monitor_pending_forwards.append(&mut pending_forwards);
3053 self.monitor_pending_failures.append(&mut pending_fails);
3054 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
3057 /// Indicates that the latest ChannelMonitor update has been committed by the client
3058 /// successfully and we should restore normal operation. Returns messages which should be sent
3059 /// to the remote side.
3060 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<Transaction>, Option<msgs::FundingLocked>) where L::Target: Logger {
3061 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
3062 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
3064 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
3065 self.funding_transaction.take()
3068 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
3069 // we assume the user never directly broadcasts the funding transaction and waits for us to
3070 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
3071 // channel which failed to persist the monitor on funding_created, and we got the funding
3072 // transaction confirmed before the monitor was persisted.
3073 let funding_locked = if self.monitor_pending_funding_locked {
3074 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
3075 self.monitor_pending_funding_locked = false;
3076 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3077 Some(msgs::FundingLocked {
3078 channel_id: self.channel_id(),
3079 next_per_commitment_point,
3083 let mut forwards = Vec::new();
3084 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
3085 let mut failures = Vec::new();
3086 mem::swap(&mut failures, &mut self.monitor_pending_failures);
3088 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
3089 self.monitor_pending_revoke_and_ack = false;
3090 self.monitor_pending_commitment_signed = false;
3091 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
3094 let raa = if self.monitor_pending_revoke_and_ack {
3095 Some(self.get_last_revoke_and_ack())
3097 let commitment_update = if self.monitor_pending_commitment_signed {
3098 Some(self.get_last_commitment_update(logger))
3101 self.monitor_pending_revoke_and_ack = false;
3102 self.monitor_pending_commitment_signed = false;
3103 let order = self.resend_order.clone();
3104 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
3105 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
3106 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
3107 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
3108 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
3111 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
3112 where F::Target: FeeEstimator
3114 if self.is_outbound() {
3115 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
3117 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3118 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
3120 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
3121 let feerate_over_dust_buffer = msg.feerate_per_kw > self.get_dust_buffer_feerate();
3123 self.pending_update_fee = Some((msg.feerate_per_kw, FeeUpdateState::RemoteAnnounced));
3124 self.update_time_counter += 1;
3125 // If the feerate has increased over the previous dust buffer (note that
3126 // `get_dust_buffer_feerate` considers the `pending_update_fee` status), check that we
3127 // won't be pushed over our dust exposure limit by the feerate increase.
3128 if feerate_over_dust_buffer {
3129 let inbound_stats = self.get_inbound_pending_htlc_stats();
3130 let outbound_stats = self.get_outbound_pending_htlc_stats();
3131 let holder_tx_dust_exposure = inbound_stats.on_holder_tx_dust_exposure_msat + outbound_stats.on_holder_tx_dust_exposure_msat;
3132 let counterparty_tx_dust_exposure = inbound_stats.on_counterparty_tx_dust_exposure_msat + outbound_stats.on_counterparty_tx_dust_exposure_msat;
3133 if holder_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3134 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our own transactions (totaling {} msat)",
3135 msg.feerate_per_kw, holder_tx_dust_exposure)));
3137 if counterparty_tx_dust_exposure > self.get_max_dust_htlc_exposure_msat() {
3138 return Err(ChannelError::Close(format!("Peer sent update_fee with a feerate ({}) which may over-expose us to dust-in-flight on our counterparty's transactions (totaling {} msat)",
3139 msg.feerate_per_kw, counterparty_tx_dust_exposure)));
3145 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3146 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3147 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3148 msgs::RevokeAndACK {
3149 channel_id: self.channel_id,
3150 per_commitment_secret,
3151 next_per_commitment_point,
3155 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3156 let mut update_add_htlcs = Vec::new();
3157 let mut update_fulfill_htlcs = Vec::new();
3158 let mut update_fail_htlcs = Vec::new();
3159 let mut update_fail_malformed_htlcs = Vec::new();
3161 for htlc in self.pending_outbound_htlcs.iter() {
3162 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3163 update_add_htlcs.push(msgs::UpdateAddHTLC {
3164 channel_id: self.channel_id(),
3165 htlc_id: htlc.htlc_id,
3166 amount_msat: htlc.amount_msat,
3167 payment_hash: htlc.payment_hash,
3168 cltv_expiry: htlc.cltv_expiry,
3169 onion_routing_packet: (**onion_packet).clone(),
3174 for htlc in self.pending_inbound_htlcs.iter() {
3175 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3177 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3178 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3179 channel_id: self.channel_id(),
3180 htlc_id: htlc.htlc_id,
3181 reason: err_packet.clone()
3184 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3185 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3186 channel_id: self.channel_id(),
3187 htlc_id: htlc.htlc_id,
3188 sha256_of_onion: sha256_of_onion.clone(),
3189 failure_code: failure_code.clone(),
3192 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3193 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3194 channel_id: self.channel_id(),
3195 htlc_id: htlc.htlc_id,
3196 payment_preimage: payment_preimage.clone(),
3203 let update_fee = if self.is_outbound() && self.pending_update_fee.is_some() {
3204 Some(msgs::UpdateFee {
3205 channel_id: self.channel_id(),
3206 feerate_per_kw: self.pending_update_fee.unwrap().0,
3210 log_trace!(logger, "Regenerated latest commitment update in channel {} with{} {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3211 log_bytes!(self.channel_id()), if update_fee.is_some() { " update_fee," } else { "" },
3212 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3213 msgs::CommitmentUpdate {
3214 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee,
3215 commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
3219 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3220 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3221 pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Vec<(HTLCSource, PaymentHash)>, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
3222 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3223 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3224 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3225 // just close here instead of trying to recover.
3226 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3229 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3230 msg.next_local_commitment_number == 0 {
3231 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3234 if msg.next_remote_commitment_number > 0 {
3235 match msg.data_loss_protect {
3236 OptionalField::Present(ref data_loss) => {
3237 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3238 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3239 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3240 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3241 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3243 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3244 return Err(ChannelError::CloseDelayBroadcast(
3245 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
3249 OptionalField::Absent => {}
3253 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3254 // remaining cases either succeed or ErrorMessage-fail).
3255 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3257 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3258 assert!(self.shutdown_scriptpubkey.is_some());
3259 Some(msgs::Shutdown {
3260 channel_id: self.channel_id,
3261 scriptpubkey: self.get_closing_scriptpubkey(),
3265 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3266 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3267 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3268 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3269 if msg.next_remote_commitment_number != 0 {
3270 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3272 // Short circuit the whole handler as there is nothing we can resend them
3273 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3276 // We have OurFundingLocked set!
3277 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3278 return Ok((Some(msgs::FundingLocked {
3279 channel_id: self.channel_id(),
3280 next_per_commitment_point,
3281 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3284 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3285 // Remote isn't waiting on any RevokeAndACK from us!
3286 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3288 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3289 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3290 self.monitor_pending_revoke_and_ack = true;
3293 Some(self.get_last_revoke_and_ack())
3296 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3299 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3300 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3301 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3302 // the corresponding revoke_and_ack back yet.
3303 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
3305 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3306 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3307 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3308 Some(msgs::FundingLocked {
3309 channel_id: self.channel_id(),
3310 next_per_commitment_point,
3314 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3315 if required_revoke.is_some() {
3316 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3318 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3321 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3322 // We're up-to-date and not waiting on a remote revoke (if we are our
3323 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3324 // have received some updates while we were disconnected. Free the holding cell
3326 match self.free_holding_cell_htlcs(logger) {
3327 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3328 Err(ChannelError::Warn(_)) | Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) =>
3329 panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3330 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3331 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3333 Ok((None, htlcs_to_fail)) => {
3334 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3338 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3340 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3341 if required_revoke.is_some() {
3342 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3344 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3347 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3348 self.monitor_pending_commitment_signed = true;
3349 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3352 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3354 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3358 /// Calculates and returns our minimum and maximum closing transaction fee amounts, in whole
3359 /// satoshis. The amounts remain consistent unless a peer disconnects/reconnects or we restart,
3360 /// at which point they will be recalculated.
3361 fn calculate_closing_fee_limits<F: Deref>(&mut self, fee_estimator: &F) -> (u64, u64)
3362 where F::Target: FeeEstimator
3364 if let Some((min, max)) = self.closing_fee_limits { return (min, max); }
3366 // Propose a range from our current Background feerate to our Normal feerate plus our
3367 // force_close_avoidance_max_fee_satoshis.
3368 // If we fail to come to consensus, we'll have to force-close.
3369 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3370 let normal_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3371 let mut proposed_max_feerate = if self.is_outbound() { normal_feerate } else { u32::max_value() };
3373 // The spec requires that (when the channel does not have anchors) we only send absolute
3374 // channel fees no greater than the absolute channel fee on the current commitment
3375 // transaction. It's unclear *which* commitment transaction this refers to, and there isn't
3376 // very good reason to apply such a limit in any case. We don't bother doing so, risking
3377 // some force-closure by old nodes, but we wanted to close the channel anyway.
3379 if let Some(target_feerate) = self.target_closing_feerate_sats_per_kw {
3380 let min_feerate = if self.is_outbound() { target_feerate } else { cmp::min(self.feerate_per_kw, target_feerate) };
3381 proposed_feerate = cmp::max(proposed_feerate, min_feerate);
3382 proposed_max_feerate = cmp::max(proposed_max_feerate, min_feerate);
3385 // Note that technically we could end up with a lower minimum fee if one sides' balance is
3386 // below our dust limit, causing the output to disappear. We don't bother handling this
3387 // case, however, as this should only happen if a channel is closed before any (material)
3388 // payments have been made on it. This may cause slight fee overpayment and/or failure to
3389 // come to consensus with our counterparty on appropriate fees, however it should be a
3390 // relatively rare case. We can revisit this later, though note that in order to determine
3391 // if the funders' output is dust we have to know the absolute fee we're going to use.
3392 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3393 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3394 let proposed_max_total_fee_satoshis = if self.is_outbound() {
3395 // We always add force_close_avoidance_max_fee_satoshis to our normal
3396 // feerate-calculated fee, but allow the max to be overridden if we're using a
3397 // target feerate-calculated fee.
3398 cmp::max(normal_feerate as u64 * tx_weight / 1000 + self.config.force_close_avoidance_max_fee_satoshis,
3399 proposed_max_feerate as u64 * tx_weight / 1000)
3401 self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000
3404 self.closing_fee_limits = Some((proposed_total_fee_satoshis, proposed_max_total_fee_satoshis));
3405 self.closing_fee_limits.clone().unwrap()
3408 /// Returns true if we're ready to commence the closing_signed negotiation phase. This is true
3409 /// after both sides have exchanged a `shutdown` message and all HTLCs have been drained. At
3410 /// this point if we're the funder we should send the initial closing_signed, and in any case
3411 /// shutdown should complete within a reasonable timeframe.
3412 fn closing_negotiation_ready(&self) -> bool {
3413 self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() &&
3414 self.channel_state &
3415 (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32 |
3416 ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)
3417 == BOTH_SIDES_SHUTDOWN_MASK &&
3418 self.pending_update_fee.is_none()
3421 /// Checks if the closing_signed negotiation is making appropriate progress, possibly returning
3422 /// an Err if no progress is being made and the channel should be force-closed instead.
3423 /// Should be called on a one-minute timer.
3424 pub fn timer_check_closing_negotiation_progress(&mut self) -> Result<(), ChannelError> {
3425 if self.closing_negotiation_ready() {
3426 if self.closing_signed_in_flight {
3427 return Err(ChannelError::Close("closing_signed negotiation failed to finish within two timer ticks".to_owned()));
3429 self.closing_signed_in_flight = true;
3435 pub fn maybe_propose_closing_signed<F: Deref, L: Deref>(&mut self, fee_estimator: &F, logger: &L)
3436 -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3437 where F::Target: FeeEstimator, L::Target: Logger
3439 if self.last_sent_closing_fee.is_some() || !self.closing_negotiation_ready() {
3440 return Ok((None, None));
3443 if !self.is_outbound() {
3444 if let Some(msg) = &self.pending_counterparty_closing_signed.take() {
3445 return self.closing_signed(fee_estimator, &msg);
3447 return Ok((None, None));
3450 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3452 assert!(self.shutdown_scriptpubkey.is_some());
3453 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(our_min_fee, false);
3454 log_trace!(logger, "Proposing initial closing_signed for our counterparty with a fee range of {}-{} sat (with initial proposal {} sats)",
3455 our_min_fee, our_max_fee, total_fee_satoshis);
3457 let sig = self.holder_signer
3458 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3459 .map_err(|()| ChannelError::Close("Failed to get signature for closing transaction.".to_owned()))?;
3461 self.last_sent_closing_fee = Some((total_fee_satoshis, sig.clone()));
3462 Ok((Some(msgs::ClosingSigned {
3463 channel_id: self.channel_id,
3464 fee_satoshis: total_fee_satoshis,
3466 fee_range: Some(msgs::ClosingSignedFeeRange {
3467 min_fee_satoshis: our_min_fee,
3468 max_fee_satoshis: our_max_fee,
3473 pub fn shutdown<K: Deref>(
3474 &mut self, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3475 ) -> Result<(Option<msgs::Shutdown>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3476 where K::Target: KeysInterface<Signer = Signer>
3478 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3479 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3481 if self.channel_state < ChannelState::FundingSent as u32 {
3482 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3483 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3484 // can do that via error message without getting a connection fail anyway...
3485 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3487 for htlc in self.pending_inbound_htlcs.iter() {
3488 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3489 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3492 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3494 let shutdown_scriptpubkey = match ShutdownScript::try_from((msg.scriptpubkey.clone(), their_features)) {
3495 Ok(script) => script.into_inner(),
3496 Err(_) => return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex()))),
3499 if self.counterparty_shutdown_scriptpubkey.is_some() {
3500 if Some(&shutdown_scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3501 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", shutdown_scriptpubkey.to_bytes().to_hex())));
3504 self.counterparty_shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3507 // If we have any LocalAnnounced updates we'll probably just get back an update_fail_htlc
3508 // immediately after the commitment dance, but we can send a Shutdown because we won't send
3509 // any further commitment updates after we set LocalShutdownSent.
3510 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3512 let update_shutdown_script = match self.shutdown_scriptpubkey {
3515 assert!(send_shutdown);
3516 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3517 if !shutdown_scriptpubkey.is_compatible(their_features) {
3518 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer: {}", shutdown_scriptpubkey)));
3520 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3525 // From here on out, we may not fail!
3527 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3528 self.update_time_counter += 1;
3530 let monitor_update = if update_shutdown_script {
3531 self.latest_monitor_update_id += 1;
3532 Some(ChannelMonitorUpdate {
3533 update_id: self.latest_monitor_update_id,
3534 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3535 scriptpubkey: self.get_closing_scriptpubkey(),
3539 let shutdown = if send_shutdown {
3540 Some(msgs::Shutdown {
3541 channel_id: self.channel_id,
3542 scriptpubkey: self.get_closing_scriptpubkey(),
3546 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3547 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3548 // cell HTLCs and return them to fail the payment.
3549 self.holding_cell_update_fee = None;
3550 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3551 self.holding_cell_htlc_updates.retain(|htlc_update| {
3553 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3554 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3561 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3562 self.update_time_counter += 1;
3564 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
3567 fn build_signed_closing_transaction(&self, closing_tx: &ClosingTransaction, counterparty_sig: &Signature, sig: &Signature) -> Transaction {
3568 let mut tx = closing_tx.trust().built_transaction().clone();
3570 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3572 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3573 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3574 if funding_key[..] < counterparty_funding_key[..] {
3575 tx.input[0].witness.push(sig.serialize_der().to_vec());
3576 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3578 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3579 tx.input[0].witness.push(sig.serialize_der().to_vec());
3581 tx.input[0].witness[1].push(SigHashType::All as u8);
3582 tx.input[0].witness[2].push(SigHashType::All as u8);
3584 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3588 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3589 where F::Target: FeeEstimator
3591 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3592 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3594 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3595 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3597 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3598 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3600 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3601 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3604 if self.is_outbound() && self.last_sent_closing_fee.is_none() {
3605 return Err(ChannelError::Close("Remote tried to send a closing_signed when we were supposed to propose the first one".to_owned()));
3608 if self.channel_state & ChannelState::MonitorUpdateFailed as u32 != 0 {
3609 self.pending_counterparty_closing_signed = Some(msg.clone());
3610 return Ok((None, None));
3613 let funding_redeemscript = self.get_funding_redeemscript();
3614 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3615 if used_total_fee != msg.fee_satoshis {
3616 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)));
3618 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3620 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3623 // The remote end may have decided to revoke their output due to inconsistent dust
3624 // limits, so check for that case by re-checking the signature here.
3625 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3626 let sighash = closing_tx.trust().get_sighash_all(&funding_redeemscript, self.channel_value_satoshis);
3627 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3631 assert!(self.shutdown_scriptpubkey.is_some());
3632 if let Some((last_fee, sig)) = self.last_sent_closing_fee {
3633 if last_fee == msg.fee_satoshis {
3634 let tx = self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3635 self.channel_state = ChannelState::ShutdownComplete as u32;
3636 self.update_time_counter += 1;
3637 return Ok((None, Some(tx)));
3641 let (our_min_fee, our_max_fee) = self.calculate_closing_fee_limits(fee_estimator);
3643 macro_rules! propose_fee {
3644 ($new_fee: expr) => {
3645 let (closing_tx, used_fee) = if $new_fee == msg.fee_satoshis {
3646 (closing_tx, $new_fee)
3648 self.build_closing_transaction($new_fee, false)
3651 let sig = self.holder_signer
3652 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3653 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3655 let signed_tx = if $new_fee == msg.fee_satoshis {
3656 self.channel_state = ChannelState::ShutdownComplete as u32;
3657 self.update_time_counter += 1;
3658 let tx = self.build_signed_closing_transaction(&closing_tx, &msg.signature, &sig);
3662 self.last_sent_closing_fee = Some((used_fee, sig.clone()));
3663 return Ok((Some(msgs::ClosingSigned {
3664 channel_id: self.channel_id,
3665 fee_satoshis: used_fee,
3667 fee_range: Some(msgs::ClosingSignedFeeRange {
3668 min_fee_satoshis: our_min_fee,
3669 max_fee_satoshis: our_max_fee,
3675 if let Some(msgs::ClosingSignedFeeRange { min_fee_satoshis, max_fee_satoshis }) = msg.fee_range {
3676 if msg.fee_satoshis < min_fee_satoshis || msg.fee_satoshis > max_fee_satoshis {
3677 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)));
3679 if max_fee_satoshis < our_min_fee {
3680 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)));
3682 if min_fee_satoshis > our_max_fee {
3683 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)));
3686 if !self.is_outbound() {
3687 // They have to pay, so pick the highest fee in the overlapping range.
3688 // We should never set an upper bound aside from their full balance
3689 debug_assert_eq!(our_max_fee, self.channel_value_satoshis - (self.value_to_self_msat + 999) / 1000);
3690 propose_fee!(cmp::min(max_fee_satoshis, our_max_fee));
3692 if msg.fee_satoshis < our_min_fee || msg.fee_satoshis > our_max_fee {
3693 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.",
3694 msg.fee_satoshis, our_min_fee, our_max_fee)));
3696 // The proposed fee is in our acceptable range, accept it and broadcast!
3697 propose_fee!(msg.fee_satoshis);
3700 // Old fee style negotiation. We don't bother to enforce whether they are complying
3701 // with the "making progress" requirements, we just comply and hope for the best.
3702 if let Some((last_fee, _)) = self.last_sent_closing_fee {
3703 if msg.fee_satoshis > last_fee {
3704 if msg.fee_satoshis < our_max_fee {
3705 propose_fee!(msg.fee_satoshis);
3706 } else if last_fee < our_max_fee {
3707 propose_fee!(our_max_fee);
3709 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)));
3712 if msg.fee_satoshis > our_min_fee {
3713 propose_fee!(msg.fee_satoshis);
3714 } else if last_fee > our_min_fee {
3715 propose_fee!(our_min_fee);
3717 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)));
3721 if msg.fee_satoshis < our_min_fee {
3722 propose_fee!(our_min_fee);
3723 } else if msg.fee_satoshis > our_max_fee {
3724 propose_fee!(our_max_fee);
3726 propose_fee!(msg.fee_satoshis);
3732 // Public utilities:
3734 pub fn channel_id(&self) -> [u8; 32] {
3738 pub fn minimum_depth(&self) -> Option<u32> {
3742 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3743 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3744 pub fn get_user_id(&self) -> u64 {
3748 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3749 /// is_usable() returns true).
3750 /// Allowed in any state (including after shutdown)
3751 pub fn get_short_channel_id(&self) -> Option<u64> {
3752 self.short_channel_id
3755 /// Returns the funding_txo we either got from our peer, or were given by
3756 /// get_outbound_funding_created.
3757 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3758 self.channel_transaction_parameters.funding_outpoint
3761 fn get_holder_selected_contest_delay(&self) -> u16 {
3762 self.channel_transaction_parameters.holder_selected_contest_delay
3765 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3766 &self.channel_transaction_parameters.holder_pubkeys
3769 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3770 self.channel_transaction_parameters.counterparty_parameters
3771 .as_ref().map(|params| params.selected_contest_delay)
3774 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3775 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3778 /// Allowed in any state (including after shutdown)
3779 pub fn get_counterparty_node_id(&self) -> PublicKey {
3780 self.counterparty_node_id
3783 /// Allowed in any state (including after shutdown)
3785 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3786 self.holder_htlc_minimum_msat
3789 /// Allowed in any state (including after shutdown)
3790 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3792 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3793 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3794 // channel might have been used to route very small values (either by honest users or as DoS).
3795 self.channel_value_satoshis * 1000 * 9 / 10,
3797 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3801 /// Allowed in any state (including after shutdown)
3802 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3803 self.counterparty_htlc_minimum_msat
3806 pub fn get_value_satoshis(&self) -> u64 {
3807 self.channel_value_satoshis
3810 pub fn get_fee_proportional_millionths(&self) -> u32 {
3811 self.config.forwarding_fee_proportional_millionths
3814 pub fn get_cltv_expiry_delta(&self) -> u16 {
3815 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3818 pub fn get_max_dust_htlc_exposure_msat(&self) -> u64 {
3819 self.config.max_dust_htlc_exposure_msat
3822 pub fn get_feerate(&self) -> u32 {
3826 pub fn get_dust_buffer_feerate(&self) -> u32 {
3827 // When calculating our exposure to dust HTLCs, we assume that the channel feerate
3828 // may, at any point, increase by at least 10 sat/vB (i.e 2530 sat/kWU) or 25%,
3829 // whichever is higher. This ensures that we aren't suddenly exposed to significantly
3830 // more dust balance if the feerate increases when we have several HTLCs pending
3831 // which are near the dust limit.
3832 let mut feerate_per_kw = self.feerate_per_kw;
3833 // If there's a pending update fee, use it to ensure we aren't under-estimating
3834 // potential feerate updates coming soon.
3835 if let Some((feerate, _)) = self.pending_update_fee {
3836 feerate_per_kw = cmp::max(feerate_per_kw, feerate);
3838 cmp::max(2530, feerate_per_kw * 1250 / 1000)
3841 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3842 self.cur_holder_commitment_transaction_number + 1
3845 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3846 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3849 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3850 self.cur_counterparty_commitment_transaction_number + 2
3854 pub fn get_signer(&self) -> &Signer {
3859 pub fn get_value_stat(&self) -> ChannelValueStat {
3861 value_to_self_msat: self.value_to_self_msat,
3862 channel_value_msat: self.channel_value_satoshis * 1000,
3863 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3864 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3865 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3866 holding_cell_outbound_amount_msat: {
3868 for h in self.holding_cell_htlc_updates.iter() {
3870 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3878 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3879 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3883 /// Allowed in any state (including after shutdown)
3884 pub fn get_update_time_counter(&self) -> u32 {
3885 self.update_time_counter
3888 pub fn get_latest_monitor_update_id(&self) -> u64 {
3889 self.latest_monitor_update_id
3892 pub fn should_announce(&self) -> bool {
3893 self.config.announced_channel
3896 pub fn is_outbound(&self) -> bool {
3897 self.channel_transaction_parameters.is_outbound_from_holder
3900 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3901 /// Allowed in any state (including after shutdown)
3902 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3903 self.config.forwarding_fee_base_msat
3906 /// Returns true if we've ever received a message from the remote end for this Channel
3907 pub fn have_received_message(&self) -> bool {
3908 self.channel_state > (ChannelState::OurInitSent as u32)
3911 /// Returns true if this channel is fully established and not known to be closing.
3912 /// Allowed in any state (including after shutdown)
3913 pub fn is_usable(&self) -> bool {
3914 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3915 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3918 /// Returns true if this channel is currently available for use. This is a superset of
3919 /// is_usable() and considers things like the channel being temporarily disabled.
3920 /// Allowed in any state (including after shutdown)
3921 pub fn is_live(&self) -> bool {
3922 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3925 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3926 /// Allowed in any state (including after shutdown)
3927 pub fn is_awaiting_monitor_update(&self) -> bool {
3928 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3931 /// Returns true if funding_created was sent/received.
3932 pub fn is_funding_initiated(&self) -> bool {
3933 self.channel_state >= ChannelState::FundingSent as u32
3936 /// Returns true if our peer has either initiated or agreed to shut down the channel.
3937 pub fn received_shutdown(&self) -> bool {
3938 (self.channel_state & ChannelState::RemoteShutdownSent as u32) != 0
3941 /// Returns true if we either initiated or agreed to shut down the channel.
3942 pub fn sent_shutdown(&self) -> bool {
3943 (self.channel_state & ChannelState::LocalShutdownSent as u32) != 0
3946 /// Returns true if this channel is fully shut down. True here implies that no further actions
3947 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3948 /// will be handled appropriately by the chain monitor.
3949 pub fn is_shutdown(&self) -> bool {
3950 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3951 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3956 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3957 self.channel_update_status
3960 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3961 self.channel_update_status = status;
3964 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3965 if self.funding_tx_confirmation_height == 0 {
3969 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3970 if funding_tx_confirmations <= 0 {
3971 self.funding_tx_confirmation_height = 0;
3974 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3978 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3979 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3980 self.channel_state |= ChannelState::OurFundingLocked as u32;
3982 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3983 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3984 self.update_time_counter += 1;
3986 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3987 // We got a reorg but not enough to trigger a force close, just ignore.
3989 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3990 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3992 // We got a reorg but not enough to trigger a force close, just ignore.
3996 if need_commitment_update {
3997 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3998 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3999 return Some(msgs::FundingLocked {
4000 channel_id: self.channel_id,
4001 next_per_commitment_point,
4004 self.monitor_pending_funding_locked = true;
4010 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
4011 /// In the first case, we store the confirmation height and calculating the short channel id.
4012 /// In the second, we simply return an Err indicating we need to be force-closed now.
4013 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
4014 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
4015 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4016 for &(index_in_block, tx) in txdata.iter() {
4017 if let Some(funding_txo) = self.get_funding_txo() {
4018 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
4019 // whether they've sent a funding_locked or not), check if we should send one.
4020 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
4021 if tx.txid() == funding_txo.txid {
4022 let txo_idx = funding_txo.index as usize;
4023 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
4024 tx.output[txo_idx].value != self.channel_value_satoshis {
4025 if self.is_outbound() {
4026 // If we generated the funding transaction and it doesn't match what it
4027 // should, the client is really broken and we should just panic and
4028 // tell them off. That said, because hash collisions happen with high
4029 // probability in fuzztarget mode, if we're fuzzing we just close the
4030 // channel and move on.
4031 #[cfg(not(feature = "fuzztarget"))]
4032 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4034 self.update_time_counter += 1;
4035 return Err(msgs::ErrorMessage {
4036 channel_id: self.channel_id(),
4037 data: "funding tx had wrong script/value or output index".to_owned()
4040 if self.is_outbound() {
4041 for input in tx.input.iter() {
4042 if input.witness.is_empty() {
4043 // We generated a malleable funding transaction, implying we've
4044 // just exposed ourselves to funds loss to our counterparty.
4045 #[cfg(not(feature = "fuzztarget"))]
4046 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
4050 self.funding_tx_confirmation_height = height;
4051 self.funding_tx_confirmed_in = Some(*block_hash);
4052 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
4053 Ok(scid) => Some(scid),
4054 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
4058 // If we allow 1-conf funding, we may need to check for funding_locked here and
4059 // send it immediately instead of waiting for a best_block_updated call (which
4060 // may have already happened for this block).
4061 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4062 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4063 return Ok(Some(funding_locked));
4066 for inp in tx.input.iter() {
4067 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
4068 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()));
4069 return Err(msgs::ErrorMessage {
4070 channel_id: self.channel_id(),
4071 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
4080 /// When a new block is connected, we check the height of the block against outbound holding
4081 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
4082 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
4083 /// handled by the ChannelMonitor.
4085 /// If we return Err, the channel may have been closed, at which point the standard
4086 /// requirements apply - no calls may be made except those explicitly stated to be allowed
4089 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
4091 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
4092 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
4093 let mut timed_out_htlcs = Vec::new();
4094 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
4095 self.holding_cell_htlc_updates.retain(|htlc_update| {
4097 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
4098 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
4099 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
4107 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
4109 if let Some(funding_locked) = self.check_get_funding_locked(height) {
4110 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
4111 return Ok((Some(funding_locked), timed_out_htlcs));
4114 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
4115 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
4116 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
4117 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
4118 if self.funding_tx_confirmation_height == 0 {
4119 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
4120 // zero if it has been reorged out, however in either case, our state flags
4121 // indicate we've already sent a funding_locked
4122 funding_tx_confirmations = 0;
4125 // If we've sent funding_locked (or have both sent and received funding_locked), and
4126 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
4127 // close the channel and hope we can get the latest state on chain (because presumably
4128 // the funding transaction is at least still in the mempool of most nodes).
4129 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
4130 return Err(msgs::ErrorMessage {
4131 channel_id: self.channel_id(),
4132 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
4137 Ok((None, timed_out_htlcs))
4140 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
4141 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
4142 /// before the channel has reached funding_locked and we can just wait for more blocks.
4143 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
4144 if self.funding_tx_confirmation_height != 0 {
4145 // We handle the funding disconnection by calling best_block_updated with a height one
4146 // below where our funding was connected, implying a reorg back to conf_height - 1.
4147 let reorg_height = self.funding_tx_confirmation_height - 1;
4148 // We use the time field to bump the current time we set on channel updates if its
4149 // larger. If we don't know that time has moved forward, we can just set it to the last
4150 // time we saw and it will be ignored.
4151 let best_time = self.update_time_counter;
4152 match self.best_block_updated(reorg_height, best_time, logger) {
4153 Ok((funding_locked, timed_out_htlcs)) => {
4154 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
4155 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
4161 // We never learned about the funding confirmation anyway, just ignore
4166 // Methods to get unprompted messages to send to the remote end (or where we already returned
4167 // something in the handler for the message that prompted this message):
4169 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
4170 if !self.is_outbound() {
4171 panic!("Tried to open a channel for an inbound channel?");
4173 if self.channel_state != ChannelState::OurInitSent as u32 {
4174 panic!("Cannot generate an open_channel after we've moved forward");
4177 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4178 panic!("Tried to send an open_channel for a channel that has already advanced");
4181 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4182 let keys = self.get_holder_pubkeys();
4186 temporary_channel_id: self.channel_id,
4187 funding_satoshis: self.channel_value_satoshis,
4188 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
4189 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4190 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4191 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4192 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4193 feerate_per_kw: self.feerate_per_kw as u32,
4194 to_self_delay: self.get_holder_selected_contest_delay(),
4195 max_accepted_htlcs: OUR_MAX_HTLCS,
4196 funding_pubkey: keys.funding_pubkey,
4197 revocation_basepoint: keys.revocation_basepoint,
4198 payment_point: keys.payment_point,
4199 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4200 htlc_basepoint: keys.htlc_basepoint,
4201 first_per_commitment_point,
4202 channel_flags: if self.config.announced_channel {1} else {0},
4203 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4204 Some(script) => script.clone().into_inner(),
4205 None => Builder::new().into_script(),
4210 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
4211 if self.is_outbound() {
4212 panic!("Tried to send accept_channel for an outbound channel?");
4214 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
4215 panic!("Tried to send accept_channel after channel had moved forward");
4217 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4218 panic!("Tried to send an accept_channel for a channel that has already advanced");
4221 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
4222 let keys = self.get_holder_pubkeys();
4224 msgs::AcceptChannel {
4225 temporary_channel_id: self.channel_id,
4226 dust_limit_satoshis: self.holder_dust_limit_satoshis,
4227 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
4228 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
4229 htlc_minimum_msat: self.holder_htlc_minimum_msat,
4230 minimum_depth: self.minimum_depth.unwrap(),
4231 to_self_delay: self.get_holder_selected_contest_delay(),
4232 max_accepted_htlcs: OUR_MAX_HTLCS,
4233 funding_pubkey: keys.funding_pubkey,
4234 revocation_basepoint: keys.revocation_basepoint,
4235 payment_point: keys.payment_point,
4236 delayed_payment_basepoint: keys.delayed_payment_basepoint,
4237 htlc_basepoint: keys.htlc_basepoint,
4238 first_per_commitment_point,
4239 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
4240 Some(script) => script.clone().into_inner(),
4241 None => Builder::new().into_script(),
4246 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
4247 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
4248 let counterparty_keys = self.build_remote_transaction_keys()?;
4249 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, logger).0;
4250 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
4251 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
4254 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
4255 /// a funding_created message for the remote peer.
4256 /// Panics if called at some time other than immediately after initial handshake, if called twice,
4257 /// or if called on an inbound channel.
4258 /// Note that channel_id changes during this call!
4259 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
4260 /// If an Err is returned, it is a ChannelError::Close.
4261 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 {
4262 if !self.is_outbound() {
4263 panic!("Tried to create outbound funding_created message on an inbound channel!");
4265 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
4266 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)");
4268 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
4269 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
4270 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
4271 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
4274 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
4275 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
4277 let signature = match self.get_outbound_funding_created_signature(logger) {
4280 log_error!(logger, "Got bad signatures: {:?}!", e);
4281 self.channel_transaction_parameters.funding_outpoint = None;
4286 let temporary_channel_id = self.channel_id;
4288 // Now that we're past error-generating stuff, update our local state:
4290 self.channel_state = ChannelState::FundingCreated as u32;
4291 self.channel_id = funding_txo.to_channel_id();
4292 self.funding_transaction = Some(funding_transaction);
4294 Ok(msgs::FundingCreated {
4295 temporary_channel_id,
4296 funding_txid: funding_txo.txid,
4297 funding_output_index: funding_txo.index,
4302 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4303 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4304 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4305 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4306 /// Will only fail if we're not in a state where channel_announcement may be sent (including
4308 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4309 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4311 /// This will only return ChannelError::Ignore upon failure.
4312 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4313 if !self.config.announced_channel {
4314 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4316 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4317 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4319 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4320 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4323 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4325 let msg = msgs::UnsignedChannelAnnouncement {
4326 features: ChannelFeatures::known(),
4328 short_channel_id: self.get_short_channel_id().unwrap(),
4329 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4330 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4331 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4332 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4333 excess_data: Vec::new(),
4336 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4337 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4342 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4344 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> {
4345 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4346 let were_node_one = announcement.node_id_1 == our_node_id;
4348 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4349 Ok(msgs::ChannelAnnouncement {
4350 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4351 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4352 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4353 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4354 contents: announcement,
4357 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4361 /// Processes an incoming announcement_signatures message, providing a fully-signed
4362 /// channel_announcement message which we can broadcast and storing our counterparty's
4363 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4364 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4365 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4367 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4369 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4370 return Err(ChannelError::Close(format!(
4371 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4372 &announcement, self.get_counterparty_node_id())));
4374 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4375 return Err(ChannelError::Close(format!(
4376 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4377 &announcement, self.counterparty_funding_pubkey())));
4380 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4382 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4385 /// Gets a signed channel_announcement for this channel, if we previously received an
4386 /// announcement_signatures from our counterparty.
4387 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4388 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4390 Err(_) => return None,
4392 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4393 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4394 Ok(res) => Some(res),
4399 /// May panic if called on a channel that wasn't immediately-previously
4400 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4401 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4402 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4403 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4404 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4405 // current to_remote balances. However, it no longer has any use, and thus is now simply
4406 // set to a dummy (but valid, as required by the spec) public key.
4407 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4408 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4409 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4410 let mut pk = [2; 33]; pk[1] = 0xff;
4411 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4412 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4413 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4414 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()));
4415 OptionalField::Present(DataLossProtect {
4416 your_last_per_commitment_secret: remote_last_secret,
4417 my_current_per_commitment_point: dummy_pubkey
4420 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4421 OptionalField::Present(DataLossProtect {
4422 your_last_per_commitment_secret: [0;32],
4423 my_current_per_commitment_point: dummy_pubkey,
4426 msgs::ChannelReestablish {
4427 channel_id: self.channel_id(),
4428 // The protocol has two different commitment number concepts - the "commitment
4429 // transaction number", which starts from 0 and counts up, and the "revocation key
4430 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4431 // commitment transaction numbers by the index which will be used to reveal the
4432 // revocation key for that commitment transaction, which means we have to convert them
4433 // to protocol-level commitment numbers here...
4435 // next_local_commitment_number is the next commitment_signed number we expect to
4436 // receive (indicating if they need to resend one that we missed).
4437 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4438 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4439 // receive, however we track it by the next commitment number for a remote transaction
4440 // (which is one further, as they always revoke previous commitment transaction, not
4441 // the one we send) so we have to decrement by 1. Note that if
4442 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4443 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4445 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4451 // Send stuff to our remote peers:
4453 /// Adds a pending outbound HTLC to this channel, note that you probably want
4454 /// send_htlc_and_commit instead cause you'll want both messages at once.
4456 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4458 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4459 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4461 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4462 /// may not yet have sent the previous commitment update messages and will need to regenerate
4465 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4467 /// If an Err is returned, it's a ChannelError::Ignore!
4468 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> {
4469 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4470 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4472 let channel_total_msat = self.channel_value_satoshis * 1000;
4473 if amount_msat > channel_total_msat {
4474 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4477 if amount_msat == 0 {
4478 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4481 if amount_msat < self.counterparty_htlc_minimum_msat {
4482 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4485 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4486 // Note that this should never really happen, if we're !is_live() on receipt of an
4487 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4488 // the user to send directly into a !is_live() channel. However, if we
4489 // disconnected during the time the previous hop was doing the commitment dance we may
4490 // end up getting here after the forwarding delay. In any case, returning an
4491 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4492 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4495 let inbound_stats = self.get_inbound_pending_htlc_stats();
4496 let outbound_stats = self.get_outbound_pending_htlc_stats();
4497 if outbound_stats.pending_htlcs + 1 > self.counterparty_max_accepted_htlcs as u32 {
4498 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4500 // Check their_max_htlc_value_in_flight_msat
4501 if outbound_stats.pending_htlcs_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4502 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)));
4505 if !self.is_outbound() {
4506 // Check that we won't violate the remote channel reserve by adding this HTLC.
4507 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4508 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4509 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4510 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4511 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4512 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4516 let exposure_dust_limit_success_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
4517 if amount_msat / 1000 < exposure_dust_limit_success_sats {
4518 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;
4519 if on_counterparty_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4520 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on counterparty commitment tx",
4521 on_counterparty_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4525 let exposure_dust_limit_timeout_sats = (self.get_dust_buffer_feerate() as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
4526 if amount_msat / 1000 < exposure_dust_limit_timeout_sats {
4527 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;
4528 if on_holder_dust_htlc_exposure_msat > self.get_max_dust_htlc_exposure_msat() {
4529 return Err(ChannelError::Ignore(format!("Cannot send value that would put our exposure to dust HTLCs at {} over the limit {} on holder commitment tx",
4530 on_holder_dust_htlc_exposure_msat, self.get_max_dust_htlc_exposure_msat())));
4534 let pending_value_to_self_msat = self.value_to_self_msat - outbound_stats.pending_htlcs_value_msat;
4535 if pending_value_to_self_msat < amount_msat {
4536 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)));
4539 // `2 *` and extra HTLC are for the fee spike buffer.
4540 let commit_tx_fee_msat = if self.is_outbound() {
4541 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4542 FEE_SPIKE_BUFFER_FEE_INCREASE_MULTIPLE * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4544 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4545 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)));
4548 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4549 // reserve for the remote to have something to claim if we misbehave)
4550 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4551 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4552 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4555 // Now update local state:
4556 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4557 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4562 onion_routing_packet,
4567 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4568 htlc_id: self.next_holder_htlc_id,
4570 payment_hash: payment_hash.clone(),
4572 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4576 let res = msgs::UpdateAddHTLC {
4577 channel_id: self.channel_id,
4578 htlc_id: self.next_holder_htlc_id,
4582 onion_routing_packet,
4584 self.next_holder_htlc_id += 1;
4589 /// Creates a signed commitment transaction to send to the remote peer.
4590 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4591 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4592 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4593 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4594 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4595 panic!("Cannot create commitment tx until channel is fully established");
4597 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4598 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4600 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4601 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4603 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4604 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");
4606 let mut have_updates = self.is_outbound() && self.pending_update_fee.is_some();
4607 for htlc in self.pending_outbound_htlcs.iter() {
4608 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4609 have_updates = true;
4611 if have_updates { break; }
4613 for htlc in self.pending_inbound_htlcs.iter() {
4614 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4615 have_updates = true;
4617 if have_updates { break; }
4620 panic!("Cannot create commitment tx until we have some updates to send");
4622 self.send_commitment_no_status_check(logger)
4624 /// Only fails in case of bad keys
4625 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4626 log_trace!(logger, "Updating HTLC state for a newly-sent commitment_signed...");
4627 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4628 // fail to generate this, we still are at least at a position where upgrading their status
4630 for htlc in self.pending_inbound_htlcs.iter_mut() {
4631 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4632 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4634 if let Some(state) = new_state {
4635 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4639 for htlc in self.pending_outbound_htlcs.iter_mut() {
4640 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4641 Some(fail_reason.take())
4643 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
4644 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4647 if let Some((feerate, update_state)) = self.pending_update_fee {
4648 if update_state == FeeUpdateState::AwaitingRemoteRevokeToAnnounce {
4649 debug_assert!(!self.is_outbound());
4650 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce fee update {} to Committed", feerate);
4651 self.feerate_per_kw = feerate;
4652 self.pending_update_fee = None;
4655 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4657 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4658 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4659 // Update state now that we've passed all the can-fail calls...
4660 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4661 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4662 (res, counterparty_commitment_tx, htlcs_no_ref)
4664 Err(e) => return Err(e),
4667 self.latest_monitor_update_id += 1;
4668 let monitor_update = ChannelMonitorUpdate {
4669 update_id: self.latest_monitor_update_id,
4670 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4671 commitment_txid: counterparty_commitment_txid,
4672 htlc_outputs: htlcs.clone(),
4673 commitment_number: self.cur_counterparty_commitment_transaction_number,
4674 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4677 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4678 Ok((res, monitor_update))
4681 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4682 /// when we shouldn't change HTLC/channel state.
4683 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4684 let counterparty_keys = self.build_remote_transaction_keys()?;
4685 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, logger);
4686 let feerate_per_kw = counterparty_commitment_tx.1;
4687 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4688 let (signature, htlc_signatures);
4690 #[cfg(any(test, feature = "fuzztarget"))]
4692 if !self.is_outbound() {
4693 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4694 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4695 if let Some(info) = projected_commit_tx_info {
4696 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4697 if info.total_pending_htlcs == total_pending_htlcs
4698 && info.next_holder_htlc_id == self.next_holder_htlc_id
4699 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4700 && info.feerate == self.feerate_per_kw {
4701 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.2);
4702 assert_eq!(actual_fee, info.fee);
4709 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.3.len());
4710 for &(ref htlc, _) in counterparty_commitment_tx.3.iter() {
4714 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4715 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4717 htlc_signatures = res.1;
4719 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4720 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4721 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4722 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4724 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4725 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4726 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)),
4727 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4728 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4729 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4733 Ok((msgs::CommitmentSigned {
4734 channel_id: self.channel_id,
4737 }, (counterparty_commitment_txid, counterparty_commitment_tx.3)))
4740 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4741 /// to send to the remote peer in one go.
4742 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4744 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 {
4745 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4746 Some(update_add_htlc) => {
4747 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4748 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4754 /// Get forwarding information for the counterparty.
4755 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4756 self.counterparty_forwarding_info.clone()
4759 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4760 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4761 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4763 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4764 fee_base_msat: msg.contents.fee_base_msat,
4765 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4766 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4772 /// Begins the shutdown process, getting a message for the remote peer and returning all
4773 /// holding cell HTLCs for payment failure.
4774 pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K, their_features: &InitFeatures, target_feerate_sats_per_kw: Option<u32>)
4775 -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
4776 where K::Target: KeysInterface<Signer = Signer> {
4777 for htlc in self.pending_outbound_htlcs.iter() {
4778 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4779 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4782 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4783 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4784 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4786 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4787 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4790 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4791 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4792 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()});
4795 let update_shutdown_script = match self.shutdown_scriptpubkey {
4798 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
4799 if !shutdown_scriptpubkey.is_compatible(their_features) {
4800 return Err(APIError::IncompatibleShutdownScript { script: shutdown_scriptpubkey.clone() });
4802 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
4807 // From here on out, we may not fail!
4808 self.target_closing_feerate_sats_per_kw = target_feerate_sats_per_kw;
4809 if self.channel_state < ChannelState::FundingSent as u32 {
4810 self.channel_state = ChannelState::ShutdownComplete as u32;
4812 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4814 self.update_time_counter += 1;
4816 let monitor_update = if update_shutdown_script {
4817 self.latest_monitor_update_id += 1;
4818 Some(ChannelMonitorUpdate {
4819 update_id: self.latest_monitor_update_id,
4820 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4821 scriptpubkey: self.get_closing_scriptpubkey(),
4825 let shutdown = msgs::Shutdown {
4826 channel_id: self.channel_id,
4827 scriptpubkey: self.get_closing_scriptpubkey(),
4830 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4831 // our shutdown until we've committed all of the pending changes.
4832 self.holding_cell_update_fee = None;
4833 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4834 self.holding_cell_htlc_updates.retain(|htlc_update| {
4836 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4837 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4844 Ok((shutdown, monitor_update, dropped_outbound_htlcs))
4847 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4848 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4849 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4850 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4851 /// immediately (others we will have to allow to time out).
4852 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4853 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4854 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4855 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4856 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4857 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4859 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4860 // return them to fail the payment.
4861 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4862 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4864 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4865 dropped_outbound_htlcs.push((source, payment_hash));
4870 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4871 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4872 // returning a channel monitor update here would imply a channel monitor update before
4873 // we even registered the channel monitor to begin with, which is invalid.
4874 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4875 // funding transaction, don't return a funding txo (which prevents providing the
4876 // monitor update to the user, even if we return one).
4877 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4878 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4879 self.latest_monitor_update_id += 1;
4880 Some((funding_txo, ChannelMonitorUpdate {
4881 update_id: self.latest_monitor_update_id,
4882 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4887 self.channel_state = ChannelState::ShutdownComplete as u32;
4888 self.update_time_counter += 1;
4889 (monitor_update, dropped_outbound_htlcs)
4893 const SERIALIZATION_VERSION: u8 = 2;
4894 const MIN_SERIALIZATION_VERSION: u8 = 1;
4896 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4902 impl Writeable for ChannelUpdateStatus {
4903 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4904 // We only care about writing out the current state as it was announced, ie only either
4905 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4906 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4908 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4909 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4910 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4911 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4917 impl Readable for ChannelUpdateStatus {
4918 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4919 Ok(match <u8 as Readable>::read(reader)? {
4920 0 => ChannelUpdateStatus::Enabled,
4921 1 => ChannelUpdateStatus::Disabled,
4922 _ => return Err(DecodeError::InvalidValue),
4927 impl<Signer: Sign> Writeable for Channel<Signer> {
4928 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4929 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4932 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4934 self.user_id.write(writer)?;
4936 // Write out the old serialization for the config object. This is read by version-1
4937 // deserializers, but we will read the version in the TLV at the end instead.
4938 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4939 self.config.cltv_expiry_delta.write(writer)?;
4940 self.config.announced_channel.write(writer)?;
4941 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4943 self.channel_id.write(writer)?;
4944 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4945 self.channel_value_satoshis.write(writer)?;
4947 self.latest_monitor_update_id.write(writer)?;
4949 let mut key_data = VecWriter(Vec::new());
4950 self.holder_signer.write(&mut key_data)?;
4951 assert!(key_data.0.len() < core::usize::MAX);
4952 assert!(key_data.0.len() < core::u32::MAX as usize);
4953 (key_data.0.len() as u32).write(writer)?;
4954 writer.write_all(&key_data.0[..])?;
4956 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4957 // deserialized from that format.
4958 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4959 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4960 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4962 self.destination_script.write(writer)?;
4964 self.cur_holder_commitment_transaction_number.write(writer)?;
4965 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4966 self.value_to_self_msat.write(writer)?;
4968 let mut dropped_inbound_htlcs = 0;
4969 for htlc in self.pending_inbound_htlcs.iter() {
4970 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4971 dropped_inbound_htlcs += 1;
4974 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4975 for htlc in self.pending_inbound_htlcs.iter() {
4976 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4979 htlc.htlc_id.write(writer)?;
4980 htlc.amount_msat.write(writer)?;
4981 htlc.cltv_expiry.write(writer)?;
4982 htlc.payment_hash.write(writer)?;
4984 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4985 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4987 htlc_state.write(writer)?;
4989 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4991 htlc_state.write(writer)?;
4993 &InboundHTLCState::Committed => {
4996 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4998 removal_reason.write(writer)?;
5003 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
5004 for htlc in self.pending_outbound_htlcs.iter() {
5005 htlc.htlc_id.write(writer)?;
5006 htlc.amount_msat.write(writer)?;
5007 htlc.cltv_expiry.write(writer)?;
5008 htlc.payment_hash.write(writer)?;
5009 htlc.source.write(writer)?;
5011 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
5013 onion_packet.write(writer)?;
5015 &OutboundHTLCState::Committed => {
5018 &OutboundHTLCState::RemoteRemoved(_) => {
5019 // Treat this as a Committed because we haven't received the CS - they'll
5020 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
5023 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
5025 fail_reason.write(writer)?;
5027 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
5029 fail_reason.write(writer)?;
5034 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
5035 for update in self.holding_cell_htlc_updates.iter() {
5037 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
5039 amount_msat.write(writer)?;
5040 cltv_expiry.write(writer)?;
5041 payment_hash.write(writer)?;
5042 source.write(writer)?;
5043 onion_routing_packet.write(writer)?;
5045 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
5047 payment_preimage.write(writer)?;
5048 htlc_id.write(writer)?;
5050 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
5052 htlc_id.write(writer)?;
5053 err_packet.write(writer)?;
5058 match self.resend_order {
5059 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
5060 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
5063 self.monitor_pending_funding_locked.write(writer)?;
5064 self.monitor_pending_revoke_and_ack.write(writer)?;
5065 self.monitor_pending_commitment_signed.write(writer)?;
5067 (self.monitor_pending_forwards.len() as u64).write(writer)?;
5068 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
5069 pending_forward.write(writer)?;
5070 htlc_id.write(writer)?;
5073 (self.monitor_pending_failures.len() as u64).write(writer)?;
5074 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
5075 htlc_source.write(writer)?;
5076 payment_hash.write(writer)?;
5077 fail_reason.write(writer)?;
5080 if self.is_outbound() {
5081 self.pending_update_fee.map(|(a, _)| a).write(writer)?;
5082 } else if let Some((feerate, FeeUpdateState::AwaitingRemoteRevokeToAnnounce)) = self.pending_update_fee {
5083 Some(feerate).write(writer)?;
5085 // As for inbound HTLCs, if the update was only announced and never committed in a
5086 // commitment_signed, drop it.
5087 None::<u32>.write(writer)?;
5089 self.holding_cell_update_fee.write(writer)?;
5091 self.next_holder_htlc_id.write(writer)?;
5092 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
5093 self.update_time_counter.write(writer)?;
5094 self.feerate_per_kw.write(writer)?;
5096 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5097 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5098 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5099 // consider the stale state on reload.
5102 self.funding_tx_confirmed_in.write(writer)?;
5103 self.funding_tx_confirmation_height.write(writer)?;
5104 self.short_channel_id.write(writer)?;
5106 self.counterparty_dust_limit_satoshis.write(writer)?;
5107 self.holder_dust_limit_satoshis.write(writer)?;
5108 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
5110 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5111 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
5113 self.counterparty_htlc_minimum_msat.write(writer)?;
5114 self.holder_htlc_minimum_msat.write(writer)?;
5115 self.counterparty_max_accepted_htlcs.write(writer)?;
5117 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
5118 self.minimum_depth.unwrap_or(0).write(writer)?;
5120 match &self.counterparty_forwarding_info {
5123 info.fee_base_msat.write(writer)?;
5124 info.fee_proportional_millionths.write(writer)?;
5125 info.cltv_expiry_delta.write(writer)?;
5127 None => 0u8.write(writer)?
5130 self.channel_transaction_parameters.write(writer)?;
5131 self.funding_transaction.write(writer)?;
5133 self.counterparty_cur_commitment_point.write(writer)?;
5134 self.counterparty_prev_commitment_point.write(writer)?;
5135 self.counterparty_node_id.write(writer)?;
5137 self.counterparty_shutdown_scriptpubkey.write(writer)?;
5139 self.commitment_secrets.write(writer)?;
5141 self.channel_update_status.write(writer)?;
5143 #[cfg(any(test, feature = "fuzztarget"))]
5144 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
5145 #[cfg(any(test, feature = "fuzztarget"))]
5146 for htlc in self.historical_inbound_htlc_fulfills.iter() {
5147 htlc.write(writer)?;
5150 write_tlv_fields!(writer, {
5151 (0, self.announcement_sigs, option),
5152 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
5153 // default value instead of being Option<>al. Thus, to maintain compatibility we write
5154 // them twice, once with their original default values above, and once as an option
5155 // here. On the read side, old versions will simply ignore the odd-type entries here,
5156 // and new versions map the default values to None and allow the TLV entries here to
5158 (1, self.minimum_depth, option),
5159 (3, self.counterparty_selected_channel_reserve_satoshis, option),
5160 (5, self.config, required),
5161 (7, self.shutdown_scriptpubkey, option),
5162 (9, self.target_closing_feerate_sats_per_kw, option),
5169 const MAX_ALLOC_SIZE: usize = 64*1024;
5170 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
5171 where K::Target: KeysInterface<Signer = Signer> {
5172 fn read<R : io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
5173 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5175 let user_id = Readable::read(reader)?;
5177 let mut config = Some(ChannelConfig::default());
5179 // Read the old serialization of the ChannelConfig from version 0.0.98.
5180 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
5181 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
5182 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
5183 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
5185 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
5186 let mut _val: u64 = Readable::read(reader)?;
5189 let channel_id = Readable::read(reader)?;
5190 let channel_state = Readable::read(reader)?;
5191 let channel_value_satoshis = Readable::read(reader)?;
5193 let latest_monitor_update_id = Readable::read(reader)?;
5195 let keys_len: u32 = Readable::read(reader)?;
5196 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
5197 while keys_data.len() != keys_len as usize {
5198 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
5199 let mut data = [0; 1024];
5200 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
5201 reader.read_exact(read_slice)?;
5202 keys_data.extend_from_slice(read_slice);
5204 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
5206 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
5207 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
5208 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
5211 let destination_script = Readable::read(reader)?;
5213 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
5214 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
5215 let value_to_self_msat = Readable::read(reader)?;
5217 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
5218 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5219 for _ in 0..pending_inbound_htlc_count {
5220 pending_inbound_htlcs.push(InboundHTLCOutput {
5221 htlc_id: Readable::read(reader)?,
5222 amount_msat: Readable::read(reader)?,
5223 cltv_expiry: Readable::read(reader)?,
5224 payment_hash: Readable::read(reader)?,
5225 state: match <u8 as Readable>::read(reader)? {
5226 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
5227 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
5228 3 => InboundHTLCState::Committed,
5229 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
5230 _ => return Err(DecodeError::InvalidValue),
5235 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
5236 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
5237 for _ in 0..pending_outbound_htlc_count {
5238 pending_outbound_htlcs.push(OutboundHTLCOutput {
5239 htlc_id: Readable::read(reader)?,
5240 amount_msat: Readable::read(reader)?,
5241 cltv_expiry: Readable::read(reader)?,
5242 payment_hash: Readable::read(reader)?,
5243 source: Readable::read(reader)?,
5244 state: match <u8 as Readable>::read(reader)? {
5245 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
5246 1 => OutboundHTLCState::Committed,
5247 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
5248 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
5249 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
5250 _ => return Err(DecodeError::InvalidValue),
5255 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
5256 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
5257 for _ in 0..holding_cell_htlc_update_count {
5258 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
5259 0 => HTLCUpdateAwaitingACK::AddHTLC {
5260 amount_msat: Readable::read(reader)?,
5261 cltv_expiry: Readable::read(reader)?,
5262 payment_hash: Readable::read(reader)?,
5263 source: Readable::read(reader)?,
5264 onion_routing_packet: Readable::read(reader)?,
5266 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
5267 payment_preimage: Readable::read(reader)?,
5268 htlc_id: Readable::read(reader)?,
5270 2 => HTLCUpdateAwaitingACK::FailHTLC {
5271 htlc_id: Readable::read(reader)?,
5272 err_packet: Readable::read(reader)?,
5274 _ => return Err(DecodeError::InvalidValue),
5278 let resend_order = match <u8 as Readable>::read(reader)? {
5279 0 => RAACommitmentOrder::CommitmentFirst,
5280 1 => RAACommitmentOrder::RevokeAndACKFirst,
5281 _ => return Err(DecodeError::InvalidValue),
5284 let monitor_pending_funding_locked = Readable::read(reader)?;
5285 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
5286 let monitor_pending_commitment_signed = Readable::read(reader)?;
5288 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
5289 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
5290 for _ in 0..monitor_pending_forwards_count {
5291 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
5294 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
5295 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
5296 for _ in 0..monitor_pending_failures_count {
5297 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
5300 let pending_update_fee_value: Option<u32> = Readable::read(reader)?;
5302 let holding_cell_update_fee = Readable::read(reader)?;
5304 let next_holder_htlc_id = Readable::read(reader)?;
5305 let next_counterparty_htlc_id = Readable::read(reader)?;
5306 let update_time_counter = Readable::read(reader)?;
5307 let feerate_per_kw = Readable::read(reader)?;
5309 // Versions prior to 0.0.100 expected to read the fields of `last_sent_closing_fee` here,
5310 // however we are supposed to restart shutdown fee negotiation on reconnect (and wipe
5311 // `last_send_closing_fee` in `remove_uncommitted_htlcs_and_mark_paused`) so we should never
5312 // consider the stale state on reload.
5313 match <u8 as Readable>::read(reader)? {
5316 let _: u32 = Readable::read(reader)?;
5317 let _: u64 = Readable::read(reader)?;
5318 let _: Signature = Readable::read(reader)?;
5320 _ => return Err(DecodeError::InvalidValue),
5323 let funding_tx_confirmed_in = Readable::read(reader)?;
5324 let funding_tx_confirmation_height = Readable::read(reader)?;
5325 let short_channel_id = Readable::read(reader)?;
5327 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
5328 let holder_dust_limit_satoshis = Readable::read(reader)?;
5329 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
5330 let mut counterparty_selected_channel_reserve_satoshis = None;
5332 // Read the old serialization from version 0.0.98.
5333 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
5335 // Read the 8 bytes of backwards-compatibility data.
5336 let _dummy: u64 = Readable::read(reader)?;
5338 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
5339 let holder_htlc_minimum_msat = Readable::read(reader)?;
5340 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
5342 let mut minimum_depth = None;
5344 // Read the old serialization from version 0.0.98.
5345 minimum_depth = Some(Readable::read(reader)?);
5347 // Read the 4 bytes of backwards-compatibility data.
5348 let _dummy: u32 = Readable::read(reader)?;
5351 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5353 1 => Some(CounterpartyForwardingInfo {
5354 fee_base_msat: Readable::read(reader)?,
5355 fee_proportional_millionths: Readable::read(reader)?,
5356 cltv_expiry_delta: Readable::read(reader)?,
5358 _ => return Err(DecodeError::InvalidValue),
5361 let channel_parameters: ChannelTransactionParameters = Readable::read(reader)?;
5362 let funding_transaction = Readable::read(reader)?;
5364 let counterparty_cur_commitment_point = Readable::read(reader)?;
5366 let counterparty_prev_commitment_point = Readable::read(reader)?;
5367 let counterparty_node_id = Readable::read(reader)?;
5369 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5370 let commitment_secrets = Readable::read(reader)?;
5372 let channel_update_status = Readable::read(reader)?;
5374 #[cfg(any(test, feature = "fuzztarget"))]
5375 let mut historical_inbound_htlc_fulfills = HashSet::new();
5376 #[cfg(any(test, feature = "fuzztarget"))]
5378 let htlc_fulfills_len: u64 = Readable::read(reader)?;
5379 for _ in 0..htlc_fulfills_len {
5380 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5384 let pending_update_fee = if let Some(feerate) = pending_update_fee_value {
5385 Some((feerate, if channel_parameters.is_outbound_from_holder {
5386 FeeUpdateState::Outbound
5388 FeeUpdateState::AwaitingRemoteRevokeToAnnounce
5394 let mut announcement_sigs = None;
5395 let mut target_closing_feerate_sats_per_kw = None;
5396 read_tlv_fields!(reader, {
5397 (0, announcement_sigs, option),
5398 (1, minimum_depth, option),
5399 (3, counterparty_selected_channel_reserve_satoshis, option),
5400 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5401 (7, shutdown_scriptpubkey, option),
5402 (9, target_closing_feerate_sats_per_kw, option),
5405 let mut secp_ctx = Secp256k1::new();
5406 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5411 config: config.unwrap(),
5415 channel_value_satoshis,
5417 latest_monitor_update_id,
5420 shutdown_scriptpubkey,
5423 cur_holder_commitment_transaction_number,
5424 cur_counterparty_commitment_transaction_number,
5427 pending_inbound_htlcs,
5428 pending_outbound_htlcs,
5429 holding_cell_htlc_updates,
5433 monitor_pending_funding_locked,
5434 monitor_pending_revoke_and_ack,
5435 monitor_pending_commitment_signed,
5436 monitor_pending_forwards,
5437 monitor_pending_failures,
5440 holding_cell_update_fee,
5441 next_holder_htlc_id,
5442 next_counterparty_htlc_id,
5443 update_time_counter,
5446 #[cfg(debug_assertions)]
5447 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5448 #[cfg(debug_assertions)]
5449 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5451 last_sent_closing_fee: None,
5452 pending_counterparty_closing_signed: None,
5453 closing_fee_limits: None,
5454 target_closing_feerate_sats_per_kw,
5456 funding_tx_confirmed_in,
5457 funding_tx_confirmation_height,
5460 counterparty_dust_limit_satoshis,
5461 holder_dust_limit_satoshis,
5462 counterparty_max_htlc_value_in_flight_msat,
5463 counterparty_selected_channel_reserve_satoshis,
5464 counterparty_htlc_minimum_msat,
5465 holder_htlc_minimum_msat,
5466 counterparty_max_accepted_htlcs,
5469 counterparty_forwarding_info,
5471 channel_transaction_parameters: channel_parameters,
5472 funding_transaction,
5474 counterparty_cur_commitment_point,
5475 counterparty_prev_commitment_point,
5476 counterparty_node_id,
5478 counterparty_shutdown_scriptpubkey,
5482 channel_update_status,
5483 closing_signed_in_flight: false,
5487 #[cfg(any(test, feature = "fuzztarget"))]
5488 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5489 #[cfg(any(test, feature = "fuzztarget"))]
5490 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5492 workaround_lnd_bug_4006: None,
5494 #[cfg(any(test, feature = "fuzztarget"))]
5495 historical_inbound_htlc_fulfills,
5502 use bitcoin::util::bip143;
5503 use bitcoin::consensus::encode::serialize;
5504 use bitcoin::blockdata::script::{Script, Builder};
5505 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5506 use bitcoin::blockdata::constants::genesis_block;
5507 use bitcoin::blockdata::opcodes;
5508 use bitcoin::network::constants::Network;
5509 use bitcoin::hashes::hex::FromHex;
5511 use ln::{PaymentPreimage, PaymentHash};
5512 use ln::channelmanager::HTLCSource;
5513 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5514 use ln::channel::MAX_FUNDING_SATOSHIS;
5515 use ln::features::InitFeatures;
5516 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5517 use ln::script::ShutdownScript;
5519 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5520 use chain::BestBlock;
5521 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5522 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5523 use chain::transaction::OutPoint;
5524 use util::config::UserConfig;
5525 use util::enforcing_trait_impls::EnforcingSigner;
5526 use util::errors::APIError;
5527 use util::test_utils;
5528 use util::test_utils::OnGetShutdownScriptpubkey;
5529 use util::logger::Logger;
5530 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5531 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5532 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5533 use bitcoin::secp256k1::recovery::RecoverableSignature;
5534 use bitcoin::hashes::sha256::Hash as Sha256;
5535 use bitcoin::hashes::Hash;
5536 use bitcoin::hash_types::{Txid, WPubkeyHash};
5537 use core::num::NonZeroU8;
5541 struct TestFeeEstimator {
5544 impl FeeEstimator for TestFeeEstimator {
5545 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5551 fn test_max_funding_satoshis() {
5552 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5553 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5557 signer: InMemorySigner,
5559 impl KeysInterface for Keys {
5560 type Signer = InMemorySigner;
5562 fn get_node_secret(&self) -> SecretKey { panic!(); }
5563 fn get_destination_script(&self) -> Script {
5564 let secp_ctx = Secp256k1::signing_only();
5565 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5566 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5567 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5570 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5571 let secp_ctx = Secp256k1::signing_only();
5572 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5573 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5576 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5579 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5580 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5581 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5584 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5585 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5589 fn upfront_shutdown_script_incompatibility() {
5590 let features = InitFeatures::known().clear_shutdown_anysegwit();
5591 let non_v0_segwit_shutdown_script =
5592 ShutdownScript::new_witness_program(NonZeroU8::new(16).unwrap(), &[0, 40]).unwrap();
5594 let seed = [42; 32];
5595 let network = Network::Testnet;
5596 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5597 keys_provider.expect(OnGetShutdownScriptpubkey {
5598 returns: non_v0_segwit_shutdown_script.clone(),
5601 let fee_estimator = TestFeeEstimator { fee_est: 253 };
5602 let secp_ctx = Secp256k1::new();
5603 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5604 let config = UserConfig::default();
5605 match Channel::<EnforcingSigner>::new_outbound(&&fee_estimator, &&keys_provider, node_id, &features, 10000000, 100000, 42, &config) {
5606 Err(APIError::IncompatibleShutdownScript { script }) => {
5607 assert_eq!(script.into_inner(), non_v0_segwit_shutdown_script.into_inner());
5609 Err(e) => panic!("Unexpected error: {:?}", e),
5610 Ok(_) => panic!("Expected error"),
5614 // Check that, during channel creation, we use the same feerate in the open channel message
5615 // as we do in the Channel object creation itself.
5617 fn test_open_channel_msg_fee() {
5618 let original_fee = 253;
5619 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5620 let secp_ctx = Secp256k1::new();
5621 let seed = [42; 32];
5622 let network = Network::Testnet;
5623 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5625 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5626 let config = UserConfig::default();
5627 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5629 // Now change the fee so we can check that the fee in the open_channel message is the
5630 // same as the old fee.
5631 fee_est.fee_est = 500;
5632 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5633 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5637 fn test_holder_vs_counterparty_dust_limit() {
5638 // Test that when calculating the local and remote commitment transaction fees, the correct
5639 // dust limits are used.
5640 let feeest = TestFeeEstimator{fee_est: 15000};
5641 let secp_ctx = Secp256k1::new();
5642 let seed = [42; 32];
5643 let network = Network::Testnet;
5644 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5646 // Go through the flow of opening a channel between two nodes, making sure
5647 // they have different dust limits.
5649 // Create Node A's channel pointing to Node B's pubkey
5650 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5651 let config = UserConfig::default();
5652 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5654 // Create Node B's channel by receiving Node A's open_channel message
5655 // Make sure A's dust limit is as we expect.
5656 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5657 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5658 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5660 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5661 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5662 accept_channel_msg.dust_limit_satoshis = 546;
5663 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5664 node_a_chan.holder_dust_limit_satoshis = 1560;
5666 // Put some inbound and outbound HTLCs in A's channel.
5667 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5668 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5670 amount_msat: htlc_amount_msat,
5671 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5672 cltv_expiry: 300000000,
5673 state: InboundHTLCState::Committed,
5676 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5678 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5679 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5680 cltv_expiry: 200000000,
5681 state: OutboundHTLCState::Committed,
5682 source: HTLCSource::OutboundRoute {
5684 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5685 first_hop_htlc_msat: 548,
5689 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5690 // the dust limit check.
5691 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5692 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5693 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5694 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5696 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5697 // of the HTLCs are seen to be above the dust limit.
5698 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5699 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5700 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5701 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5702 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5706 fn test_timeout_vs_success_htlc_dust_limit() {
5707 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5708 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5709 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5710 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5711 let fee_est = TestFeeEstimator{fee_est: 253 };
5712 let secp_ctx = Secp256k1::new();
5713 let seed = [42; 32];
5714 let network = Network::Testnet;
5715 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5717 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5718 let config = UserConfig::default();
5719 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5721 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5722 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5724 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5725 // counted as dust when it shouldn't be.
5726 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5727 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5728 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5729 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5731 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5732 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5733 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5734 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5735 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5737 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5739 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5740 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5741 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5742 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5743 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5745 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5746 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5747 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5748 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5749 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5753 fn channel_reestablish_no_updates() {
5754 let feeest = TestFeeEstimator{fee_est: 15000};
5755 let logger = test_utils::TestLogger::new();
5756 let secp_ctx = Secp256k1::new();
5757 let seed = [42; 32];
5758 let network = Network::Testnet;
5759 let best_block = BestBlock::from_genesis(network);
5760 let chain_hash = best_block.block_hash();
5761 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5763 // Go through the flow of opening a channel between two nodes.
5765 // Create Node A's channel pointing to Node B's pubkey
5766 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5767 let config = UserConfig::default();
5768 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5770 // Create Node B's channel by receiving Node A's open_channel message
5771 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5772 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5773 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();
5775 // Node B --> Node A: accept channel
5776 let accept_channel_msg = node_b_chan.get_accept_channel();
5777 node_a_chan.accept_channel(&accept_channel_msg, &config, &InitFeatures::known()).unwrap();
5779 // Node A --> Node B: funding created
5780 let output_script = node_a_chan.get_funding_redeemscript();
5781 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5782 value: 10000000, script_pubkey: output_script.clone(),
5784 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5785 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5786 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5788 // Node B --> Node A: funding signed
5789 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5791 // Now disconnect the two nodes and check that the commitment point in
5792 // Node B's channel_reestablish message is sane.
5793 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5794 let msg = node_b_chan.get_channel_reestablish(&&logger);
5795 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5796 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5797 match msg.data_loss_protect {
5798 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5799 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5804 // Check that the commitment point in Node A's channel_reestablish message
5806 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5807 let msg = node_a_chan.get_channel_reestablish(&&logger);
5808 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5809 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5810 match msg.data_loss_protect {
5811 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5812 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5819 fn channel_update() {
5820 let feeest = TestFeeEstimator{fee_est: 15000};
5821 let secp_ctx = Secp256k1::new();
5822 let seed = [42; 32];
5823 let network = Network::Testnet;
5824 let chain_hash = genesis_block(network).header.block_hash();
5825 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5827 // Create a channel.
5828 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5829 let config = UserConfig::default();
5830 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, &InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5831 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5832 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5833 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5835 // Make sure that receiving a channel update will update the Channel as expected.
5836 let update = ChannelUpdate {
5837 contents: UnsignedChannelUpdate {
5839 short_channel_id: 0,
5842 cltv_expiry_delta: 100,
5843 htlc_minimum_msat: 5,
5844 htlc_maximum_msat: OptionalField::Absent,
5846 fee_proportional_millionths: 11,
5847 excess_data: Vec::new(),
5849 signature: Signature::from(unsafe { FFISignature::new() })
5851 node_a_chan.channel_update(&update).unwrap();
5853 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5854 // change our official htlc_minimum_msat.
5855 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5856 match node_a_chan.counterparty_forwarding_info() {
5858 assert_eq!(info.cltv_expiry_delta, 100);
5859 assert_eq!(info.fee_base_msat, 110);
5860 assert_eq!(info.fee_proportional_millionths, 11);
5862 None => panic!("expected counterparty forwarding info to be Some")
5867 fn outbound_commitment_test() {
5868 // Test vectors from BOLT 3 Appendix C:
5869 let feeest = TestFeeEstimator{fee_est: 15000};
5870 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5871 let secp_ctx = Secp256k1::new();
5873 let mut signer = InMemorySigner::new(
5875 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5876 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5877 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5878 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5879 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5881 // These aren't set in the test vectors:
5882 [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],
5887 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5888 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5889 let keys_provider = Keys { signer: signer.clone() };
5891 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5892 let mut config = UserConfig::default();
5893 config.channel_options.announced_channel = false;
5894 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
5895 chan.holder_dust_limit_satoshis = 546;
5896 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5898 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5900 let counterparty_pubkeys = ChannelPublicKeys {
5901 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5902 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5903 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5904 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5905 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5907 chan.channel_transaction_parameters.counterparty_parameters = Some(
5908 CounterpartyChannelTransactionParameters {
5909 pubkeys: counterparty_pubkeys.clone(),
5910 selected_contest_delay: 144
5912 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5913 signer.ready_channel(&chan.channel_transaction_parameters);
5915 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5916 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5918 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5919 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5921 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5922 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5924 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5925 // derived from a commitment_seed, so instead we copy it here and call
5926 // build_commitment_transaction.
5927 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5928 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5929 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5930 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5931 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5933 macro_rules! test_commitment {
5934 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5935 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5937 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5938 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, &logger);
5940 let htlcs = res.3.drain(..)
5941 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5945 let trusted_tx = commitment_tx.trust();
5946 let unsigned_tx = trusted_tx.built_transaction();
5947 let redeemscript = chan.get_funding_redeemscript();
5948 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5949 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5950 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5952 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5953 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5954 let mut counterparty_htlc_sigs = Vec::new();
5955 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5957 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5958 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5959 counterparty_htlc_sigs.push(remote_signature);
5961 assert_eq!(htlcs.len(), per_htlc.len());
5963 let holder_commitment_tx = HolderCommitmentTransaction::new(
5964 commitment_tx.clone(),
5965 counterparty_signature,
5966 counterparty_htlc_sigs,
5967 &chan.holder_signer.pubkeys().funding_pubkey,
5968 chan.counterparty_funding_pubkey()
5970 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5971 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5973 let funding_redeemscript = chan.get_funding_redeemscript();
5974 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5975 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5977 // ((htlc, counterparty_sig), (index, holder_sig))
5978 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5981 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5983 let ref htlc = htlcs[$htlc_idx];
5984 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5985 chan.get_counterparty_selected_contest_delay().unwrap(),
5986 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5987 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5988 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5989 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5991 let mut preimage: Option<PaymentPreimage> = None;
5994 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5995 if out == htlc.payment_hash {
5996 preimage = Some(PaymentPreimage([i; 32]));
6000 assert!(preimage.is_some());
6003 let htlc_sig = htlc_sig_iter.next().unwrap();
6004 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
6006 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
6007 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
6008 let index = (htlc_sig.1).0;
6009 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
6010 let trusted_tx = holder_commitment_tx.trust();
6011 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
6012 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
6014 assert!(htlc_sig_iter.next().is_none());
6018 // simple commitment tx with no HTLCs
6019 chan.value_to_self_msat = 7000000000;
6021 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
6022 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
6023 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6025 chan.pending_inbound_htlcs.push({
6026 let mut out = InboundHTLCOutput{
6028 amount_msat: 1000000,
6030 payment_hash: PaymentHash([0; 32]),
6031 state: InboundHTLCState::Committed,
6033 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
6036 chan.pending_inbound_htlcs.push({
6037 let mut out = InboundHTLCOutput{
6039 amount_msat: 2000000,
6041 payment_hash: PaymentHash([0; 32]),
6042 state: InboundHTLCState::Committed,
6044 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6047 chan.pending_outbound_htlcs.push({
6048 let mut out = OutboundHTLCOutput{
6050 amount_msat: 2000000,
6052 payment_hash: PaymentHash([0; 32]),
6053 state: OutboundHTLCState::Committed,
6054 source: HTLCSource::dummy(),
6056 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
6059 chan.pending_outbound_htlcs.push({
6060 let mut out = OutboundHTLCOutput{
6062 amount_msat: 3000000,
6064 payment_hash: PaymentHash([0; 32]),
6065 state: OutboundHTLCState::Committed,
6066 source: HTLCSource::dummy(),
6068 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
6071 chan.pending_inbound_htlcs.push({
6072 let mut out = InboundHTLCOutput{
6074 amount_msat: 4000000,
6076 payment_hash: PaymentHash([0; 32]),
6077 state: InboundHTLCState::Committed,
6079 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
6083 // commitment tx with all five HTLCs untrimmed (minimum feerate)
6084 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6085 chan.feerate_per_kw = 0;
6087 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
6088 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
6089 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6092 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
6093 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
6094 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6097 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
6098 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
6099 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6102 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
6103 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
6104 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6107 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
6108 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
6109 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6112 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
6113 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
6114 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6117 // commitment tx with seven outputs untrimmed (maximum feerate)
6118 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6119 chan.feerate_per_kw = 647;
6121 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
6122 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
6123 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6126 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
6127 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
6128 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
6131 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
6132 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
6133 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6136 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
6137 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
6138 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6141 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
6142 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
6143 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6146 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
6147 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
6148 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6151 // commitment tx with six outputs untrimmed (minimum feerate)
6152 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6153 chan.feerate_per_kw = 648;
6155 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
6156 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
6157 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6160 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
6161 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
6162 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6165 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
6166 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
6167 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6170 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
6171 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
6172 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6175 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
6176 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
6177 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6180 // commitment tx with six outputs untrimmed (maximum feerate)
6181 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6182 chan.feerate_per_kw = 2069;
6184 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
6185 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
6186 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6189 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
6190 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
6191 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6194 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
6195 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
6196 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6199 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
6200 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
6201 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6204 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
6205 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
6206 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6209 // commitment tx with five outputs untrimmed (minimum feerate)
6210 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6211 chan.feerate_per_kw = 2070;
6213 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
6214 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
6215 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6218 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
6219 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
6220 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6223 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
6224 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
6225 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6228 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
6229 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
6230 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6233 // commitment tx with five outputs untrimmed (maximum feerate)
6234 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6235 chan.feerate_per_kw = 2194;
6237 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
6238 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
6239 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6242 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
6243 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
6244 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
6247 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
6248 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
6249 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6252 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
6253 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
6254 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6257 // commitment tx with four outputs untrimmed (minimum feerate)
6258 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6259 chan.feerate_per_kw = 2195;
6261 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
6262 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
6263 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6266 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
6267 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
6268 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6271 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
6272 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
6273 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6276 // commitment tx with four outputs untrimmed (maximum feerate)
6277 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6278 chan.feerate_per_kw = 3702;
6280 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
6281 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
6282 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6285 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
6286 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
6287 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
6290 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
6291 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
6292 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6295 // commitment tx with three outputs untrimmed (minimum feerate)
6296 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6297 chan.feerate_per_kw = 3703;
6299 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
6300 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
6301 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6304 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
6305 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
6306 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6309 // commitment tx with three outputs untrimmed (maximum feerate)
6310 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6311 chan.feerate_per_kw = 4914;
6313 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
6314 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
6315 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6318 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
6319 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
6320 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
6323 // commitment tx with two outputs untrimmed (minimum feerate)
6324 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6325 chan.feerate_per_kw = 4915;
6327 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
6328 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
6329 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6331 // commitment tx with two outputs untrimmed (maximum feerate)
6332 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6333 chan.feerate_per_kw = 9651180;
6335 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
6336 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
6337 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6339 // commitment tx with one output untrimmed (minimum feerate)
6340 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6341 chan.feerate_per_kw = 9651181;
6343 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6344 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6345 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6347 // commitment tx with fee greater than funder amount
6348 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
6349 chan.feerate_per_kw = 9651936;
6351 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
6352 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
6353 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
6355 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
6356 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
6357 chan.feerate_per_kw = 253;
6358 chan.pending_inbound_htlcs.clear();
6359 chan.pending_inbound_htlcs.push({
6360 let mut out = InboundHTLCOutput{
6362 amount_msat: 2000000,
6364 payment_hash: PaymentHash([0; 32]),
6365 state: InboundHTLCState::Committed,
6367 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
6370 chan.pending_outbound_htlcs.clear();
6371 chan.pending_outbound_htlcs.push({
6372 let mut out = OutboundHTLCOutput{
6374 amount_msat: 5000000,
6376 payment_hash: PaymentHash([0; 32]),
6377 state: OutboundHTLCState::Committed,
6378 source: HTLCSource::dummy(),
6380 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6383 chan.pending_outbound_htlcs.push({
6384 let mut out = OutboundHTLCOutput{
6386 amount_msat: 5000000,
6388 payment_hash: PaymentHash([0; 32]),
6389 state: OutboundHTLCState::Committed,
6390 source: HTLCSource::dummy(),
6392 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6396 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6397 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6398 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6401 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6402 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6403 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6405 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6406 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6407 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6409 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6410 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6411 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6416 fn test_per_commitment_secret_gen() {
6417 // Test vectors from BOLT 3 Appendix D:
6419 let mut seed = [0; 32];
6420 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6421 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6422 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6424 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6425 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6426 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6428 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6429 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6431 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6432 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6434 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6435 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6436 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6440 fn test_key_derivation() {
6441 // Test vectors from BOLT 3 Appendix E:
6442 let secp_ctx = Secp256k1::new();
6444 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6445 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6447 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6448 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6450 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6451 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6453 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6454 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6456 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6457 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6459 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6460 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6462 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6463 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());