1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
12 use bitcoin::blockdata::opcodes;
13 use bitcoin::util::bip143;
14 use bitcoin::consensus::encode;
16 use bitcoin::hashes::Hash;
17 use bitcoin::hashes::sha256::Hash as Sha256;
18 use bitcoin::hashes::sha256d::Hash as Sha256d;
19 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
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::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
30 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};
33 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
34 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
35 use chain::transaction::{OutPoint, TransactionData};
36 use chain::keysinterface::{Sign, KeysInterface};
37 use util::transaction_utils;
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;
45 use core::{cmp,mem,fmt};
47 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
49 use bitcoin::hashes::hex::ToHex;
50 use bitcoin::blockdata::opcodes::all::OP_PUSHBYTES_0;
53 pub struct ChannelValueStat {
54 pub value_to_self_msat: u64,
55 pub channel_value_msat: u64,
56 pub channel_reserve_msat: u64,
57 pub pending_outbound_htlcs_amount_msat: u64,
58 pub pending_inbound_htlcs_amount_msat: u64,
59 pub holding_cell_outbound_amount_msat: u64,
60 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
61 pub counterparty_dust_limit_msat: u64,
64 enum InboundHTLCRemovalReason {
65 FailRelay(msgs::OnionErrorPacket),
66 FailMalformed(([u8; 32], u16)),
67 Fulfill(PaymentPreimage),
70 enum InboundHTLCState {
71 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
72 /// update_add_htlc message for this HTLC.
73 RemoteAnnounced(PendingHTLCStatus),
74 /// Included in a received commitment_signed message (implying we've
75 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
76 /// state (see the example below). We have not yet included this HTLC in a
77 /// commitment_signed message because we are waiting on the remote's
78 /// aforementioned state revocation. One reason this missing remote RAA
79 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
80 /// is because every time we create a new "state", i.e. every time we sign a
81 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
82 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
83 /// sent provided the per_commitment_point for our current commitment tx.
84 /// The other reason we should not send a commitment_signed without their RAA
85 /// is because their RAA serves to ACK our previous commitment_signed.
87 /// Here's an example of how an HTLC could come to be in this state:
88 /// remote --> update_add_htlc(prev_htlc) --> local
89 /// remote --> commitment_signed(prev_htlc) --> local
90 /// remote <-- revoke_and_ack <-- local
91 /// remote <-- commitment_signed(prev_htlc) <-- local
92 /// [note that here, the remote does not respond with a RAA]
93 /// remote --> update_add_htlc(this_htlc) --> local
94 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
95 /// Now `this_htlc` will be assigned this state. It's unable to be officially
96 /// accepted, i.e. included in a commitment_signed, because we're missing the
97 /// RAA that provides our next per_commitment_point. The per_commitment_point
98 /// is used to derive commitment keys, which are used to construct the
99 /// signatures in a commitment_signed message.
100 /// Implies AwaitingRemoteRevoke.
102 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
103 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
104 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
105 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
106 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
107 /// channel (before it can then get forwarded and/or removed).
108 /// Implies AwaitingRemoteRevoke.
109 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
111 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
112 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
114 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
115 /// commitment transaction without it as otherwise we'll have to force-close the channel to
116 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
117 /// anyway). That said, ChannelMonitor does this for us (see
118 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
119 /// our own local state before then, once we're sure that the next commitment_signed and
120 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
121 LocalRemoved(InboundHTLCRemovalReason),
124 struct InboundHTLCOutput {
128 payment_hash: PaymentHash,
129 state: InboundHTLCState,
132 enum OutboundHTLCState {
133 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
134 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
135 /// we will promote to Committed (note that they may not accept it until the next time we
136 /// revoke, but we don't really care about that:
137 /// * they've revoked, so worst case we can announce an old state and get our (option on)
138 /// money back (though we won't), and,
139 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
140 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
141 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
142 /// we'll never get out of sync).
143 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
144 /// OutboundHTLCOutput's size just for a temporary bit
145 LocalAnnounced(Box<msgs::OnionPacket>),
147 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
148 /// the change (though they'll need to revoke before we fail the payment).
149 RemoteRemoved(Option<HTLCFailReason>),
150 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
151 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
152 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
153 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
154 /// remote revoke_and_ack on a previous state before we can do so.
155 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
156 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
157 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
158 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
159 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
160 /// revoke_and_ack to drop completely.
161 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
164 struct OutboundHTLCOutput {
168 payment_hash: PaymentHash,
169 state: OutboundHTLCState,
173 /// See AwaitingRemoteRevoke ChannelState for more info
174 enum HTLCUpdateAwaitingACK {
175 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
179 payment_hash: PaymentHash,
181 onion_routing_packet: msgs::OnionPacket,
184 payment_preimage: PaymentPreimage,
189 err_packet: msgs::OnionErrorPacket,
193 /// There are a few "states" and then a number of flags which can be applied:
194 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
195 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
196 /// move on to ChannelFunded.
197 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
198 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
199 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
201 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
202 OurInitSent = 1 << 0,
203 /// Implies we have received their open_channel/accept_channel message
204 TheirInitSent = 1 << 1,
205 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
206 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
207 /// upon receipt of funding_created, so simply skip this state.
209 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
210 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
211 /// and our counterparty consider the funding transaction confirmed.
213 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
214 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
215 TheirFundingLocked = 1 << 4,
216 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
217 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
218 OurFundingLocked = 1 << 5,
220 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
221 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
223 PeerDisconnected = 1 << 7,
224 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
225 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
226 /// outbound messages until they've managed to do so.
227 MonitorUpdateFailed = 1 << 8,
228 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
229 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
230 /// messages as then we will be unable to determine which HTLCs they included in their
231 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
233 /// Flag is set on ChannelFunded.
234 AwaitingRemoteRevoke = 1 << 9,
235 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
236 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
237 /// to respond with our own shutdown message when possible.
238 RemoteShutdownSent = 1 << 10,
239 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
240 /// point, we may not add any new HTLCs to the channel.
241 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
242 /// us their shutdown.
243 LocalShutdownSent = 1 << 11,
244 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
245 /// to drop us, but we store this anyway.
246 ShutdownComplete = 4096,
248 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
249 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
251 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
253 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
254 /// our counterparty or not. However, we don't want to announce updates right away to avoid
255 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
256 /// our channel_update message and track the current state here.
257 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
258 #[derive(Clone, Copy, PartialEq)]
259 pub(super) enum ChannelUpdateStatus {
260 /// We've announced the channel as enabled and are connected to our peer.
262 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
264 /// Our channel is live again, but we haven't announced the channel as enabled yet.
266 /// We've announced the channel as disabled.
270 /// An enum indicating whether the local or remote side offered a given HTLC.
276 /// Used when calculating whether we or the remote can afford an additional HTLC.
277 struct HTLCCandidate {
279 origin: HTLCInitiator,
283 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
291 /// Information needed for constructing an invoice route hint for this channel.
292 #[derive(Clone, Debug, PartialEq)]
293 pub struct CounterpartyForwardingInfo {
294 /// Base routing fee in millisatoshis.
295 pub fee_base_msat: u32,
296 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
297 pub fee_proportional_millionths: u32,
298 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
299 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
300 /// `cltv_expiry_delta` for more details.
301 pub cltv_expiry_delta: u16,
304 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
306 enum UpdateFulfillFetch {
308 monitor_update: ChannelMonitorUpdate,
309 msg: Option<msgs::UpdateFulfillHTLC>,
314 /// The return type of get_update_fulfill_htlc_and_commit.
315 pub enum UpdateFulfillCommitFetch {
316 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
317 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
318 /// previously placed in the holding cell (and has since been removed).
320 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
321 monitor_update: ChannelMonitorUpdate,
322 /// The update_fulfill message and commitment_signed message (if the claim was not placed
323 /// in the holding cell).
324 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
326 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
327 /// or has been forgotten (presumably previously claimed).
331 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
332 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
333 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
336 // Holder designates channel data owned for the benefice of the user client.
337 // Counterparty designates channel data owned by the another channel participant entity.
338 pub(super) struct Channel<Signer: Sign> {
339 config: ChannelConfig,
343 channel_id: [u8; 32],
345 secp_ctx: Secp256k1<secp256k1::All>,
346 channel_value_satoshis: u64,
348 latest_monitor_update_id: u64,
350 holder_signer: Signer,
351 shutdown_pubkey: PublicKey,
352 destination_script: Script,
354 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
355 // generation start at 0 and count up...this simplifies some parts of implementation at the
356 // cost of others, but should really just be changed.
358 cur_holder_commitment_transaction_number: u64,
359 cur_counterparty_commitment_transaction_number: u64,
360 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
361 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
362 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
363 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
365 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
366 /// need to ensure we resend them in the order we originally generated them. Note that because
367 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
368 /// sufficient to simply set this to the opposite of any message we are generating as we
369 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
370 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
372 resend_order: RAACommitmentOrder,
374 monitor_pending_funding_locked: bool,
375 monitor_pending_revoke_and_ack: bool,
376 monitor_pending_commitment_signed: bool,
377 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
378 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
380 // pending_update_fee is filled when sending and receiving update_fee
381 // For outbound channel, feerate_per_kw is updated with the value from
382 // pending_update_fee when revoke_and_ack is received
384 // For inbound channel, feerate_per_kw is updated when it receives
385 // commitment_signed and revoke_and_ack is generated
386 // The pending value is kept when another pair of update_fee and commitment_signed
387 // is received during AwaitingRemoteRevoke and relieved when the expected
388 // revoke_and_ack is received and new commitment_signed is generated to be
389 // sent to the funder. Otherwise, the pending value is removed when receiving
390 // commitment_signed.
391 pending_update_fee: Option<u32>,
392 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
393 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
394 // is received. holding_cell_update_fee is updated when there are additional
395 // update_fee() during ChannelState::AwaitingRemoteRevoke.
396 holding_cell_update_fee: Option<u32>,
397 next_holder_htlc_id: u64,
398 next_counterparty_htlc_id: u64,
399 update_time_counter: u32,
402 #[cfg(debug_assertions)]
403 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
404 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
405 #[cfg(debug_assertions)]
406 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
407 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
409 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
411 /// The hash of the block in which the funding transaction was included.
412 funding_tx_confirmed_in: Option<BlockHash>,
413 funding_tx_confirmation_height: u32,
414 short_channel_id: Option<u64>,
416 counterparty_dust_limit_satoshis: u64,
418 pub(super) holder_dust_limit_satoshis: u64,
420 holder_dust_limit_satoshis: u64,
422 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
424 counterparty_max_htlc_value_in_flight_msat: u64,
425 //get_holder_max_htlc_value_in_flight_msat(): u64,
426 /// minimum channel reserve for self to maintain - set by them.
427 counterparty_selected_channel_reserve_satoshis: Option<u64>,
428 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
429 counterparty_htlc_minimum_msat: u64,
430 holder_htlc_minimum_msat: u64,
432 pub counterparty_max_accepted_htlcs: u16,
434 counterparty_max_accepted_htlcs: u16,
435 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
436 minimum_depth: Option<u32>,
438 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
440 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
441 funding_transaction: Option<Transaction>,
443 counterparty_cur_commitment_point: Option<PublicKey>,
444 counterparty_prev_commitment_point: Option<PublicKey>,
445 counterparty_node_id: PublicKey,
447 counterparty_shutdown_scriptpubkey: Option<Script>,
449 commitment_secrets: CounterpartyCommitmentSecrets,
451 channel_update_status: ChannelUpdateStatus,
453 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
454 /// This can be used to rebroadcast the channel_announcement message later.
455 announcement_sigs: Option<(Signature, Signature)>,
457 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
458 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
459 // be, by comparing the cached values to the fee of the tranaction generated by
460 // `build_commitment_transaction`.
461 #[cfg(any(test, feature = "fuzztarget"))]
462 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
463 #[cfg(any(test, feature = "fuzztarget"))]
464 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
466 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
467 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
468 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
469 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
470 /// message until we receive a channel_reestablish.
472 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
473 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
475 #[cfg(any(test, feature = "fuzztarget"))]
476 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
477 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
478 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
479 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
480 // is fine, but as a sanity check in our failure to generate the second claim, we check here
481 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
482 historical_inbound_htlc_fulfills: HashSet<u64>,
485 #[cfg(any(test, feature = "fuzztarget"))]
486 struct CommitmentTxInfoCached {
488 total_pending_htlcs: usize,
489 next_holder_htlc_id: u64,
490 next_counterparty_htlc_id: u64,
494 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
497 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
499 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
501 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
503 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
505 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
507 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
509 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
510 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
511 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
512 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
513 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
514 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
515 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
516 /// upper bound to avoid negotiation conflicts with other implementations.
517 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
519 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
520 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
521 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
522 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
523 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
525 /// Used to return a simple Error back to ChannelManager. Will get converted to a
526 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
527 /// channel_id in ChannelManager.
528 pub(super) enum ChannelError {
531 CloseDelayBroadcast(String),
534 impl fmt::Debug for ChannelError {
535 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
537 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
538 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
539 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
544 macro_rules! secp_check {
545 ($res: expr, $err: expr) => {
548 Err(_) => return Err(ChannelError::Close($err)),
553 impl<Signer: Sign> Channel<Signer> {
554 // Convert constants + channel value to limits:
555 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
556 channel_value_satoshis * 1000 / 10 //TODO
559 /// Returns a minimum channel reserve value the remote needs to maintain,
562 /// Guaranteed to return a value no larger than channel_value_satoshis
563 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
564 let (q, _) = channel_value_satoshis.overflowing_div(100);
565 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
569 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
570 where K::Target: KeysInterface<Signer = Signer>,
571 F::Target: FeeEstimator,
573 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
574 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
575 let pubkeys = holder_signer.pubkeys().clone();
577 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
578 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
580 let channel_value_msat = channel_value_satoshis * 1000;
581 if push_msat > channel_value_msat {
582 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
584 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
585 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
587 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
588 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
589 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
592 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
594 let mut secp_ctx = Secp256k1::new();
595 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
599 config: config.channel_options.clone(),
601 channel_id: keys_provider.get_secure_random_bytes(),
602 channel_state: ChannelState::OurInitSent as u32,
604 channel_value_satoshis,
606 latest_monitor_update_id: 0,
609 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
610 destination_script: keys_provider.get_destination_script(),
612 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
613 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
614 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
616 pending_inbound_htlcs: Vec::new(),
617 pending_outbound_htlcs: Vec::new(),
618 holding_cell_htlc_updates: Vec::new(),
619 pending_update_fee: None,
620 holding_cell_update_fee: None,
621 next_holder_htlc_id: 0,
622 next_counterparty_htlc_id: 0,
623 update_time_counter: 1,
625 resend_order: RAACommitmentOrder::CommitmentFirst,
627 monitor_pending_funding_locked: false,
628 monitor_pending_revoke_and_ack: false,
629 monitor_pending_commitment_signed: false,
630 monitor_pending_forwards: Vec::new(),
631 monitor_pending_failures: Vec::new(),
633 #[cfg(debug_assertions)]
634 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
635 #[cfg(debug_assertions)]
636 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
638 last_sent_closing_fee: None,
640 funding_tx_confirmed_in: None,
641 funding_tx_confirmation_height: 0,
642 short_channel_id: None,
644 feerate_per_kw: feerate,
645 counterparty_dust_limit_satoshis: 0,
646 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
647 counterparty_max_htlc_value_in_flight_msat: 0,
648 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
649 counterparty_htlc_minimum_msat: 0,
650 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
651 counterparty_max_accepted_htlcs: 0,
652 minimum_depth: None, // Filled in in accept_channel
654 counterparty_forwarding_info: None,
656 channel_transaction_parameters: ChannelTransactionParameters {
657 holder_pubkeys: pubkeys,
658 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
659 is_outbound_from_holder: true,
660 counterparty_parameters: None,
661 funding_outpoint: None
663 funding_transaction: None,
665 counterparty_cur_commitment_point: None,
666 counterparty_prev_commitment_point: None,
667 counterparty_node_id,
669 counterparty_shutdown_scriptpubkey: None,
671 commitment_secrets: CounterpartyCommitmentSecrets::new(),
673 channel_update_status: ChannelUpdateStatus::Enabled,
675 announcement_sigs: None,
677 #[cfg(any(test, feature = "fuzztarget"))]
678 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
679 #[cfg(any(test, feature = "fuzztarget"))]
680 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
682 workaround_lnd_bug_4006: None,
684 #[cfg(any(test, feature = "fuzztarget"))]
685 historical_inbound_htlc_fulfills: HashSet::new(),
689 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
690 where F::Target: FeeEstimator
692 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
693 if feerate_per_kw < lower_limit {
694 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
696 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 2;
697 if feerate_per_kw as u64 > upper_limit {
698 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
703 /// Creates a new channel from a remote sides' request for one.
704 /// Assumes chain_hash has already been checked and corresponds with what we expect!
705 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>
706 where K::Target: KeysInterface<Signer = Signer>,
707 F::Target: FeeEstimator
709 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
710 let pubkeys = holder_signer.pubkeys().clone();
711 let counterparty_pubkeys = ChannelPublicKeys {
712 funding_pubkey: msg.funding_pubkey,
713 revocation_basepoint: msg.revocation_basepoint,
714 payment_point: msg.payment_point,
715 delayed_payment_basepoint: msg.delayed_payment_basepoint,
716 htlc_basepoint: msg.htlc_basepoint
718 let mut local_config = (*config).channel_options.clone();
720 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
721 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)));
724 // Check sanity of message fields:
725 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
726 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
728 if msg.channel_reserve_satoshis > msg.funding_satoshis {
729 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
731 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
732 if msg.push_msat > funding_value {
733 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
735 if msg.dust_limit_satoshis > msg.funding_satoshis {
736 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)));
738 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
739 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
741 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
742 if msg.htlc_minimum_msat >= full_channel_value_msat {
743 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
745 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
747 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
748 if msg.to_self_delay > max_counterparty_selected_contest_delay {
749 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)));
751 if msg.max_accepted_htlcs < 1 {
752 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
754 if msg.max_accepted_htlcs > MAX_HTLCS {
755 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
758 // Now check against optional parameters as set by config...
759 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
760 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)));
762 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
763 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)));
765 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
766 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)));
768 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
769 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)));
771 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
772 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)));
774 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
775 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
777 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
778 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
781 // Convert things into internal flags and prep our state:
783 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
784 if config.peer_channel_config_limits.force_announced_channel_preference {
785 if local_config.announced_channel != announce {
786 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
789 // we either accept their preference or the preferences match
790 local_config.announced_channel = announce;
792 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
794 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
795 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
796 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)));
798 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
799 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
801 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
802 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)));
805 // check if the funder's amount for the initial commitment tx is sufficient
806 // for full fee payment
807 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
808 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
809 if funders_amount_msat < lower_limit {
810 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
813 let to_local_msat = msg.push_msat;
814 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
815 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
816 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
819 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
820 match &msg.shutdown_scriptpubkey {
821 &OptionalField::Present(ref script) => {
822 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
823 if script.len() == 0 {
825 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
826 } else if is_unsupported_shutdown_script(&their_features, script) {
827 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
832 // 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
833 &OptionalField::Absent => {
834 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()));
839 let mut secp_ctx = Secp256k1::new();
840 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
844 config: local_config,
846 channel_id: msg.temporary_channel_id,
847 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
850 latest_monitor_update_id: 0,
853 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
854 destination_script: keys_provider.get_destination_script(),
856 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
857 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
858 value_to_self_msat: msg.push_msat,
860 pending_inbound_htlcs: Vec::new(),
861 pending_outbound_htlcs: Vec::new(),
862 holding_cell_htlc_updates: Vec::new(),
863 pending_update_fee: None,
864 holding_cell_update_fee: None,
865 next_holder_htlc_id: 0,
866 next_counterparty_htlc_id: 0,
867 update_time_counter: 1,
869 resend_order: RAACommitmentOrder::CommitmentFirst,
871 monitor_pending_funding_locked: false,
872 monitor_pending_revoke_and_ack: false,
873 monitor_pending_commitment_signed: false,
874 monitor_pending_forwards: Vec::new(),
875 monitor_pending_failures: Vec::new(),
877 #[cfg(debug_assertions)]
878 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
879 #[cfg(debug_assertions)]
880 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
882 last_sent_closing_fee: None,
884 funding_tx_confirmed_in: None,
885 funding_tx_confirmation_height: 0,
886 short_channel_id: None,
888 feerate_per_kw: msg.feerate_per_kw,
889 channel_value_satoshis: msg.funding_satoshis,
890 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
891 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
892 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
893 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
894 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
895 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
896 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
897 minimum_depth: Some(config.own_channel_config.minimum_depth),
899 counterparty_forwarding_info: None,
901 channel_transaction_parameters: ChannelTransactionParameters {
902 holder_pubkeys: pubkeys,
903 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
904 is_outbound_from_holder: false,
905 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
906 selected_contest_delay: msg.to_self_delay,
907 pubkeys: counterparty_pubkeys,
909 funding_outpoint: None
911 funding_transaction: None,
913 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
914 counterparty_prev_commitment_point: None,
915 counterparty_node_id,
917 counterparty_shutdown_scriptpubkey,
919 commitment_secrets: CounterpartyCommitmentSecrets::new(),
921 channel_update_status: ChannelUpdateStatus::Enabled,
923 announcement_sigs: None,
925 #[cfg(any(test, feature = "fuzztarget"))]
926 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
927 #[cfg(any(test, feature = "fuzztarget"))]
928 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
930 workaround_lnd_bug_4006: None,
932 #[cfg(any(test, feature = "fuzztarget"))]
933 historical_inbound_htlc_fulfills: HashSet::new(),
939 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
940 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
941 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
942 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
943 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
945 /// @local is used only to convert relevant internal structures which refer to remote vs local
946 /// to decide value of outputs and direction of HTLCs.
947 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
948 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
949 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
950 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
951 /// which peer generated this transaction and "to whom" this transaction flows.
952 /// Returns (the transaction info, the number of HTLC outputs which were present in the
953 /// transaction, the list of HTLCs which were not ignored when building the transaction).
954 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
955 /// sources are provided only for outbound HTLCs in the third return value.
957 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u32, logger: &L) -> (CommitmentTransaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
958 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
959 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
960 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
962 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
963 let mut remote_htlc_total_msat = 0;
964 let mut local_htlc_total_msat = 0;
965 let mut value_to_self_msat_offset = 0;
967 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
968 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
969 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
970 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
972 macro_rules! get_htlc_in_commitment {
973 ($htlc: expr, $offered: expr) => {
974 HTLCOutputInCommitment {
976 amount_msat: $htlc.amount_msat,
977 cltv_expiry: $htlc.cltv_expiry,
978 payment_hash: $htlc.payment_hash,
979 transaction_output_index: None
984 macro_rules! add_htlc_output {
985 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
986 if $outbound == local { // "offered HTLC output"
987 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
988 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
989 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);
990 included_non_dust_htlcs.push((htlc_in_tx, $source));
992 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);
993 included_dust_htlcs.push((htlc_in_tx, $source));
996 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
997 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
998 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);
999 included_non_dust_htlcs.push((htlc_in_tx, $source));
1001 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);
1002 included_dust_htlcs.push((htlc_in_tx, $source));
1008 for ref htlc in self.pending_inbound_htlcs.iter() {
1009 let (include, state_name) = match htlc.state {
1010 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1011 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1012 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1013 InboundHTLCState::Committed => (true, "Committed"),
1014 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1018 add_htlc_output!(htlc, false, None, state_name);
1019 remote_htlc_total_msat += htlc.amount_msat;
1021 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);
1023 &InboundHTLCState::LocalRemoved(ref reason) => {
1024 if generated_by_local {
1025 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1026 value_to_self_msat_offset += htlc.amount_msat as i64;
1035 for ref htlc in self.pending_outbound_htlcs.iter() {
1036 let (include, state_name) = match htlc.state {
1037 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1038 OutboundHTLCState::Committed => (true, "Committed"),
1039 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1040 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1041 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1045 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1046 local_htlc_total_msat += htlc.amount_msat;
1048 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);
1050 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1051 value_to_self_msat_offset -= htlc.amount_msat as i64;
1053 OutboundHTLCState::RemoteRemoved(None) => {
1054 if !generated_by_local {
1055 value_to_self_msat_offset -= htlc.amount_msat as i64;
1063 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1064 assert!(value_to_self_msat >= 0);
1065 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1066 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1067 // "violate" their reserve value by couting those against it. Thus, we have to convert
1068 // everything to i64 before subtracting as otherwise we can overflow.
1069 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;
1070 assert!(value_to_remote_msat >= 0);
1072 #[cfg(debug_assertions)]
1074 // Make sure that the to_self/to_remote is always either past the appropriate
1075 // channel_reserve *or* it is making progress towards it.
1076 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1077 self.holder_max_commitment_tx_output.lock().unwrap()
1079 self.counterparty_max_commitment_tx_output.lock().unwrap()
1081 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);
1082 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1083 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);
1084 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1087 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;
1088 let (value_to_self, value_to_remote) = if self.is_outbound() {
1089 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1091 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1094 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1095 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1097 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1098 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1103 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1104 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1109 let num_nondust_htlcs = included_non_dust_htlcs.len();
1111 let channel_parameters =
1112 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1113 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1114 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1119 &mut included_non_dust_htlcs,
1122 let mut htlcs_included = included_non_dust_htlcs;
1123 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1124 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1125 htlcs_included.append(&mut included_dust_htlcs);
1127 (tx, num_nondust_htlcs, htlcs_included)
1131 fn get_closing_scriptpubkey(&self) -> Script {
1132 let channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1133 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_close_key_hash[..]).into_script()
1137 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1142 1 + // script length (0)
1146 )*4 + // * 4 for non-witness parts
1147 2 + // witness marker and flag
1148 1 + // witness element count
1149 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1150 self.get_funding_redeemscript().len() as u64 + // funding witness script
1151 2*(1 + 71); // two signatures + sighash type flags
1152 if let Some(spk) = a_scriptpubkey {
1153 ret += ((8+1) + // output values and script length
1154 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1156 if let Some(spk) = b_scriptpubkey {
1157 ret += ((8+1) + // output values and script length
1158 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1164 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1166 let mut ins: Vec<TxIn> = Vec::new();
1168 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1169 script_sig: Script::new(),
1170 sequence: 0xffffffff,
1171 witness: Vec::new(),
1176 assert!(self.pending_inbound_htlcs.is_empty());
1177 assert!(self.pending_outbound_htlcs.is_empty());
1178 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1180 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1181 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1182 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1184 if value_to_self < 0 {
1185 assert!(self.is_outbound());
1186 total_fee_satoshis += (-value_to_self) as u64;
1187 } else if value_to_remote < 0 {
1188 assert!(!self.is_outbound());
1189 total_fee_satoshis += (-value_to_remote) as u64;
1192 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1193 txouts.push((TxOut {
1194 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1195 value: value_to_remote as u64
1199 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1200 txouts.push((TxOut {
1201 script_pubkey: self.get_closing_scriptpubkey(),
1202 value: value_to_self as u64
1206 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1208 let mut outputs: Vec<TxOut> = Vec::new();
1209 for out in txouts.drain(..) {
1210 outputs.push(out.0);
1218 }, total_fee_satoshis)
1221 fn funding_outpoint(&self) -> OutPoint {
1222 self.channel_transaction_parameters.funding_outpoint.unwrap()
1226 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1227 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1228 /// our counterparty!)
1229 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1230 /// TODO Some magic rust shit to compile-time check this?
1231 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1232 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1233 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1234 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1235 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1237 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()))
1241 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1242 /// will sign and send to our counterparty.
1243 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1244 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1245 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1246 //may see payments to it!
1247 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1248 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1249 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1251 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()))
1254 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1255 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1256 /// Panics if called before accept_channel/new_from_req
1257 pub fn get_funding_redeemscript(&self) -> Script {
1258 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1261 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1262 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1263 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1264 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1266 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1267 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1269 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1271 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1273 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1274 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1275 // these, but for now we just have to treat them as normal.
1277 let mut pending_idx = core::usize::MAX;
1278 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1279 if htlc.htlc_id == htlc_id_arg {
1280 assert_eq!(htlc.payment_hash, payment_hash_calc);
1282 InboundHTLCState::Committed => {},
1283 InboundHTLCState::LocalRemoved(ref reason) => {
1284 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1286 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()));
1287 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1289 return UpdateFulfillFetch::DuplicateClaim {};
1292 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1293 // Don't return in release mode here so that we can update channel_monitor
1300 if pending_idx == core::usize::MAX {
1301 #[cfg(any(test, feature = "fuzztarget"))]
1302 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1303 // this is simply a duplicate claim, not previously failed and we lost funds.
1304 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1305 return UpdateFulfillFetch::DuplicateClaim {};
1308 // Now update local state:
1310 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1311 // can claim it even if the channel hits the chain before we see their next commitment.
1312 self.latest_monitor_update_id += 1;
1313 let monitor_update = ChannelMonitorUpdate {
1314 update_id: self.latest_monitor_update_id,
1315 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1316 payment_preimage: payment_preimage_arg.clone(),
1320 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1321 for pending_update in self.holding_cell_htlc_updates.iter() {
1322 match pending_update {
1323 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1324 if htlc_id_arg == htlc_id {
1325 // Make sure we don't leave latest_monitor_update_id incremented here:
1326 self.latest_monitor_update_id -= 1;
1327 #[cfg(any(test, feature = "fuzztarget"))]
1328 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1329 return UpdateFulfillFetch::DuplicateClaim {};
1332 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1333 if htlc_id_arg == htlc_id {
1334 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1335 // TODO: We may actually be able to switch to a fulfill here, though its
1336 // rare enough it may not be worth the complexity burden.
1337 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1338 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1344 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1345 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1346 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1348 #[cfg(any(test, feature = "fuzztarget"))]
1349 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1350 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1352 #[cfg(any(test, feature = "fuzztarget"))]
1353 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1356 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1357 if let InboundHTLCState::Committed = htlc.state {
1359 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1360 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1362 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1363 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1366 UpdateFulfillFetch::NewClaim {
1368 msg: Some(msgs::UpdateFulfillHTLC {
1369 channel_id: self.channel_id(),
1370 htlc_id: htlc_id_arg,
1371 payment_preimage: payment_preimage_arg,
1376 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 {
1377 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1378 UpdateFulfillFetch::NewClaim { mut monitor_update, msg: Some(update_fulfill_htlc) } => {
1379 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1380 Err(e) => return Err((e, monitor_update)),
1383 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1384 // strictly increasing by one, so decrement it here.
1385 self.latest_monitor_update_id = monitor_update.update_id;
1386 monitor_update.updates.append(&mut additional_update.updates);
1387 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, msgs: Some((update_fulfill_htlc, commitment)) })
1389 UpdateFulfillFetch::NewClaim { monitor_update, msg: None } => Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, msgs: None }),
1390 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1394 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1395 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1396 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1397 /// before we fail backwards.
1398 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1399 /// Ok(_) if debug assertions are turned on or preconditions are met.
1400 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 {
1401 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1402 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1404 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1406 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1407 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1408 // these, but for now we just have to treat them as normal.
1410 let mut pending_idx = core::usize::MAX;
1411 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1412 if htlc.htlc_id == htlc_id_arg {
1414 InboundHTLCState::Committed => {},
1415 InboundHTLCState::LocalRemoved(ref reason) => {
1416 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1418 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1423 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1424 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1430 if pending_idx == core::usize::MAX {
1431 #[cfg(any(test, feature = "fuzztarget"))]
1432 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1433 // is simply a duplicate fail, not previously failed and we failed-back too early.
1434 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1438 // Now update local state:
1439 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1440 for pending_update in self.holding_cell_htlc_updates.iter() {
1441 match pending_update {
1442 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1443 if htlc_id_arg == htlc_id {
1444 #[cfg(any(test, feature = "fuzztarget"))]
1445 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1449 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1450 if htlc_id_arg == htlc_id {
1451 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1452 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1458 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1459 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1460 htlc_id: htlc_id_arg,
1466 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1468 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1469 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1472 Ok(Some(msgs::UpdateFailHTLC {
1473 channel_id: self.channel_id(),
1474 htlc_id: htlc_id_arg,
1479 // Message handlers:
1481 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1482 // Check sanity of message fields:
1483 if !self.is_outbound() {
1484 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1486 if self.channel_state != ChannelState::OurInitSent as u32 {
1487 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1489 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1490 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1492 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1493 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1495 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1496 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)));
1498 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1499 if msg.dust_limit_satoshis > remote_reserve {
1500 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1502 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1503 if msg.htlc_minimum_msat >= full_channel_value_msat {
1504 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1506 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1507 if msg.to_self_delay > max_delay_acceptable {
1508 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)));
1510 if msg.max_accepted_htlcs < 1 {
1511 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1513 if msg.max_accepted_htlcs > MAX_HTLCS {
1514 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1517 // Now check against optional parameters as set by config...
1518 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1519 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)));
1521 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1522 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)));
1524 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1525 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)));
1527 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1528 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)));
1530 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1531 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1533 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1534 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1536 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1537 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)));
1539 if msg.minimum_depth == 0 {
1540 // Note that if this changes we should update the serialization minimum version to
1541 // indicate to older clients that they don't understand some features of the current
1543 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1546 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1547 match &msg.shutdown_scriptpubkey {
1548 &OptionalField::Present(ref script) => {
1549 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1550 if script.len() == 0 {
1552 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1553 } else if is_unsupported_shutdown_script(&their_features, script) {
1554 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
1556 Some(script.clone())
1559 // 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
1560 &OptionalField::Absent => {
1561 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()));
1566 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1567 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1568 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1569 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1570 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1571 self.minimum_depth = Some(msg.minimum_depth);
1573 let counterparty_pubkeys = ChannelPublicKeys {
1574 funding_pubkey: msg.funding_pubkey,
1575 revocation_basepoint: msg.revocation_basepoint,
1576 payment_point: msg.payment_point,
1577 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1578 htlc_basepoint: msg.htlc_basepoint
1581 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1582 selected_contest_delay: msg.to_self_delay,
1583 pubkeys: counterparty_pubkeys,
1586 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1587 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1589 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1594 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1595 let funding_script = self.get_funding_redeemscript();
1597 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1598 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1600 let trusted_tx = initial_commitment_tx.trust();
1601 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1602 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1603 // They sign the holder commitment transaction...
1604 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1605 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1606 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1607 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1608 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1611 let counterparty_keys = self.build_remote_transaction_keys()?;
1612 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
1614 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1615 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1616 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1617 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1619 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1620 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1622 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1623 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1626 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1627 &self.get_counterparty_pubkeys().funding_pubkey
1630 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 {
1631 if self.is_outbound() {
1632 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1634 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1635 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1636 // remember the channel, so it's safe to just send an error_message here and drop the
1638 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1640 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1641 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1642 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1643 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1646 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1647 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1648 // This is an externally observable change before we finish all our checks. In particular
1649 // funding_created_signature may fail.
1650 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1652 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1654 Err(ChannelError::Close(e)) => {
1655 self.channel_transaction_parameters.funding_outpoint = None;
1656 return Err(ChannelError::Close(e));
1659 // The only error we know how to handle is ChannelError::Close, so we fall over here
1660 // to make sure we don't continue with an inconsistent state.
1661 panic!("unexpected error type from funding_created_signature {:?}", e);
1665 let holder_commitment_tx = HolderCommitmentTransaction::new(
1666 initial_commitment_tx,
1669 &self.get_holder_pubkeys().funding_pubkey,
1670 self.counterparty_funding_pubkey()
1673 // Now that we're past error-generating stuff, update our local state:
1675 let funding_redeemscript = self.get_funding_redeemscript();
1676 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1677 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1678 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1679 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1680 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1681 &self.channel_transaction_parameters,
1682 funding_redeemscript.clone(), self.channel_value_satoshis,
1684 holder_commitment_tx, best_block);
1686 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);
1688 self.channel_state = ChannelState::FundingSent as u32;
1689 self.channel_id = funding_txo.to_channel_id();
1690 self.cur_counterparty_commitment_transaction_number -= 1;
1691 self.cur_holder_commitment_transaction_number -= 1;
1693 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1695 Ok((msgs::FundingSigned {
1696 channel_id: self.channel_id,
1698 }, channel_monitor))
1701 /// Handles a funding_signed message from the remote end.
1702 /// If this call is successful, broadcast the funding transaction (and not before!)
1703 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 {
1704 if !self.is_outbound() {
1705 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1707 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1708 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1710 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1711 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1712 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1713 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1716 let funding_script = self.get_funding_redeemscript();
1718 let counterparty_keys = self.build_remote_transaction_keys()?;
1719 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
1720 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1721 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1723 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1724 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1726 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1727 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1729 let trusted_tx = initial_commitment_tx.trust();
1730 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1731 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1732 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1733 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1734 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1738 let holder_commitment_tx = HolderCommitmentTransaction::new(
1739 initial_commitment_tx,
1742 &self.get_holder_pubkeys().funding_pubkey,
1743 self.counterparty_funding_pubkey()
1747 let funding_redeemscript = self.get_funding_redeemscript();
1748 let funding_txo = self.get_funding_txo().unwrap();
1749 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1750 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1751 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1752 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1753 &self.destination_script, (funding_txo, funding_txo_script),
1754 &self.channel_transaction_parameters,
1755 funding_redeemscript.clone(), self.channel_value_satoshis,
1757 holder_commitment_tx, best_block);
1759 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);
1761 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1762 self.channel_state = ChannelState::FundingSent as u32;
1763 self.cur_holder_commitment_transaction_number -= 1;
1764 self.cur_counterparty_commitment_transaction_number -= 1;
1766 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1768 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1771 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1772 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1773 self.workaround_lnd_bug_4006 = Some(msg.clone());
1774 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()));
1777 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1779 if non_shutdown_state == ChannelState::FundingSent as u32 {
1780 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1781 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1782 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1783 self.update_time_counter += 1;
1784 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1785 // Note that funding_signed/funding_created will have decremented both by 1!
1786 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1787 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1788 // If we reconnected before sending our funding locked they may still resend theirs:
1789 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1790 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1791 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1792 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1794 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1797 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1800 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1801 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1803 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1808 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1809 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1810 let mut htlc_inbound_value_msat = 0;
1811 for ref htlc in self.pending_inbound_htlcs.iter() {
1812 htlc_inbound_value_msat += htlc.amount_msat;
1814 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1817 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1819 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1820 let mut htlc_outbound_value_msat = 0;
1821 for ref htlc in self.pending_outbound_htlcs.iter() {
1822 htlc_outbound_value_msat += htlc.amount_msat;
1825 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1826 for update in self.holding_cell_htlc_updates.iter() {
1827 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1828 htlc_outbound_count += 1;
1829 htlc_outbound_value_msat += amount_msat;
1833 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1836 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1837 /// Doesn't bother handling the
1838 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1839 /// corner case properly.
1840 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1841 // Note that we have to handle overflow due to the above case.
1843 cmp::max(self.channel_value_satoshis as i64 * 1000
1844 - self.value_to_self_msat as i64
1845 - self.get_inbound_pending_htlc_stats().1 as i64
1846 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1848 cmp::max(self.value_to_self_msat as i64
1849 - self.get_outbound_pending_htlc_stats().1 as i64
1850 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1855 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1856 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1857 self.counterparty_selected_channel_reserve_satoshis)
1860 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1861 // Note that num_htlcs should not include dust HTLCs.
1862 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1863 // Note that we need to divide before multiplying to round properly,
1864 // since the lowest denomination of bitcoin on-chain is the satoshi.
1865 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1868 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1869 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1870 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1872 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1873 assert!(self.is_outbound());
1875 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1876 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1878 let mut addl_htlcs = 0;
1879 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1881 HTLCInitiator::LocalOffered => {
1882 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1886 HTLCInitiator::RemoteOffered => {
1887 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1893 let mut included_htlcs = 0;
1894 for ref htlc in self.pending_inbound_htlcs.iter() {
1895 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1898 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1899 // transaction including this HTLC if it times out before they RAA.
1900 included_htlcs += 1;
1903 for ref htlc in self.pending_outbound_htlcs.iter() {
1904 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1908 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1909 OutboundHTLCState::Committed => included_htlcs += 1,
1910 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1911 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1912 // transaction won't be generated until they send us their next RAA, which will mean
1913 // dropping any HTLCs in this state.
1918 for htlc in self.holding_cell_htlc_updates.iter() {
1920 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1921 if amount_msat / 1000 < real_dust_limit_timeout_sat {
1926 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1927 // ack we're guaranteed to never include them in commitment txs anymore.
1931 let num_htlcs = included_htlcs + addl_htlcs;
1932 let res = self.commit_tx_fee_msat(num_htlcs);
1933 #[cfg(any(test, feature = "fuzztarget"))]
1936 if fee_spike_buffer_htlc.is_some() {
1937 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1939 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1940 + self.holding_cell_htlc_updates.len();
1941 let commitment_tx_info = CommitmentTxInfoCached {
1943 total_pending_htlcs,
1944 next_holder_htlc_id: match htlc.origin {
1945 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1946 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1948 next_counterparty_htlc_id: match htlc.origin {
1949 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1950 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1952 feerate: self.feerate_per_kw,
1954 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1959 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1960 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1961 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1963 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1964 assert!(!self.is_outbound());
1966 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1967 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1969 let mut addl_htlcs = 0;
1970 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1972 HTLCInitiator::LocalOffered => {
1973 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1977 HTLCInitiator::RemoteOffered => {
1978 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1984 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
1985 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
1986 // committed outbound HTLCs, see below.
1987 let mut included_htlcs = 0;
1988 for ref htlc in self.pending_inbound_htlcs.iter() {
1989 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
1992 included_htlcs += 1;
1995 for ref htlc in self.pending_outbound_htlcs.iter() {
1996 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
1999 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2000 // i.e. if they've responded to us with an RAA after announcement.
2002 OutboundHTLCState::Committed => included_htlcs += 1,
2003 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2004 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2009 let num_htlcs = included_htlcs + addl_htlcs;
2010 let res = self.commit_tx_fee_msat(num_htlcs);
2011 #[cfg(any(test, feature = "fuzztarget"))]
2014 if fee_spike_buffer_htlc.is_some() {
2015 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2017 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2018 let commitment_tx_info = CommitmentTxInfoCached {
2020 total_pending_htlcs,
2021 next_holder_htlc_id: match htlc.origin {
2022 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2023 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2025 next_counterparty_htlc_id: match htlc.origin {
2026 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2027 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2029 feerate: self.feerate_per_kw,
2031 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2036 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>
2037 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2038 // We can't accept HTLCs sent after we've sent a shutdown.
2039 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2040 if local_sent_shutdown {
2041 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
2043 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2044 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2045 if remote_sent_shutdown {
2046 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2048 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2049 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2051 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2052 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2054 if msg.amount_msat == 0 {
2055 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2057 if msg.amount_msat < self.holder_htlc_minimum_msat {
2058 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)));
2061 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
2062 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
2063 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2065 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2066 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2067 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2069 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2070 // the reserve_satoshis we told them to always have as direct payment so that they lose
2071 // something if we punish them for broadcasting an old state).
2072 // Note that we don't really care about having a small/no to_remote output in our local
2073 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2074 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2075 // present in the next commitment transaction we send them (at least for fulfilled ones,
2076 // failed ones won't modify value_to_self).
2077 // Note that we will send HTLCs which another instance of rust-lightning would think
2078 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2079 // Channel state once they will not be present in the next received commitment
2081 let mut removed_outbound_total_msat = 0;
2082 for ref htlc in self.pending_outbound_htlcs.iter() {
2083 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2084 removed_outbound_total_msat += htlc.amount_msat;
2085 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2086 removed_outbound_total_msat += htlc.amount_msat;
2090 let pending_value_to_self_msat =
2091 self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
2092 let pending_remote_value_msat =
2093 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2094 if pending_remote_value_msat < msg.amount_msat {
2095 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2098 // Check that the remote can afford to pay for this HTLC on-chain at the current
2099 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2100 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2101 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2102 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2104 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2105 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2108 let chan_reserve_msat =
2109 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2110 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2111 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2114 if !self.is_outbound() {
2115 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2116 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2117 // receiver's side, only on the sender's.
2118 // Note that when we eventually remove support for fee updates and switch to anchor output
2119 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2120 // the extra htlc when calculating the next remote commitment transaction fee as we should
2121 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2122 // sensitive to fee spikes.
2123 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2124 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2125 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2126 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2127 // the HTLC, i.e. its status is already set to failing.
2128 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2129 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2132 // Check that they won't violate our local required channel reserve by adding this HTLC.
2133 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2134 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2135 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2136 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2139 if self.next_counterparty_htlc_id != msg.htlc_id {
2140 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2142 if msg.cltv_expiry >= 500000000 {
2143 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2146 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2147 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2148 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2152 // Now update local state:
2153 self.next_counterparty_htlc_id += 1;
2154 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2155 htlc_id: msg.htlc_id,
2156 amount_msat: msg.amount_msat,
2157 payment_hash: msg.payment_hash,
2158 cltv_expiry: msg.cltv_expiry,
2159 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2164 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2166 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
2167 for htlc in self.pending_outbound_htlcs.iter_mut() {
2168 if htlc.htlc_id == htlc_id {
2169 match check_preimage {
2171 Some(payment_hash) =>
2172 if payment_hash != htlc.payment_hash {
2173 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2177 OutboundHTLCState::LocalAnnounced(_) =>
2178 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2179 OutboundHTLCState::Committed => {
2180 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2182 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2183 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2185 return Ok(&htlc.source);
2188 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2191 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
2192 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2193 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2195 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2196 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2199 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2200 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
2203 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2204 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2205 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2207 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2208 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2211 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2215 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2216 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2217 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2219 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2220 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2223 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2227 pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2228 where F::Target: FeeEstimator,
2231 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2232 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2234 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2235 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2237 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2238 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2241 let funding_script = self.get_funding_redeemscript();
2243 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2245 let mut update_fee = false;
2246 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2248 self.pending_update_fee.unwrap()
2253 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2254 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2255 let commitment_txid = {
2256 let trusted_tx = commitment_tx.0.trust();
2257 let bitcoin_tx = trusted_tx.built_transaction();
2258 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2260 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2261 log_bytes!(msg.signature.serialize_compact()[..]),
2262 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2263 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2264 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2265 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2269 let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2270 (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2273 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2274 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2276 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2277 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2278 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2281 #[cfg(any(test, feature = "fuzztarget"))]
2283 if self.is_outbound() {
2284 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2285 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2286 if let Some(info) = projected_commit_tx_info {
2287 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2288 + self.holding_cell_htlc_updates.len();
2289 if info.total_pending_htlcs == total_pending_htlcs
2290 && info.next_holder_htlc_id == self.next_holder_htlc_id
2291 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2292 && info.feerate == self.feerate_per_kw {
2293 assert_eq!(total_fee, info.fee / 1000);
2299 if msg.htlc_signatures.len() != num_htlcs {
2300 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2303 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2304 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2305 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2306 if let Some(_) = htlc.transaction_output_index {
2307 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2308 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2309 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2311 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2312 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2313 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2314 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2315 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2316 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2317 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2319 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2321 htlcs_and_sigs.push((htlc, None, source));
2325 let holder_commitment_tx = HolderCommitmentTransaction::new(
2328 msg.htlc_signatures.clone(),
2329 &self.get_holder_pubkeys().funding_pubkey,
2330 self.counterparty_funding_pubkey()
2333 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2334 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2336 // Update state now that we've passed all the can-fail calls...
2337 let mut need_commitment = false;
2338 if !self.is_outbound() {
2339 if let Some(fee_update) = self.pending_update_fee {
2340 self.feerate_per_kw = fee_update;
2341 // We later use the presence of pending_update_fee to indicate we should generate a
2342 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2343 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2344 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2345 need_commitment = true;
2346 self.pending_update_fee = None;
2351 self.latest_monitor_update_id += 1;
2352 let mut monitor_update = ChannelMonitorUpdate {
2353 update_id: self.latest_monitor_update_id,
2354 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2355 commitment_tx: holder_commitment_tx,
2356 htlc_outputs: htlcs_and_sigs
2360 for htlc in self.pending_inbound_htlcs.iter_mut() {
2361 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2362 Some(forward_info.clone())
2364 if let Some(forward_info) = new_forward {
2365 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2366 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2367 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2368 need_commitment = true;
2371 for htlc in self.pending_outbound_htlcs.iter_mut() {
2372 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2373 Some(fail_reason.take())
2375 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2376 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2377 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2378 need_commitment = true;
2382 self.cur_holder_commitment_transaction_number -= 1;
2383 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2384 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2385 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2387 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2388 // In case we initially failed monitor updating without requiring a response, we need
2389 // to make sure the RAA gets sent first.
2390 self.monitor_pending_revoke_and_ack = true;
2391 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2392 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2393 // the corresponding HTLC status updates so that get_last_commitment_update
2394 // includes the right HTLCs.
2395 self.monitor_pending_commitment_signed = true;
2396 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2397 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2398 // strictly increasing by one, so decrement it here.
2399 self.latest_monitor_update_id = monitor_update.update_id;
2400 monitor_update.updates.append(&mut additional_update.updates);
2402 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2403 log_bytes!(self.channel_id));
2404 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2405 // re-send the message on restoration)
2406 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2409 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2410 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2411 // we'll send one right away when we get the revoke_and_ack when we
2412 // free_holding_cell_htlcs().
2413 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2414 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2415 // strictly increasing by one, so decrement it here.
2416 self.latest_monitor_update_id = monitor_update.update_id;
2417 monitor_update.updates.append(&mut additional_update.updates);
2419 } else if !need_commitment {
2420 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2421 } else { (None, None) };
2423 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2424 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2426 Ok((msgs::RevokeAndACK {
2427 channel_id: self.channel_id,
2428 per_commitment_secret,
2429 next_per_commitment_point,
2430 }, commitment_signed, closing_signed, monitor_update))
2433 /// Public version of the below, checking relevant preconditions first.
2434 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2435 /// returns `(None, Vec::new())`.
2436 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 {
2437 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2438 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2439 self.free_holding_cell_htlcs(logger)
2440 } else { Ok((None, Vec::new())) }
2443 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2444 /// fulfilling or failing the last pending HTLC)
2445 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2446 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2447 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2448 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2449 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2451 let mut monitor_update = ChannelMonitorUpdate {
2452 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2453 updates: Vec::new(),
2456 let mut htlc_updates = Vec::new();
2457 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2458 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2459 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2460 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2461 let mut htlcs_to_fail = Vec::new();
2462 for htlc_update in htlc_updates.drain(..) {
2463 // Note that this *can* fail, though it should be due to rather-rare conditions on
2464 // fee races with adding too many outputs which push our total payments just over
2465 // the limit. In case it's less rare than I anticipate, we may want to revisit
2466 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2467 // to rebalance channels.
2468 match &htlc_update {
2469 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2470 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2471 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2474 ChannelError::Ignore(ref msg) => {
2475 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2476 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2477 // If we fail to send here, then this HTLC should
2478 // be failed backwards. Failing to send here
2479 // indicates that this HTLC may keep being put back
2480 // into the holding cell without ever being
2481 // successfully forwarded/failed/fulfilled, causing
2482 // our counterparty to eventually close on us.
2483 htlcs_to_fail.push((source.clone(), *payment_hash));
2486 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2492 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2493 // If an HTLC claim was previously added to the holding cell (via
2494 // `get_update_fulfill_htlc`, then generating the claim message itself must
2495 // not fail - any in between attempts to claim the HTLC will have resulted
2496 // in it hitting the holding cell again and we cannot change the state of a
2497 // holding cell HTLC from fulfill to anything else.
2498 let (update_fulfill_msg_option, mut additional_monitor_update) =
2499 if let UpdateFulfillFetch::NewClaim { msg, monitor_update } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2500 (msg, monitor_update)
2501 } else { unreachable!() };
2502 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2503 monitor_update.updates.append(&mut additional_monitor_update.updates);
2505 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2506 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2507 Ok(update_fail_msg_option) => {
2508 // If an HTLC failure was previously added to the holding cell (via
2509 // `get_update_fail_htlc`) then generating the fail message itself
2510 // must not fail - we should never end up in a state where we
2511 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2512 // we didn't wait for a full revocation before failing.
2513 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2516 if let ChannelError::Ignore(_) = e {}
2518 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2525 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2526 return Ok((None, htlcs_to_fail));
2528 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2529 self.pending_update_fee = self.holding_cell_update_fee.take();
2530 Some(msgs::UpdateFee {
2531 channel_id: self.channel_id,
2532 feerate_per_kw: feerate as u32,
2538 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2539 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2540 // but we want them to be strictly increasing by one, so reset it here.
2541 self.latest_monitor_update_id = monitor_update.update_id;
2542 monitor_update.updates.append(&mut additional_update.updates);
2544 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2545 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2546 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2548 Ok((Some((msgs::CommitmentUpdate {
2550 update_fulfill_htlcs,
2552 update_fail_malformed_htlcs: Vec::new(),
2555 }, monitor_update)), htlcs_to_fail))
2557 Ok((None, Vec::new()))
2561 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2562 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2563 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2564 /// generating an appropriate error *after* the channel state has been updated based on the
2565 /// revoke_and_ack message.
2566 pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2567 where F::Target: FeeEstimator,
2570 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2571 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2573 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2574 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2576 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2577 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2580 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2581 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned())) != counterparty_prev_commitment_point {
2582 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2586 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2587 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2588 // haven't given them a new commitment transaction to broadcast). We should probably
2589 // take advantage of this by updating our channel monitor, sending them an error, and
2590 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2591 // lot of work, and there's some chance this is all a misunderstanding anyway.
2592 // We have to do *something*, though, since our signer may get mad at us for otherwise
2593 // jumping a remote commitment number, so best to just force-close and move on.
2594 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2597 #[cfg(any(test, feature = "fuzztarget"))]
2599 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2600 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2603 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2604 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2605 self.latest_monitor_update_id += 1;
2606 let mut monitor_update = ChannelMonitorUpdate {
2607 update_id: self.latest_monitor_update_id,
2608 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2609 idx: self.cur_counterparty_commitment_transaction_number + 1,
2610 secret: msg.per_commitment_secret,
2614 // Update state now that we've passed all the can-fail calls...
2615 // (note that we may still fail to generate the new commitment_signed message, but that's
2616 // OK, we step the channel here and *then* if the new generation fails we can fail the
2617 // channel based on that, but stepping stuff here should be safe either way.
2618 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2619 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2620 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2621 self.cur_counterparty_commitment_transaction_number -= 1;
2623 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2624 let mut to_forward_infos = Vec::new();
2625 let mut revoked_htlcs = Vec::new();
2626 let mut update_fail_htlcs = Vec::new();
2627 let mut update_fail_malformed_htlcs = Vec::new();
2628 let mut require_commitment = false;
2629 let mut value_to_self_msat_diff: i64 = 0;
2632 // Take references explicitly so that we can hold multiple references to self.
2633 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2634 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2636 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2637 pending_inbound_htlcs.retain(|htlc| {
2638 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2639 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2640 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2641 value_to_self_msat_diff += htlc.amount_msat as i64;
2646 pending_outbound_htlcs.retain(|htlc| {
2647 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2648 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2649 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2650 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2652 // They fulfilled, so we sent them money
2653 value_to_self_msat_diff -= htlc.amount_msat as i64;
2658 for htlc in pending_inbound_htlcs.iter_mut() {
2659 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2661 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2665 let mut state = InboundHTLCState::Committed;
2666 mem::swap(&mut state, &mut htlc.state);
2668 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2669 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2670 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2671 require_commitment = true;
2672 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2673 match forward_info {
2674 PendingHTLCStatus::Fail(fail_msg) => {
2675 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2676 require_commitment = true;
2678 HTLCFailureMsg::Relay(msg) => {
2679 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2680 update_fail_htlcs.push(msg)
2682 HTLCFailureMsg::Malformed(msg) => {
2683 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2684 update_fail_malformed_htlcs.push(msg)
2688 PendingHTLCStatus::Forward(forward_info) => {
2689 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2690 to_forward_infos.push((forward_info, htlc.htlc_id));
2691 htlc.state = InboundHTLCState::Committed;
2697 for htlc in pending_outbound_htlcs.iter_mut() {
2698 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2699 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2700 htlc.state = OutboundHTLCState::Committed;
2702 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2703 Some(fail_reason.take())
2705 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2706 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2707 require_commitment = true;
2711 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2713 if self.is_outbound() {
2714 if let Some(feerate) = self.pending_update_fee.take() {
2715 self.feerate_per_kw = feerate;
2718 if let Some(feerate) = self.pending_update_fee {
2719 // Because a node cannot send two commitment_signeds in a row without getting a
2720 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2721 // it should use to create keys with) and because a node can't send a
2722 // commitment_signed without changes, checking if the feerate is equal to the
2723 // pending feerate update is sufficient to detect require_commitment.
2724 if feerate == self.feerate_per_kw {
2725 require_commitment = true;
2726 self.pending_update_fee = None;
2731 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2732 // We can't actually generate a new commitment transaction (incl by freeing holding
2733 // cells) while we can't update the monitor, so we just return what we have.
2734 if require_commitment {
2735 self.monitor_pending_commitment_signed = true;
2736 // When the monitor updating is restored we'll call get_last_commitment_update(),
2737 // which does not update state, but we're definitely now awaiting a remote revoke
2738 // before we can step forward any more, so set it here.
2739 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2740 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2741 // strictly increasing by one, so decrement it here.
2742 self.latest_monitor_update_id = monitor_update.update_id;
2743 monitor_update.updates.append(&mut additional_update.updates);
2745 self.monitor_pending_forwards.append(&mut to_forward_infos);
2746 self.monitor_pending_failures.append(&mut revoked_htlcs);
2747 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2748 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2751 match self.free_holding_cell_htlcs(logger)? {
2752 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2753 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2754 for fail_msg in update_fail_htlcs.drain(..) {
2755 commitment_update.update_fail_htlcs.push(fail_msg);
2757 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2758 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2759 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2762 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2763 // strictly increasing by one, so decrement it here.
2764 self.latest_monitor_update_id = monitor_update.update_id;
2765 monitor_update.updates.append(&mut additional_update.updates);
2767 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2769 (None, htlcs_to_fail) => {
2770 if require_commitment {
2771 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2773 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2774 // strictly increasing by one, so decrement it here.
2775 self.latest_monitor_update_id = monitor_update.update_id;
2776 monitor_update.updates.append(&mut additional_update.updates);
2778 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2779 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2780 Ok((Some(msgs::CommitmentUpdate {
2781 update_add_htlcs: Vec::new(),
2782 update_fulfill_htlcs: Vec::new(),
2784 update_fail_malformed_htlcs,
2787 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2789 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2790 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2797 /// Adds a pending update to this channel. See the doc for send_htlc for
2798 /// further details on the optionness of the return value.
2799 /// You MUST call send_commitment prior to any other calls on this Channel
2800 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2801 if !self.is_outbound() {
2802 panic!("Cannot send fee from inbound channel");
2804 if !self.is_usable() {
2805 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2807 if !self.is_live() {
2808 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2811 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2812 self.holding_cell_update_fee = Some(feerate_per_kw);
2816 debug_assert!(self.pending_update_fee.is_none());
2817 self.pending_update_fee = Some(feerate_per_kw);
2819 Some(msgs::UpdateFee {
2820 channel_id: self.channel_id,
2825 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 {
2826 match self.send_update_fee(feerate_per_kw) {
2827 Some(update_fee) => {
2828 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2829 Ok(Some((update_fee, commitment_signed, monitor_update)))
2835 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2836 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2838 /// No further message handling calls may be made until a channel_reestablish dance has
2840 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
2841 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2842 if self.channel_state < ChannelState::FundingSent as u32 {
2843 self.channel_state = ChannelState::ShutdownComplete as u32;
2846 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2847 // will be retransmitted.
2848 self.last_sent_closing_fee = None;
2850 let mut inbound_drop_count = 0;
2851 self.pending_inbound_htlcs.retain(|htlc| {
2853 InboundHTLCState::RemoteAnnounced(_) => {
2854 // They sent us an update_add_htlc but we never got the commitment_signed.
2855 // We'll tell them what commitment_signed we're expecting next and they'll drop
2856 // this HTLC accordingly
2857 inbound_drop_count += 1;
2860 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2861 // We received a commitment_signed updating this HTLC and (at least hopefully)
2862 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2863 // in response to it yet, so don't touch it.
2866 InboundHTLCState::Committed => true,
2867 InboundHTLCState::LocalRemoved(_) => {
2868 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2869 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2870 // (that we missed). Keep this around for now and if they tell us they missed
2871 // the commitment_signed we can re-transmit the update then.
2876 self.next_counterparty_htlc_id -= inbound_drop_count;
2878 for htlc in self.pending_outbound_htlcs.iter_mut() {
2879 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2880 // They sent us an update to remove this but haven't yet sent the corresponding
2881 // commitment_signed, we need to move it back to Committed and they can re-send
2882 // the update upon reconnection.
2883 htlc.state = OutboundHTLCState::Committed;
2887 self.channel_state |= ChannelState::PeerDisconnected as u32;
2888 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
2891 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2892 /// updates are partially paused.
2893 /// This must be called immediately after the call which generated the ChannelMonitor update
2894 /// which failed. The messages which were generated from that call which generated the
2895 /// monitor update failure must *not* have been sent to the remote end, and must instead
2896 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2897 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)>) {
2898 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2899 self.monitor_pending_revoke_and_ack = resend_raa;
2900 self.monitor_pending_commitment_signed = resend_commitment;
2901 assert!(self.monitor_pending_forwards.is_empty());
2902 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2903 assert!(self.monitor_pending_failures.is_empty());
2904 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2905 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2908 /// Indicates that the latest ChannelMonitor update has been committed by the client
2909 /// successfully and we should restore normal operation. Returns messages which should be sent
2910 /// to the remote side.
2911 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 {
2912 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2913 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2915 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
2916 self.funding_transaction.take()
2919 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
2920 // we assume the user never directly broadcasts the funding transaction and waits for us to
2921 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
2922 // channel which failed to persist the monitor on funding_created, and we got the funding
2923 // transaction confirmed before the monitor was persisted.
2924 let funding_locked = if self.monitor_pending_funding_locked {
2925 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
2926 self.monitor_pending_funding_locked = false;
2927 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2928 Some(msgs::FundingLocked {
2929 channel_id: self.channel_id(),
2930 next_per_commitment_point,
2934 let mut forwards = Vec::new();
2935 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2936 let mut failures = Vec::new();
2937 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2939 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2940 self.monitor_pending_revoke_and_ack = false;
2941 self.monitor_pending_commitment_signed = false;
2942 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
2945 let raa = if self.monitor_pending_revoke_and_ack {
2946 Some(self.get_last_revoke_and_ack())
2948 let commitment_update = if self.monitor_pending_commitment_signed {
2949 Some(self.get_last_commitment_update(logger))
2952 self.monitor_pending_revoke_and_ack = false;
2953 self.monitor_pending_commitment_signed = false;
2954 let order = self.resend_order.clone();
2955 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
2956 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
2957 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
2958 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2959 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
2962 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2963 where F::Target: FeeEstimator
2965 if self.is_outbound() {
2966 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2968 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2969 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2971 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2972 self.pending_update_fee = Some(msg.feerate_per_kw);
2973 self.update_time_counter += 1;
2977 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2978 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2979 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
2980 msgs::RevokeAndACK {
2981 channel_id: self.channel_id,
2982 per_commitment_secret,
2983 next_per_commitment_point,
2987 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2988 let mut update_add_htlcs = Vec::new();
2989 let mut update_fulfill_htlcs = Vec::new();
2990 let mut update_fail_htlcs = Vec::new();
2991 let mut update_fail_malformed_htlcs = Vec::new();
2993 for htlc in self.pending_outbound_htlcs.iter() {
2994 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2995 update_add_htlcs.push(msgs::UpdateAddHTLC {
2996 channel_id: self.channel_id(),
2997 htlc_id: htlc.htlc_id,
2998 amount_msat: htlc.amount_msat,
2999 payment_hash: htlc.payment_hash,
3000 cltv_expiry: htlc.cltv_expiry,
3001 onion_routing_packet: (**onion_packet).clone(),
3006 for htlc in self.pending_inbound_htlcs.iter() {
3007 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3009 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3010 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3011 channel_id: self.channel_id(),
3012 htlc_id: htlc.htlc_id,
3013 reason: err_packet.clone()
3016 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3017 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3018 channel_id: self.channel_id(),
3019 htlc_id: htlc.htlc_id,
3020 sha256_of_onion: sha256_of_onion.clone(),
3021 failure_code: failure_code.clone(),
3024 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3025 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3026 channel_id: self.channel_id(),
3027 htlc_id: htlc.htlc_id,
3028 payment_preimage: payment_preimage.clone(),
3035 log_trace!(logger, "Regenerated latest commitment update in channel {} with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3036 log_bytes!(self.channel_id()), update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3037 msgs::CommitmentUpdate {
3038 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
3040 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,
3044 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3045 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3046 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 {
3047 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3048 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3049 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3050 // just close here instead of trying to recover.
3051 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3054 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3055 msg.next_local_commitment_number == 0 {
3056 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3059 if msg.next_remote_commitment_number > 0 {
3060 match msg.data_loss_protect {
3061 OptionalField::Present(ref data_loss) => {
3062 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3063 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3064 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3065 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3066 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3068 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3069 return Err(ChannelError::CloseDelayBroadcast(
3070 "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()
3074 OptionalField::Absent => {}
3078 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3079 // remaining cases either succeed or ErrorMessage-fail).
3080 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3082 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3083 Some(msgs::Shutdown {
3084 channel_id: self.channel_id,
3085 scriptpubkey: self.get_closing_scriptpubkey(),
3089 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3090 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3091 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3092 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3093 if msg.next_remote_commitment_number != 0 {
3094 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3096 // Short circuit the whole handler as there is nothing we can resend them
3097 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3100 // We have OurFundingLocked set!
3101 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3102 return Ok((Some(msgs::FundingLocked {
3103 channel_id: self.channel_id(),
3104 next_per_commitment_point,
3105 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3108 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3109 // Remote isn't waiting on any RevokeAndACK from us!
3110 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3112 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3113 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3114 self.monitor_pending_revoke_and_ack = true;
3117 Some(self.get_last_revoke_and_ack())
3120 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3123 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3124 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3125 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3126 // the corresponding revoke_and_ack back yet.
3127 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 };
3129 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3130 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3131 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3132 Some(msgs::FundingLocked {
3133 channel_id: self.channel_id(),
3134 next_per_commitment_point,
3138 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3139 if required_revoke.is_some() {
3140 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3142 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3145 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3146 // We're up-to-date and not waiting on a remote revoke (if we are our
3147 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3148 // have received some updates while we were disconnected. Free the holding cell
3150 match self.free_holding_cell_htlcs(logger) {
3151 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3152 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3153 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3154 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3156 Ok((None, htlcs_to_fail)) => {
3157 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3161 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3163 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3164 if required_revoke.is_some() {
3165 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3167 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3170 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3171 self.monitor_pending_commitment_signed = true;
3172 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3175 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3177 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3181 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3182 where F::Target: FeeEstimator
3184 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3185 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3186 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3190 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3191 if self.feerate_per_kw > proposed_feerate {
3192 proposed_feerate = self.feerate_per_kw;
3194 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3195 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3197 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3198 let sig = self.holder_signer
3199 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3201 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3202 if sig.is_none() { return None; }
3204 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3205 Some(msgs::ClosingSigned {
3206 channel_id: self.channel_id,
3207 fee_satoshis: total_fee_satoshis,
3208 signature: sig.unwrap(),
3212 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3213 where F::Target: FeeEstimator
3215 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3216 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3218 if self.channel_state < ChannelState::FundingSent as u32 {
3219 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3220 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3221 // can do that via error message without getting a connection fail anyway...
3222 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3224 for htlc in self.pending_inbound_htlcs.iter() {
3225 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3226 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3229 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3231 if is_unsupported_shutdown_script(&their_features, &msg.scriptpubkey) {
3232 return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3235 if self.counterparty_shutdown_scriptpubkey.is_some() {
3236 if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3237 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3240 self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3243 // From here on out, we may not fail!
3245 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3246 self.update_time_counter += 1;
3248 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3249 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3250 // cell HTLCs and return them to fail the payment.
3251 self.holding_cell_update_fee = None;
3252 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3253 self.holding_cell_htlc_updates.retain(|htlc_update| {
3255 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3256 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3262 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3263 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3264 // any further commitment updates after we set LocalShutdownSent.
3266 let shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3269 Some(msgs::Shutdown {
3270 channel_id: self.channel_id,
3271 scriptpubkey: self.get_closing_scriptpubkey(),
3275 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3276 self.update_time_counter += 1;
3278 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
3281 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3282 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3283 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3284 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3286 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3288 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3289 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3290 if funding_key[..] < counterparty_funding_key[..] {
3291 tx.input[0].witness.push(sig.serialize_der().to_vec());
3292 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3294 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3295 tx.input[0].witness.push(sig.serialize_der().to_vec());
3297 tx.input[0].witness[1].push(SigHashType::All as u8);
3298 tx.input[0].witness[2].push(SigHashType::All as u8);
3300 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3303 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3304 where F::Target: FeeEstimator
3306 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3307 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3309 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3310 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3312 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3313 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3315 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3316 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3319 let funding_redeemscript = self.get_funding_redeemscript();
3320 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3321 if used_total_fee != msg.fee_satoshis {
3322 return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee greater than the value they can claim. Fee in message: {}", msg.fee_satoshis)));
3324 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3326 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3329 // The remote end may have decided to revoke their output due to inconsistent dust
3330 // limits, so check for that case by re-checking the signature here.
3331 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3332 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3333 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3337 let closing_tx_max_weight = self.get_closing_transaction_weight(
3338 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3339 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3340 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3341 if last_fee == msg.fee_satoshis {
3342 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3343 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3344 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3345 self.channel_state = ChannelState::ShutdownComplete as u32;
3346 self.update_time_counter += 1;
3347 return Ok((None, Some(closing_tx)));
3351 macro_rules! propose_new_feerate {
3352 ($new_feerate: expr) => {
3353 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3354 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3355 let sig = self.holder_signer
3356 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3357 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3358 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3359 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3360 return Ok((Some(msgs::ClosingSigned {
3361 channel_id: self.channel_id,
3362 fee_satoshis: used_total_fee,
3368 let mut min_feerate = 253;
3369 if self.is_outbound() {
3370 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3371 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3372 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3373 if max_feerate <= last_feerate {
3374 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something higher ({}) than our Normal feerate ({})", last_feerate, max_feerate)));
3377 propose_new_feerate!(max_feerate);
3380 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3382 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3383 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3384 if min_feerate >= last_feerate {
3385 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something lower ({}) than our Background feerate ({}).", last_feerate, min_feerate)));
3388 propose_new_feerate!(min_feerate);
3391 let sig = self.holder_signer
3392 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3393 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3394 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3395 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3396 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3398 self.channel_state = ChannelState::ShutdownComplete as u32;
3399 self.update_time_counter += 1;
3401 Ok((Some(msgs::ClosingSigned {
3402 channel_id: self.channel_id,
3403 fee_satoshis: msg.fee_satoshis,
3405 }), Some(closing_tx)))
3408 // Public utilities:
3410 pub fn channel_id(&self) -> [u8; 32] {
3414 pub fn minimum_depth(&self) -> Option<u32> {
3418 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3419 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3420 pub fn get_user_id(&self) -> u64 {
3424 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3425 /// is_usable() returns true).
3426 /// Allowed in any state (including after shutdown)
3427 pub fn get_short_channel_id(&self) -> Option<u64> {
3428 self.short_channel_id
3431 /// Returns the funding_txo we either got from our peer, or were given by
3432 /// get_outbound_funding_created.
3433 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3434 self.channel_transaction_parameters.funding_outpoint
3437 fn get_holder_selected_contest_delay(&self) -> u16 {
3438 self.channel_transaction_parameters.holder_selected_contest_delay
3441 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3442 &self.channel_transaction_parameters.holder_pubkeys
3445 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3446 self.channel_transaction_parameters.counterparty_parameters
3447 .as_ref().map(|params| params.selected_contest_delay)
3450 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3451 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3454 /// Allowed in any state (including after shutdown)
3455 pub fn get_counterparty_node_id(&self) -> PublicKey {
3456 self.counterparty_node_id
3459 /// Allowed in any state (including after shutdown)
3461 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3462 self.holder_htlc_minimum_msat
3465 /// Allowed in any state (including after shutdown)
3466 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3468 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3469 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3470 // channel might have been used to route very small values (either by honest users or as DoS).
3471 self.channel_value_satoshis * 1000 * 9 / 10,
3473 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3477 /// Allowed in any state (including after shutdown)
3478 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3479 self.counterparty_htlc_minimum_msat
3482 pub fn get_value_satoshis(&self) -> u64 {
3483 self.channel_value_satoshis
3486 pub fn get_fee_proportional_millionths(&self) -> u32 {
3487 self.config.forwarding_fee_proportional_millionths
3490 pub fn get_cltv_expiry_delta(&self) -> u16 {
3491 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3495 pub fn get_feerate(&self) -> u32 {
3499 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3500 self.cur_holder_commitment_transaction_number + 1
3503 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3504 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3507 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3508 self.cur_counterparty_commitment_transaction_number + 2
3512 pub fn get_signer(&self) -> &Signer {
3517 pub fn get_value_stat(&self) -> ChannelValueStat {
3519 value_to_self_msat: self.value_to_self_msat,
3520 channel_value_msat: self.channel_value_satoshis * 1000,
3521 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3522 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3523 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3524 holding_cell_outbound_amount_msat: {
3526 for h in self.holding_cell_htlc_updates.iter() {
3528 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3536 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3537 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3541 /// Allowed in any state (including after shutdown)
3542 pub fn get_update_time_counter(&self) -> u32 {
3543 self.update_time_counter
3546 pub fn get_latest_monitor_update_id(&self) -> u64 {
3547 self.latest_monitor_update_id
3550 pub fn should_announce(&self) -> bool {
3551 self.config.announced_channel
3554 pub fn is_outbound(&self) -> bool {
3555 self.channel_transaction_parameters.is_outbound_from_holder
3558 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3559 /// Allowed in any state (including after shutdown)
3560 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3561 self.config.forwarding_fee_base_msat
3564 /// Returns true if we've ever received a message from the remote end for this Channel
3565 pub fn have_received_message(&self) -> bool {
3566 self.channel_state > (ChannelState::OurInitSent as u32)
3569 /// Returns true if this channel is fully established and not known to be closing.
3570 /// Allowed in any state (including after shutdown)
3571 pub fn is_usable(&self) -> bool {
3572 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3573 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3576 /// Returns true if this channel is currently available for use. This is a superset of
3577 /// is_usable() and considers things like the channel being temporarily disabled.
3578 /// Allowed in any state (including after shutdown)
3579 pub fn is_live(&self) -> bool {
3580 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3583 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3584 /// Allowed in any state (including after shutdown)
3585 pub fn is_awaiting_monitor_update(&self) -> bool {
3586 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3589 /// Returns true if funding_created was sent/received.
3590 pub fn is_funding_initiated(&self) -> bool {
3591 self.channel_state >= ChannelState::FundingSent as u32
3594 /// Returns true if this channel is fully shut down. True here implies that no further actions
3595 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3596 /// will be handled appropriately by the chain monitor.
3597 pub fn is_shutdown(&self) -> bool {
3598 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3599 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3604 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3605 self.channel_update_status
3608 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3609 self.channel_update_status = status;
3612 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3613 if self.funding_tx_confirmation_height == 0 {
3617 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3618 if funding_tx_confirmations <= 0 {
3619 self.funding_tx_confirmation_height = 0;
3622 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3626 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3627 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3628 self.channel_state |= ChannelState::OurFundingLocked as u32;
3630 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3631 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3632 self.update_time_counter += 1;
3634 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3635 // We got a reorg but not enough to trigger a force close, just ignore.
3637 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3638 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3640 // We got a reorg but not enough to trigger a force close, just ignore.
3644 if need_commitment_update {
3645 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3646 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3647 return Some(msgs::FundingLocked {
3648 channel_id: self.channel_id,
3649 next_per_commitment_point,
3652 self.monitor_pending_funding_locked = true;
3658 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3659 /// In the first case, we store the confirmation height and calculating the short channel id.
3660 /// In the second, we simply return an Err indicating we need to be force-closed now.
3661 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3662 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3663 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3664 for &(index_in_block, tx) in txdata.iter() {
3665 if let Some(funding_txo) = self.get_funding_txo() {
3666 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3667 // whether they've sent a funding_locked or not), check if we should send one.
3668 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3669 if tx.txid() == funding_txo.txid {
3670 let txo_idx = funding_txo.index as usize;
3671 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3672 tx.output[txo_idx].value != self.channel_value_satoshis {
3673 if self.is_outbound() {
3674 // If we generated the funding transaction and it doesn't match what it
3675 // should, the client is really broken and we should just panic and
3676 // tell them off. That said, because hash collisions happen with high
3677 // probability in fuzztarget mode, if we're fuzzing we just close the
3678 // channel and move on.
3679 #[cfg(not(feature = "fuzztarget"))]
3680 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3682 self.update_time_counter += 1;
3683 return Err(msgs::ErrorMessage {
3684 channel_id: self.channel_id(),
3685 data: "funding tx had wrong script/value or output index".to_owned()
3688 if self.is_outbound() {
3689 for input in tx.input.iter() {
3690 if input.witness.is_empty() {
3691 // We generated a malleable funding transaction, implying we've
3692 // just exposed ourselves to funds loss to our counterparty.
3693 #[cfg(not(feature = "fuzztarget"))]
3694 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3698 self.funding_tx_confirmation_height = height;
3699 self.funding_tx_confirmed_in = Some(*block_hash);
3700 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3701 Ok(scid) => Some(scid),
3702 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3706 // If we allow 1-conf funding, we may need to check for funding_locked here and
3707 // send it immediately instead of waiting for a best_block_updated call (which
3708 // may have already happened for this block).
3709 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3710 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3711 return Ok(Some(funding_locked));
3714 for inp in tx.input.iter() {
3715 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3716 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()));
3717 return Err(msgs::ErrorMessage {
3718 channel_id: self.channel_id(),
3719 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3728 /// When a new block is connected, we check the height of the block against outbound holding
3729 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3730 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3731 /// handled by the ChannelMonitor.
3733 /// If we return Err, the channel may have been closed, at which point the standard
3734 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3737 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3739 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
3740 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
3741 let mut timed_out_htlcs = Vec::new();
3742 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3743 self.holding_cell_htlc_updates.retain(|htlc_update| {
3745 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3746 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3747 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3755 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3757 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3758 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3759 return Ok((Some(funding_locked), timed_out_htlcs));
3762 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3763 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3764 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3765 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3766 if self.funding_tx_confirmation_height == 0 {
3767 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3768 // zero if it has been reorged out, however in either case, our state flags
3769 // indicate we've already sent a funding_locked
3770 funding_tx_confirmations = 0;
3773 // If we've sent funding_locked (or have both sent and received funding_locked), and
3774 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3775 // close the channel and hope we can get the latest state on chain (because presumably
3776 // the funding transaction is at least still in the mempool of most nodes).
3777 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
3778 return Err(msgs::ErrorMessage {
3779 channel_id: self.channel_id(),
3780 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
3785 Ok((None, timed_out_htlcs))
3788 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
3789 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
3790 /// before the channel has reached funding_locked and we can just wait for more blocks.
3791 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
3792 if self.funding_tx_confirmation_height != 0 {
3793 // We handle the funding disconnection by calling best_block_updated with a height one
3794 // below where our funding was connected, implying a reorg back to conf_height - 1.
3795 let reorg_height = self.funding_tx_confirmation_height - 1;
3796 // We use the time field to bump the current time we set on channel updates if its
3797 // larger. If we don't know that time has moved forward, we can just set it to the last
3798 // time we saw and it will be ignored.
3799 let best_time = self.update_time_counter;
3800 match self.best_block_updated(reorg_height, best_time, logger) {
3801 Ok((funding_locked, timed_out_htlcs)) => {
3802 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
3803 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
3809 // We never learned about the funding confirmation anyway, just ignore
3814 // Methods to get unprompted messages to send to the remote end (or where we already returned
3815 // something in the handler for the message that prompted this message):
3817 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3818 if !self.is_outbound() {
3819 panic!("Tried to open a channel for an inbound channel?");
3821 if self.channel_state != ChannelState::OurInitSent as u32 {
3822 panic!("Cannot generate an open_channel after we've moved forward");
3825 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3826 panic!("Tried to send an open_channel for a channel that has already advanced");
3829 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3830 let keys = self.get_holder_pubkeys();
3834 temporary_channel_id: self.channel_id,
3835 funding_satoshis: self.channel_value_satoshis,
3836 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3837 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3838 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3839 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3840 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3841 feerate_per_kw: self.feerate_per_kw as u32,
3842 to_self_delay: self.get_holder_selected_contest_delay(),
3843 max_accepted_htlcs: OUR_MAX_HTLCS,
3844 funding_pubkey: keys.funding_pubkey,
3845 revocation_basepoint: keys.revocation_basepoint,
3846 payment_point: keys.payment_point,
3847 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3848 htlc_basepoint: keys.htlc_basepoint,
3849 first_per_commitment_point,
3850 channel_flags: if self.config.announced_channel {1} else {0},
3851 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3855 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3856 if self.is_outbound() {
3857 panic!("Tried to send accept_channel for an outbound channel?");
3859 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3860 panic!("Tried to send accept_channel after channel had moved forward");
3862 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3863 panic!("Tried to send an accept_channel for a channel that has already advanced");
3866 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3867 let keys = self.get_holder_pubkeys();
3869 msgs::AcceptChannel {
3870 temporary_channel_id: self.channel_id,
3871 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3872 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3873 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3874 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3875 minimum_depth: self.minimum_depth.unwrap(),
3876 to_self_delay: self.get_holder_selected_contest_delay(),
3877 max_accepted_htlcs: OUR_MAX_HTLCS,
3878 funding_pubkey: keys.funding_pubkey,
3879 revocation_basepoint: keys.revocation_basepoint,
3880 payment_point: keys.payment_point,
3881 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3882 htlc_basepoint: keys.htlc_basepoint,
3883 first_per_commitment_point,
3884 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3888 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3889 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3890 let counterparty_keys = self.build_remote_transaction_keys()?;
3891 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
3892 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3893 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3896 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3897 /// a funding_created message for the remote peer.
3898 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3899 /// or if called on an inbound channel.
3900 /// Note that channel_id changes during this call!
3901 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3902 /// If an Err is returned, it is a ChannelError::Close.
3903 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 {
3904 if !self.is_outbound() {
3905 panic!("Tried to create outbound funding_created message on an inbound channel!");
3907 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3908 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)");
3910 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3911 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3912 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3913 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3916 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3917 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3919 let signature = match self.get_outbound_funding_created_signature(logger) {
3922 log_error!(logger, "Got bad signatures: {:?}!", e);
3923 self.channel_transaction_parameters.funding_outpoint = None;
3928 let temporary_channel_id = self.channel_id;
3930 // Now that we're past error-generating stuff, update our local state:
3932 self.channel_state = ChannelState::FundingCreated as u32;
3933 self.channel_id = funding_txo.to_channel_id();
3934 self.funding_transaction = Some(funding_transaction);
3936 Ok(msgs::FundingCreated {
3937 temporary_channel_id,
3938 funding_txid: funding_txo.txid,
3939 funding_output_index: funding_txo.index,
3944 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3945 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3946 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3947 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3948 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3950 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3951 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3953 /// This will only return ChannelError::Ignore upon failure.
3954 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3955 if !self.config.announced_channel {
3956 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3958 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3959 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3961 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3962 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3965 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
3967 let msg = msgs::UnsignedChannelAnnouncement {
3968 features: ChannelFeatures::known(),
3970 short_channel_id: self.get_short_channel_id().unwrap(),
3971 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
3972 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
3973 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
3974 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
3975 excess_data: Vec::new(),
3978 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
3979 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
3984 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
3986 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> {
3987 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
3988 let were_node_one = announcement.node_id_1 == our_node_id;
3990 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
3991 Ok(msgs::ChannelAnnouncement {
3992 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
3993 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
3994 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
3995 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
3996 contents: announcement,
3999 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4003 /// Processes an incoming announcement_signatures message, providing a fully-signed
4004 /// channel_announcement message which we can broadcast and storing our counterparty's
4005 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4006 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4007 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4009 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4011 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4012 return Err(ChannelError::Close(format!(
4013 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4014 &announcement, self.get_counterparty_node_id())));
4016 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4017 return Err(ChannelError::Close(format!(
4018 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4019 &announcement, self.counterparty_funding_pubkey())));
4022 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4024 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4027 /// Gets a signed channel_announcement for this channel, if we previously received an
4028 /// announcement_signatures from our counterparty.
4029 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4030 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4032 Err(_) => return None,
4034 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4035 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4036 Ok(res) => Some(res),
4041 /// May panic if called on a channel that wasn't immediately-previously
4042 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4043 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4044 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4045 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4046 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4047 // current to_remote balances. However, it no longer has any use, and thus is now simply
4048 // set to a dummy (but valid, as required by the spec) public key.
4049 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4050 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4051 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4052 let mut pk = [2; 33]; pk[1] = 0xff;
4053 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4054 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4055 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4056 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()));
4057 OptionalField::Present(DataLossProtect {
4058 your_last_per_commitment_secret: remote_last_secret,
4059 my_current_per_commitment_point: dummy_pubkey
4062 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4063 OptionalField::Present(DataLossProtect {
4064 your_last_per_commitment_secret: [0;32],
4065 my_current_per_commitment_point: dummy_pubkey,
4068 msgs::ChannelReestablish {
4069 channel_id: self.channel_id(),
4070 // The protocol has two different commitment number concepts - the "commitment
4071 // transaction number", which starts from 0 and counts up, and the "revocation key
4072 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4073 // commitment transaction numbers by the index which will be used to reveal the
4074 // revocation key for that commitment transaction, which means we have to convert them
4075 // to protocol-level commitment numbers here...
4077 // next_local_commitment_number is the next commitment_signed number we expect to
4078 // receive (indicating if they need to resend one that we missed).
4079 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4080 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4081 // receive, however we track it by the next commitment number for a remote transaction
4082 // (which is one further, as they always revoke previous commitment transaction, not
4083 // the one we send) so we have to decrement by 1. Note that if
4084 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4085 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4087 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4093 // Send stuff to our remote peers:
4095 /// Adds a pending outbound HTLC to this channel, note that you probably want
4096 /// send_htlc_and_commit instead cause you'll want both messages at once.
4098 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4100 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4101 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4103 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4104 /// may not yet have sent the previous commitment update messages and will need to regenerate
4107 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4109 /// If an Err is returned, it's a ChannelError::Ignore!
4110 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> {
4111 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4112 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4114 let channel_total_msat = self.channel_value_satoshis * 1000;
4115 if amount_msat > channel_total_msat {
4116 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4119 if amount_msat == 0 {
4120 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4123 if amount_msat < self.counterparty_htlc_minimum_msat {
4124 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4127 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4128 // Note that this should never really happen, if we're !is_live() on receipt of an
4129 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4130 // the user to send directly into a !is_live() channel. However, if we
4131 // disconnected during the time the previous hop was doing the commitment dance we may
4132 // end up getting here after the forwarding delay. In any case, returning an
4133 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4134 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4137 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
4138 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
4139 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4141 // Check their_max_htlc_value_in_flight_msat
4142 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4143 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)));
4146 if !self.is_outbound() {
4147 // Check that we won't violate the remote channel reserve by adding this HTLC.
4148 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4149 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4150 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4151 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4152 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4153 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4157 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
4158 if pending_value_to_self_msat < amount_msat {
4159 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)));
4162 // `2 *` and extra HTLC are for the fee spike buffer.
4163 let commit_tx_fee_msat = if self.is_outbound() {
4164 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4165 2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4167 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4168 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)));
4171 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4172 // reserve for the remote to have something to claim if we misbehave)
4173 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4174 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4175 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4178 // Now update local state:
4179 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4180 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4185 onion_routing_packet,
4190 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4191 htlc_id: self.next_holder_htlc_id,
4193 payment_hash: payment_hash.clone(),
4195 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4199 let res = msgs::UpdateAddHTLC {
4200 channel_id: self.channel_id,
4201 htlc_id: self.next_holder_htlc_id,
4205 onion_routing_packet,
4207 self.next_holder_htlc_id += 1;
4212 /// Creates a signed commitment transaction to send to the remote peer.
4213 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4214 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4215 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4216 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4217 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4218 panic!("Cannot create commitment tx until channel is fully established");
4220 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4221 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4223 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4224 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4226 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4227 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");
4229 let mut have_updates = self.pending_update_fee.is_some();
4230 for htlc in self.pending_outbound_htlcs.iter() {
4231 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4232 have_updates = true;
4234 if have_updates { break; }
4236 for htlc in self.pending_inbound_htlcs.iter() {
4237 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4238 have_updates = true;
4240 if have_updates { break; }
4243 panic!("Cannot create commitment tx until we have some updates to send");
4245 self.send_commitment_no_status_check(logger)
4247 /// Only fails in case of bad keys
4248 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4249 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4250 // fail to generate this, we still are at least at a position where upgrading their status
4252 for htlc in self.pending_inbound_htlcs.iter_mut() {
4253 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4254 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4256 if let Some(state) = new_state {
4260 for htlc in self.pending_outbound_htlcs.iter_mut() {
4261 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4262 Some(fail_reason.take())
4264 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4267 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4269 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4270 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4271 // Update state now that we've passed all the can-fail calls...
4272 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4273 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4274 (res, counterparty_commitment_tx, htlcs_no_ref)
4276 Err(e) => return Err(e),
4279 self.latest_monitor_update_id += 1;
4280 let monitor_update = ChannelMonitorUpdate {
4281 update_id: self.latest_monitor_update_id,
4282 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4283 commitment_txid: counterparty_commitment_txid,
4284 htlc_outputs: htlcs.clone(),
4285 commitment_number: self.cur_counterparty_commitment_transaction_number,
4286 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4289 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4290 Ok((res, monitor_update))
4293 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4294 /// when we shouldn't change HTLC/channel state.
4295 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4296 let mut feerate_per_kw = self.feerate_per_kw;
4297 if let Some(feerate) = self.pending_update_fee {
4298 if self.is_outbound() {
4299 feerate_per_kw = feerate;
4303 let counterparty_keys = self.build_remote_transaction_keys()?;
4304 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4305 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4306 let (signature, htlc_signatures);
4308 #[cfg(any(test, feature = "fuzztarget"))]
4310 if !self.is_outbound() {
4311 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4312 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4313 if let Some(info) = projected_commit_tx_info {
4314 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4315 if info.total_pending_htlcs == total_pending_htlcs
4316 && info.next_holder_htlc_id == self.next_holder_htlc_id
4317 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4318 && info.feerate == self.feerate_per_kw {
4319 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4320 assert_eq!(actual_fee, info.fee);
4327 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4328 for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4332 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4333 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4335 htlc_signatures = res.1;
4337 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4338 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4339 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4340 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4342 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4343 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4344 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)),
4345 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4346 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4347 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4351 Ok((msgs::CommitmentSigned {
4352 channel_id: self.channel_id,
4355 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4358 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4359 /// to send to the remote peer in one go.
4360 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4362 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 {
4363 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4364 Some(update_add_htlc) => {
4365 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4366 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4372 /// Get forwarding information for the counterparty.
4373 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4374 self.counterparty_forwarding_info.clone()
4377 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4378 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4379 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4381 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4382 fee_base_msat: msg.contents.fee_base_msat,
4383 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4384 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4390 /// Begins the shutdown process, getting a message for the remote peer and returning all
4391 /// holding cell HTLCs for payment failure.
4392 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
4393 for htlc in self.pending_outbound_htlcs.iter() {
4394 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4395 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4398 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4399 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4400 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4402 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4403 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4406 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4407 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4408 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()});
4411 let closing_script = self.get_closing_scriptpubkey();
4413 // From here on out, we may not fail!
4414 if self.channel_state < ChannelState::FundingSent as u32 {
4415 self.channel_state = ChannelState::ShutdownComplete as u32;
4417 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4419 self.update_time_counter += 1;
4421 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4422 // our shutdown until we've committed all of the pending changes.
4423 self.holding_cell_update_fee = None;
4424 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4425 self.holding_cell_htlc_updates.retain(|htlc_update| {
4427 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4428 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4435 Ok((msgs::Shutdown {
4436 channel_id: self.channel_id,
4437 scriptpubkey: closing_script,
4438 }, dropped_outbound_htlcs))
4441 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4442 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4443 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4444 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4445 /// immediately (others we will have to allow to time out).
4446 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4447 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4448 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4449 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4450 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4451 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4453 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4454 // return them to fail the payment.
4455 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4456 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4458 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4459 dropped_outbound_htlcs.push((source, payment_hash));
4464 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4465 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4466 // returning a channel monitor update here would imply a channel monitor update before
4467 // we even registered the channel monitor to begin with, which is invalid.
4468 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4469 // funding transaction, don't return a funding txo (which prevents providing the
4470 // monitor update to the user, even if we return one).
4471 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4472 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4473 self.latest_monitor_update_id += 1;
4474 Some((funding_txo, ChannelMonitorUpdate {
4475 update_id: self.latest_monitor_update_id,
4476 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4481 self.channel_state = ChannelState::ShutdownComplete as u32;
4482 self.update_time_counter += 1;
4483 (monitor_update, dropped_outbound_htlcs)
4487 fn is_unsupported_shutdown_script(their_features: &InitFeatures, script: &Script) -> bool {
4488 // We restrain shutdown scripts to standards forms to avoid transactions not propagating on the p2p tx-relay network
4490 // BOLT 2 says we must only send a scriptpubkey of certain standard forms,
4491 // which for a a BIP-141-compliant witness program is at max 42 bytes in length.
4492 // So don't let the remote peer feed us some super fee-heavy script.
4493 let is_script_too_long = script.len() > 42;
4494 if is_script_too_long {
4498 if their_features.supports_shutdown_anysegwit() && script.is_witness_program() && script.as_bytes()[0] != OP_PUSHBYTES_0.into_u8() {
4502 return !script.is_p2pkh() && !script.is_p2sh() && !script.is_v0_p2wpkh() && !script.is_v0_p2wsh()
4505 const SERIALIZATION_VERSION: u8 = 2;
4506 const MIN_SERIALIZATION_VERSION: u8 = 1;
4508 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4514 impl Writeable for ChannelUpdateStatus {
4515 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4516 // We only care about writing out the current state as it was announced, ie only either
4517 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4518 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4520 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4521 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4522 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4523 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4529 impl Readable for ChannelUpdateStatus {
4530 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4531 Ok(match <u8 as Readable>::read(reader)? {
4532 0 => ChannelUpdateStatus::Enabled,
4533 1 => ChannelUpdateStatus::Disabled,
4534 _ => return Err(DecodeError::InvalidValue),
4539 impl<Signer: Sign> Writeable for Channel<Signer> {
4540 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4541 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4544 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4546 self.user_id.write(writer)?;
4548 // Write out the old serialization for the config object. This is read by version-1
4549 // deserializers, but we will read the version in the TLV at the end instead.
4550 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4551 self.config.cltv_expiry_delta.write(writer)?;
4552 self.config.announced_channel.write(writer)?;
4553 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4555 self.channel_id.write(writer)?;
4556 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4557 self.channel_value_satoshis.write(writer)?;
4559 self.latest_monitor_update_id.write(writer)?;
4561 let mut key_data = VecWriter(Vec::new());
4562 self.holder_signer.write(&mut key_data)?;
4563 assert!(key_data.0.len() < core::usize::MAX);
4564 assert!(key_data.0.len() < core::u32::MAX as usize);
4565 (key_data.0.len() as u32).write(writer)?;
4566 writer.write_all(&key_data.0[..])?;
4568 self.shutdown_pubkey.write(writer)?;
4569 self.destination_script.write(writer)?;
4571 self.cur_holder_commitment_transaction_number.write(writer)?;
4572 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4573 self.value_to_self_msat.write(writer)?;
4575 let mut dropped_inbound_htlcs = 0;
4576 for htlc in self.pending_inbound_htlcs.iter() {
4577 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4578 dropped_inbound_htlcs += 1;
4581 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4582 for htlc in self.pending_inbound_htlcs.iter() {
4583 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4586 htlc.htlc_id.write(writer)?;
4587 htlc.amount_msat.write(writer)?;
4588 htlc.cltv_expiry.write(writer)?;
4589 htlc.payment_hash.write(writer)?;
4591 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4592 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4594 htlc_state.write(writer)?;
4596 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4598 htlc_state.write(writer)?;
4600 &InboundHTLCState::Committed => {
4603 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4605 removal_reason.write(writer)?;
4610 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4611 for htlc in self.pending_outbound_htlcs.iter() {
4612 htlc.htlc_id.write(writer)?;
4613 htlc.amount_msat.write(writer)?;
4614 htlc.cltv_expiry.write(writer)?;
4615 htlc.payment_hash.write(writer)?;
4616 htlc.source.write(writer)?;
4618 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4620 onion_packet.write(writer)?;
4622 &OutboundHTLCState::Committed => {
4625 &OutboundHTLCState::RemoteRemoved(_) => {
4626 // Treat this as a Committed because we haven't received the CS - they'll
4627 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
4630 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4632 fail_reason.write(writer)?;
4634 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4636 fail_reason.write(writer)?;
4641 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4642 for update in self.holding_cell_htlc_updates.iter() {
4644 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4646 amount_msat.write(writer)?;
4647 cltv_expiry.write(writer)?;
4648 payment_hash.write(writer)?;
4649 source.write(writer)?;
4650 onion_routing_packet.write(writer)?;
4652 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4654 payment_preimage.write(writer)?;
4655 htlc_id.write(writer)?;
4657 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4659 htlc_id.write(writer)?;
4660 err_packet.write(writer)?;
4665 match self.resend_order {
4666 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4667 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4670 self.monitor_pending_funding_locked.write(writer)?;
4671 self.monitor_pending_revoke_and_ack.write(writer)?;
4672 self.monitor_pending_commitment_signed.write(writer)?;
4674 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4675 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4676 pending_forward.write(writer)?;
4677 htlc_id.write(writer)?;
4680 (self.monitor_pending_failures.len() as u64).write(writer)?;
4681 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4682 htlc_source.write(writer)?;
4683 payment_hash.write(writer)?;
4684 fail_reason.write(writer)?;
4687 self.pending_update_fee.write(writer)?;
4688 self.holding_cell_update_fee.write(writer)?;
4690 self.next_holder_htlc_id.write(writer)?;
4691 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4692 self.update_time_counter.write(writer)?;
4693 self.feerate_per_kw.write(writer)?;
4695 match self.last_sent_closing_fee {
4696 Some((feerate, fee, sig)) => {
4698 feerate.write(writer)?;
4702 None => 0u8.write(writer)?,
4705 self.funding_tx_confirmed_in.write(writer)?;
4706 self.funding_tx_confirmation_height.write(writer)?;
4707 self.short_channel_id.write(writer)?;
4709 self.counterparty_dust_limit_satoshis.write(writer)?;
4710 self.holder_dust_limit_satoshis.write(writer)?;
4711 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4713 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4714 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
4716 self.counterparty_htlc_minimum_msat.write(writer)?;
4717 self.holder_htlc_minimum_msat.write(writer)?;
4718 self.counterparty_max_accepted_htlcs.write(writer)?;
4720 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4721 self.minimum_depth.unwrap_or(0).write(writer)?;
4723 match &self.counterparty_forwarding_info {
4726 info.fee_base_msat.write(writer)?;
4727 info.fee_proportional_millionths.write(writer)?;
4728 info.cltv_expiry_delta.write(writer)?;
4730 None => 0u8.write(writer)?
4733 self.channel_transaction_parameters.write(writer)?;
4734 self.funding_transaction.write(writer)?;
4736 self.counterparty_cur_commitment_point.write(writer)?;
4737 self.counterparty_prev_commitment_point.write(writer)?;
4738 self.counterparty_node_id.write(writer)?;
4740 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4742 self.commitment_secrets.write(writer)?;
4744 self.channel_update_status.write(writer)?;
4746 #[cfg(any(test, feature = "fuzztarget"))]
4747 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
4748 #[cfg(any(test, feature = "fuzztarget"))]
4749 for htlc in self.historical_inbound_htlc_fulfills.iter() {
4750 htlc.write(writer)?;
4753 write_tlv_fields!(writer, {
4754 (0, self.announcement_sigs, option),
4755 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
4756 // default value instead of being Option<>al. Thus, to maintain compatibility we write
4757 // them twice, once with their original default values above, and once as an option
4758 // here. On the read side, old versions will simply ignore the odd-type entries here,
4759 // and new versions map the default values to None and allow the TLV entries here to
4761 (1, self.minimum_depth, option),
4762 (3, self.counterparty_selected_channel_reserve_satoshis, option),
4763 (5, self.config, required),
4770 const MAX_ALLOC_SIZE: usize = 64*1024;
4771 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4772 where K::Target: KeysInterface<Signer = Signer> {
4773 fn read<R : ::std::io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4774 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4776 let user_id = Readable::read(reader)?;
4778 let mut config = Some(ChannelConfig::default());
4780 // Read the old serialization of the ChannelConfig from version 0.0.98.
4781 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
4782 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
4783 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
4784 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
4786 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
4787 let mut _val: u64 = Readable::read(reader)?;
4790 let channel_id = Readable::read(reader)?;
4791 let channel_state = Readable::read(reader)?;
4792 let channel_value_satoshis = Readable::read(reader)?;
4794 let latest_monitor_update_id = Readable::read(reader)?;
4796 let keys_len: u32 = Readable::read(reader)?;
4797 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4798 while keys_data.len() != keys_len as usize {
4799 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4800 let mut data = [0; 1024];
4801 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4802 reader.read_exact(read_slice)?;
4803 keys_data.extend_from_slice(read_slice);
4805 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4807 let shutdown_pubkey = Readable::read(reader)?;
4808 let destination_script = Readable::read(reader)?;
4810 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4811 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4812 let value_to_self_msat = Readable::read(reader)?;
4814 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4815 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4816 for _ in 0..pending_inbound_htlc_count {
4817 pending_inbound_htlcs.push(InboundHTLCOutput {
4818 htlc_id: Readable::read(reader)?,
4819 amount_msat: Readable::read(reader)?,
4820 cltv_expiry: Readable::read(reader)?,
4821 payment_hash: Readable::read(reader)?,
4822 state: match <u8 as Readable>::read(reader)? {
4823 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4824 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4825 3 => InboundHTLCState::Committed,
4826 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4827 _ => return Err(DecodeError::InvalidValue),
4832 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4833 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4834 for _ in 0..pending_outbound_htlc_count {
4835 pending_outbound_htlcs.push(OutboundHTLCOutput {
4836 htlc_id: Readable::read(reader)?,
4837 amount_msat: Readable::read(reader)?,
4838 cltv_expiry: Readable::read(reader)?,
4839 payment_hash: Readable::read(reader)?,
4840 source: Readable::read(reader)?,
4841 state: match <u8 as Readable>::read(reader)? {
4842 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4843 1 => OutboundHTLCState::Committed,
4844 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4845 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4846 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4847 _ => return Err(DecodeError::InvalidValue),
4852 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4853 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4854 for _ in 0..holding_cell_htlc_update_count {
4855 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4856 0 => HTLCUpdateAwaitingACK::AddHTLC {
4857 amount_msat: Readable::read(reader)?,
4858 cltv_expiry: Readable::read(reader)?,
4859 payment_hash: Readable::read(reader)?,
4860 source: Readable::read(reader)?,
4861 onion_routing_packet: Readable::read(reader)?,
4863 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4864 payment_preimage: Readable::read(reader)?,
4865 htlc_id: Readable::read(reader)?,
4867 2 => HTLCUpdateAwaitingACK::FailHTLC {
4868 htlc_id: Readable::read(reader)?,
4869 err_packet: Readable::read(reader)?,
4871 _ => return Err(DecodeError::InvalidValue),
4875 let resend_order = match <u8 as Readable>::read(reader)? {
4876 0 => RAACommitmentOrder::CommitmentFirst,
4877 1 => RAACommitmentOrder::RevokeAndACKFirst,
4878 _ => return Err(DecodeError::InvalidValue),
4881 let monitor_pending_funding_locked = Readable::read(reader)?;
4882 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4883 let monitor_pending_commitment_signed = Readable::read(reader)?;
4885 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4886 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4887 for _ in 0..monitor_pending_forwards_count {
4888 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4891 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4892 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4893 for _ in 0..monitor_pending_failures_count {
4894 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4897 let pending_update_fee = Readable::read(reader)?;
4898 let holding_cell_update_fee = Readable::read(reader)?;
4900 let next_holder_htlc_id = Readable::read(reader)?;
4901 let next_counterparty_htlc_id = Readable::read(reader)?;
4902 let update_time_counter = Readable::read(reader)?;
4903 let feerate_per_kw = Readable::read(reader)?;
4905 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4907 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4908 _ => return Err(DecodeError::InvalidValue),
4911 let funding_tx_confirmed_in = Readable::read(reader)?;
4912 let funding_tx_confirmation_height = Readable::read(reader)?;
4913 let short_channel_id = Readable::read(reader)?;
4915 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4916 let holder_dust_limit_satoshis = Readable::read(reader)?;
4917 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4918 let mut counterparty_selected_channel_reserve_satoshis = None;
4920 // Read the old serialization from version 0.0.98.
4921 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
4923 // Read the 8 bytes of backwards-compatibility data.
4924 let _dummy: u64 = Readable::read(reader)?;
4926 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4927 let holder_htlc_minimum_msat = Readable::read(reader)?;
4928 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4930 let mut minimum_depth = None;
4932 // Read the old serialization from version 0.0.98.
4933 minimum_depth = Some(Readable::read(reader)?);
4935 // Read the 4 bytes of backwards-compatibility data.
4936 let _dummy: u32 = Readable::read(reader)?;
4939 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
4941 1 => Some(CounterpartyForwardingInfo {
4942 fee_base_msat: Readable::read(reader)?,
4943 fee_proportional_millionths: Readable::read(reader)?,
4944 cltv_expiry_delta: Readable::read(reader)?,
4946 _ => return Err(DecodeError::InvalidValue),
4949 let channel_parameters = Readable::read(reader)?;
4950 let funding_transaction = Readable::read(reader)?;
4952 let counterparty_cur_commitment_point = Readable::read(reader)?;
4954 let counterparty_prev_commitment_point = Readable::read(reader)?;
4955 let counterparty_node_id = Readable::read(reader)?;
4957 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
4958 let commitment_secrets = Readable::read(reader)?;
4960 let channel_update_status = Readable::read(reader)?;
4962 #[cfg(any(test, feature = "fuzztarget"))]
4963 let mut historical_inbound_htlc_fulfills = HashSet::new();
4964 #[cfg(any(test, feature = "fuzztarget"))]
4966 let htlc_fulfills_len: u64 = Readable::read(reader)?;
4967 for _ in 0..htlc_fulfills_len {
4968 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
4972 let mut announcement_sigs = None;
4973 read_tlv_fields!(reader, {
4974 (0, announcement_sigs, option),
4975 (1, minimum_depth, option),
4976 (3, counterparty_selected_channel_reserve_satoshis, option),
4977 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
4980 let mut secp_ctx = Secp256k1::new();
4981 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
4986 config: config.unwrap(),
4990 channel_value_satoshis,
4992 latest_monitor_update_id,
4998 cur_holder_commitment_transaction_number,
4999 cur_counterparty_commitment_transaction_number,
5002 pending_inbound_htlcs,
5003 pending_outbound_htlcs,
5004 holding_cell_htlc_updates,
5008 monitor_pending_funding_locked,
5009 monitor_pending_revoke_and_ack,
5010 monitor_pending_commitment_signed,
5011 monitor_pending_forwards,
5012 monitor_pending_failures,
5015 holding_cell_update_fee,
5016 next_holder_htlc_id,
5017 next_counterparty_htlc_id,
5018 update_time_counter,
5021 #[cfg(debug_assertions)]
5022 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5023 #[cfg(debug_assertions)]
5024 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5026 last_sent_closing_fee,
5028 funding_tx_confirmed_in,
5029 funding_tx_confirmation_height,
5032 counterparty_dust_limit_satoshis,
5033 holder_dust_limit_satoshis,
5034 counterparty_max_htlc_value_in_flight_msat,
5035 counterparty_selected_channel_reserve_satoshis,
5036 counterparty_htlc_minimum_msat,
5037 holder_htlc_minimum_msat,
5038 counterparty_max_accepted_htlcs,
5041 counterparty_forwarding_info,
5043 channel_transaction_parameters: channel_parameters,
5044 funding_transaction,
5046 counterparty_cur_commitment_point,
5047 counterparty_prev_commitment_point,
5048 counterparty_node_id,
5050 counterparty_shutdown_scriptpubkey,
5054 channel_update_status,
5058 #[cfg(any(test, feature = "fuzztarget"))]
5059 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5060 #[cfg(any(test, feature = "fuzztarget"))]
5061 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5063 workaround_lnd_bug_4006: None,
5065 #[cfg(any(test, feature = "fuzztarget"))]
5066 historical_inbound_htlc_fulfills,
5073 use bitcoin::util::bip143;
5074 use bitcoin::consensus::encode::serialize;
5075 use bitcoin::blockdata::script::{Script, Builder};
5076 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5077 use bitcoin::blockdata::constants::genesis_block;
5078 use bitcoin::blockdata::opcodes;
5079 use bitcoin::network::constants::Network;
5080 use bitcoin::hashes::hex::FromHex;
5082 use ln::{PaymentPreimage, PaymentHash};
5083 use ln::channelmanager::HTLCSource;
5084 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5085 use ln::channel::MAX_FUNDING_SATOSHIS;
5086 use ln::features::InitFeatures;
5087 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5089 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5090 use chain::BestBlock;
5091 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5092 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5093 use chain::transaction::OutPoint;
5094 use util::config::UserConfig;
5095 use util::enforcing_trait_impls::EnforcingSigner;
5096 use util::test_utils;
5097 use util::logger::Logger;
5098 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5099 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5100 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5101 use bitcoin::secp256k1::recovery::RecoverableSignature;
5102 use bitcoin::hashes::sha256::Hash as Sha256;
5103 use bitcoin::hashes::Hash;
5104 use bitcoin::hash_types::{Txid, WPubkeyHash};
5108 struct TestFeeEstimator {
5111 impl FeeEstimator for TestFeeEstimator {
5112 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5118 fn test_max_funding_satoshis() {
5119 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5120 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5124 signer: InMemorySigner,
5126 impl KeysInterface for Keys {
5127 type Signer = InMemorySigner;
5129 fn get_node_secret(&self) -> SecretKey { panic!(); }
5130 fn get_destination_script(&self) -> Script {
5131 let secp_ctx = Secp256k1::signing_only();
5132 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5133 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5134 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5137 fn get_shutdown_pubkey(&self) -> PublicKey {
5138 let secp_ctx = Secp256k1::signing_only();
5139 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5140 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
5143 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5146 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5147 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5148 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5151 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5152 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5155 // Check that, during channel creation, we use the same feerate in the open channel message
5156 // as we do in the Channel object creation itself.
5158 fn test_open_channel_msg_fee() {
5159 let original_fee = 253;
5160 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5161 let secp_ctx = Secp256k1::new();
5162 let seed = [42; 32];
5163 let network = Network::Testnet;
5164 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5166 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5167 let config = UserConfig::default();
5168 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
5170 // Now change the fee so we can check that the fee in the open_channel message is the
5171 // same as the old fee.
5172 fee_est.fee_est = 500;
5173 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5174 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5178 fn test_holder_vs_counterparty_dust_limit() {
5179 // Test that when calculating the local and remote commitment transaction fees, the correct
5180 // dust limits are used.
5181 let feeest = TestFeeEstimator{fee_est: 15000};
5182 let secp_ctx = Secp256k1::new();
5183 let seed = [42; 32];
5184 let network = Network::Testnet;
5185 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5187 // Go through the flow of opening a channel between two nodes, making sure
5188 // they have different dust limits.
5190 // Create Node A's channel pointing to Node B's pubkey
5191 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5192 let config = UserConfig::default();
5193 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5195 // Create Node B's channel by receiving Node A's open_channel message
5196 // Make sure A's dust limit is as we expect.
5197 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5198 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5199 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5201 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5202 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5203 accept_channel_msg.dust_limit_satoshis = 546;
5204 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5205 node_a_chan.holder_dust_limit_satoshis = 1560;
5207 // Put some inbound and outbound HTLCs in A's channel.
5208 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5209 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5211 amount_msat: htlc_amount_msat,
5212 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5213 cltv_expiry: 300000000,
5214 state: InboundHTLCState::Committed,
5217 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5219 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5220 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5221 cltv_expiry: 200000000,
5222 state: OutboundHTLCState::Committed,
5223 source: HTLCSource::OutboundRoute {
5225 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5226 first_hop_htlc_msat: 548,
5230 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5231 // the dust limit check.
5232 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5233 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5234 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5235 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5237 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5238 // of the HTLCs are seen to be above the dust limit.
5239 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5240 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5241 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5242 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5243 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5247 fn test_timeout_vs_success_htlc_dust_limit() {
5248 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5249 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5250 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5251 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5252 let fee_est = TestFeeEstimator{fee_est: 253 };
5253 let secp_ctx = Secp256k1::new();
5254 let seed = [42; 32];
5255 let network = Network::Testnet;
5256 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5258 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5259 let config = UserConfig::default();
5260 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, 10000000, 100000, 42, &config).unwrap();
5262 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5263 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5265 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5266 // counted as dust when it shouldn't be.
5267 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5268 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5269 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5270 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5272 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5273 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5274 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5275 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5276 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5278 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5280 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5281 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5282 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5283 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5284 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5286 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5287 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5288 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5289 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5290 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5294 fn channel_reestablish_no_updates() {
5295 let feeest = TestFeeEstimator{fee_est: 15000};
5296 let logger = test_utils::TestLogger::new();
5297 let secp_ctx = Secp256k1::new();
5298 let seed = [42; 32];
5299 let network = Network::Testnet;
5300 let best_block = BestBlock::from_genesis(network);
5301 let chain_hash = best_block.block_hash();
5302 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5304 // Go through the flow of opening a channel between two nodes.
5306 // Create Node A's channel pointing to Node B's pubkey
5307 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5308 let config = UserConfig::default();
5309 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5311 // Create Node B's channel by receiving Node A's open_channel message
5312 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5313 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5314 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();
5316 // Node B --> Node A: accept channel
5317 let accept_channel_msg = node_b_chan.get_accept_channel();
5318 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5320 // Node A --> Node B: funding created
5321 let output_script = node_a_chan.get_funding_redeemscript();
5322 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5323 value: 10000000, script_pubkey: output_script.clone(),
5325 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5326 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5327 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5329 // Node B --> Node A: funding signed
5330 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5332 // Now disconnect the two nodes and check that the commitment point in
5333 // Node B's channel_reestablish message is sane.
5334 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5335 let msg = node_b_chan.get_channel_reestablish(&&logger);
5336 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5337 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5338 match msg.data_loss_protect {
5339 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5340 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5345 // Check that the commitment point in Node A's channel_reestablish message
5347 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5348 let msg = node_a_chan.get_channel_reestablish(&&logger);
5349 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5350 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5351 match msg.data_loss_protect {
5352 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5353 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5360 fn channel_update() {
5361 let feeest = TestFeeEstimator{fee_est: 15000};
5362 let secp_ctx = Secp256k1::new();
5363 let seed = [42; 32];
5364 let network = Network::Testnet;
5365 let chain_hash = genesis_block(network).header.block_hash();
5366 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5368 // Create a channel.
5369 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5370 let config = UserConfig::default();
5371 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5372 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5373 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5374 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5376 // Make sure that receiving a channel update will update the Channel as expected.
5377 let update = ChannelUpdate {
5378 contents: UnsignedChannelUpdate {
5380 short_channel_id: 0,
5383 cltv_expiry_delta: 100,
5384 htlc_minimum_msat: 5,
5385 htlc_maximum_msat: OptionalField::Absent,
5387 fee_proportional_millionths: 11,
5388 excess_data: Vec::new(),
5390 signature: Signature::from(unsafe { FFISignature::new() })
5392 node_a_chan.channel_update(&update).unwrap();
5394 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5395 // change our official htlc_minimum_msat.
5396 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5397 match node_a_chan.counterparty_forwarding_info() {
5399 assert_eq!(info.cltv_expiry_delta, 100);
5400 assert_eq!(info.fee_base_msat, 110);
5401 assert_eq!(info.fee_proportional_millionths, 11);
5403 None => panic!("expected counterparty forwarding info to be Some")
5408 fn outbound_commitment_test() {
5409 // Test vectors from BOLT 3 Appendix C:
5410 let feeest = TestFeeEstimator{fee_est: 15000};
5411 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5412 let secp_ctx = Secp256k1::new();
5414 let mut signer = InMemorySigner::new(
5416 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5417 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5418 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5419 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5420 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5422 // These aren't set in the test vectors:
5423 [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],
5428 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5429 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5430 let keys_provider = Keys { signer: signer.clone() };
5432 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5433 let mut config = UserConfig::default();
5434 config.channel_options.announced_channel = false;
5435 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5436 chan.holder_dust_limit_satoshis = 546;
5437 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5439 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5441 let counterparty_pubkeys = ChannelPublicKeys {
5442 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5443 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5444 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5445 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5446 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5448 chan.channel_transaction_parameters.counterparty_parameters = Some(
5449 CounterpartyChannelTransactionParameters {
5450 pubkeys: counterparty_pubkeys.clone(),
5451 selected_contest_delay: 144
5453 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5454 signer.ready_channel(&chan.channel_transaction_parameters);
5456 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5457 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5459 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5460 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5462 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5463 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5465 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5466 // derived from a commitment_seed, so instead we copy it here and call
5467 // build_commitment_transaction.
5468 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5469 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5470 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5471 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5472 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5474 macro_rules! test_commitment {
5475 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5476 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5478 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5479 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5481 let htlcs = res.2.drain(..)
5482 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5486 let trusted_tx = commitment_tx.trust();
5487 let unsigned_tx = trusted_tx.built_transaction();
5488 let redeemscript = chan.get_funding_redeemscript();
5489 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5490 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5491 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5493 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5494 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5495 let mut counterparty_htlc_sigs = Vec::new();
5496 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5498 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5499 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5500 counterparty_htlc_sigs.push(remote_signature);
5502 assert_eq!(htlcs.len(), per_htlc.len());
5504 let holder_commitment_tx = HolderCommitmentTransaction::new(
5505 commitment_tx.clone(),
5506 counterparty_signature,
5507 counterparty_htlc_sigs,
5508 &chan.holder_signer.pubkeys().funding_pubkey,
5509 chan.counterparty_funding_pubkey()
5511 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5512 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5514 let funding_redeemscript = chan.get_funding_redeemscript();
5515 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5516 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5518 // ((htlc, counterparty_sig), (index, holder_sig))
5519 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5522 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5524 let ref htlc = htlcs[$htlc_idx];
5525 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5526 chan.get_counterparty_selected_contest_delay().unwrap(),
5527 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5528 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5529 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5530 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5532 let mut preimage: Option<PaymentPreimage> = None;
5535 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5536 if out == htlc.payment_hash {
5537 preimage = Some(PaymentPreimage([i; 32]));
5541 assert!(preimage.is_some());
5544 let htlc_sig = htlc_sig_iter.next().unwrap();
5545 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5547 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5548 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5549 let index = (htlc_sig.1).0;
5550 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5551 let trusted_tx = holder_commitment_tx.trust();
5552 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5553 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5555 assert!(htlc_sig_iter.next().is_none());
5559 // simple commitment tx with no HTLCs
5560 chan.value_to_self_msat = 7000000000;
5562 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5563 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5564 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5566 chan.pending_inbound_htlcs.push({
5567 let mut out = InboundHTLCOutput{
5569 amount_msat: 1000000,
5571 payment_hash: PaymentHash([0; 32]),
5572 state: InboundHTLCState::Committed,
5574 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5577 chan.pending_inbound_htlcs.push({
5578 let mut out = InboundHTLCOutput{
5580 amount_msat: 2000000,
5582 payment_hash: PaymentHash([0; 32]),
5583 state: InboundHTLCState::Committed,
5585 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5588 chan.pending_outbound_htlcs.push({
5589 let mut out = OutboundHTLCOutput{
5591 amount_msat: 2000000,
5593 payment_hash: PaymentHash([0; 32]),
5594 state: OutboundHTLCState::Committed,
5595 source: HTLCSource::dummy(),
5597 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5600 chan.pending_outbound_htlcs.push({
5601 let mut out = OutboundHTLCOutput{
5603 amount_msat: 3000000,
5605 payment_hash: PaymentHash([0; 32]),
5606 state: OutboundHTLCState::Committed,
5607 source: HTLCSource::dummy(),
5609 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5612 chan.pending_inbound_htlcs.push({
5613 let mut out = InboundHTLCOutput{
5615 amount_msat: 4000000,
5617 payment_hash: PaymentHash([0; 32]),
5618 state: InboundHTLCState::Committed,
5620 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5624 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5625 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5626 chan.feerate_per_kw = 0;
5628 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5629 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5630 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5633 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5634 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5635 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5638 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5639 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5640 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5643 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5644 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5645 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5648 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5649 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5650 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5653 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5654 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5655 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5658 // commitment tx with seven outputs untrimmed (maximum feerate)
5659 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5660 chan.feerate_per_kw = 647;
5662 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5663 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5664 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5667 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5668 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5669 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5672 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5673 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5674 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5677 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5678 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5679 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5682 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5683 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5684 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5687 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5688 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5689 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5692 // commitment tx with six outputs untrimmed (minimum feerate)
5693 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5694 chan.feerate_per_kw = 648;
5696 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5697 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5698 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5701 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5702 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5703 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5706 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5707 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5708 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5711 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5712 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5713 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5716 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5717 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5718 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5721 // commitment tx with six outputs untrimmed (maximum feerate)
5722 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5723 chan.feerate_per_kw = 2069;
5725 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5726 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5727 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5730 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5731 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5732 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5735 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5736 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5737 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5740 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5741 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5742 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5745 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5746 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5747 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5750 // commitment tx with five outputs untrimmed (minimum feerate)
5751 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5752 chan.feerate_per_kw = 2070;
5754 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5755 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5756 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5759 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5760 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5761 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5764 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5765 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5766 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5769 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5770 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5771 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5774 // commitment tx with five outputs untrimmed (maximum feerate)
5775 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5776 chan.feerate_per_kw = 2194;
5778 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5779 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5780 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5783 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5784 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5785 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5788 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5789 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5790 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5793 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5794 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5795 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5798 // commitment tx with four outputs untrimmed (minimum feerate)
5799 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5800 chan.feerate_per_kw = 2195;
5802 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5803 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5804 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5807 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5808 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5809 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5812 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5813 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5814 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5817 // commitment tx with four outputs untrimmed (maximum feerate)
5818 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5819 chan.feerate_per_kw = 3702;
5821 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5822 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5823 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5826 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5827 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5828 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5831 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5832 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5833 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5836 // commitment tx with three outputs untrimmed (minimum feerate)
5837 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5838 chan.feerate_per_kw = 3703;
5840 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5841 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5842 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5845 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5846 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5847 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5850 // commitment tx with three outputs untrimmed (maximum feerate)
5851 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5852 chan.feerate_per_kw = 4914;
5854 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5855 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5856 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5859 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5860 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5861 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5864 // commitment tx with two outputs untrimmed (minimum feerate)
5865 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5866 chan.feerate_per_kw = 4915;
5868 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5869 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5870 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5872 // commitment tx with two outputs untrimmed (maximum feerate)
5873 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5874 chan.feerate_per_kw = 9651180;
5876 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5877 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5878 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5880 // commitment tx with one output untrimmed (minimum feerate)
5881 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5882 chan.feerate_per_kw = 9651181;
5884 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5885 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5886 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5888 // commitment tx with fee greater than funder amount
5889 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5890 chan.feerate_per_kw = 9651936;
5892 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5893 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5894 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5896 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5897 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5898 chan.feerate_per_kw = 253;
5899 chan.pending_inbound_htlcs.clear();
5900 chan.pending_inbound_htlcs.push({
5901 let mut out = InboundHTLCOutput{
5903 amount_msat: 2000000,
5905 payment_hash: PaymentHash([0; 32]),
5906 state: InboundHTLCState::Committed,
5908 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5911 chan.pending_outbound_htlcs.clear();
5912 chan.pending_outbound_htlcs.push({
5913 let mut out = OutboundHTLCOutput{
5915 amount_msat: 5000000,
5917 payment_hash: PaymentHash([0; 32]),
5918 state: OutboundHTLCState::Committed,
5919 source: HTLCSource::dummy(),
5921 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5924 chan.pending_outbound_htlcs.push({
5925 let mut out = OutboundHTLCOutput{
5927 amount_msat: 5000000,
5929 payment_hash: PaymentHash([0; 32]),
5930 state: OutboundHTLCState::Committed,
5931 source: HTLCSource::dummy(),
5933 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5937 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
5938 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
5939 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5942 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
5943 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
5944 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5946 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
5947 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
5948 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
5950 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
5951 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
5952 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
5957 fn test_per_commitment_secret_gen() {
5958 // Test vectors from BOLT 3 Appendix D:
5960 let mut seed = [0; 32];
5961 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5962 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5963 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5965 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5966 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5967 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5969 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5970 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5972 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5973 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5975 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5976 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5977 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5981 fn test_key_derivation() {
5982 // Test vectors from BOLT 3 Appendix E:
5983 let secp_ctx = Secp256k1::new();
5985 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5986 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5988 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5989 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5991 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5992 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5994 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5995 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5997 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5998 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6000 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6001 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6003 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6004 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());