1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::BitcoinHash;
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode;
9 use bitcoin_hashes::{Hash, HashEngine};
10 use bitcoin_hashes::sha256::Hash as Sha256;
11 use bitcoin_hashes::hash160::Hash as Hash160;
12 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
14 use secp256k1::key::{PublicKey,SecretKey};
15 use secp256k1::{Secp256k1,Signature};
18 use ln::features::{ChannelFeatures, InitFeatures};
20 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
21 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep};
22 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
23 use ln::chan_utils::{CounterpartyCommitmentSecrets, LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys};
25 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
26 use chain::transaction::OutPoint;
27 use chain::keysinterface::{ChannelKeys, KeysInterface};
28 use util::transaction_utils;
29 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
30 use util::logger::{Logger, LogHolder};
31 use util::errors::APIError;
32 use util::config::{UserConfig,ChannelConfig};
35 use std::default::Default;
36 use std::{cmp,mem,fmt};
41 pub struct ChannelValueStat {
42 pub value_to_self_msat: u64,
43 pub channel_value_msat: u64,
44 pub channel_reserve_msat: u64,
45 pub pending_outbound_htlcs_amount_msat: u64,
46 pub pending_inbound_htlcs_amount_msat: u64,
47 pub holding_cell_outbound_amount_msat: u64,
48 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
51 enum InboundHTLCRemovalReason {
52 FailRelay(msgs::OnionErrorPacket),
53 FailMalformed(([u8; 32], u16)),
54 Fulfill(PaymentPreimage),
57 enum InboundHTLCState {
58 /// Added by remote, to be included in next local commitment tx.
59 RemoteAnnounced(PendingHTLCStatus),
60 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
61 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
62 /// accept this HTLC. Implies AwaitingRemoteRevoke.
63 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
64 /// a remote revoke_and_ack on a previous state before we can do so.
65 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
66 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
67 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
68 /// accept this HTLC. Implies AwaitingRemoteRevoke.
69 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
71 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
73 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
74 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
76 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
77 /// commitment transaction without it as otherwise we'll have to force-close the channel to
78 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
79 /// anyway). That said, ChannelMonitor does this for us (see
80 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
81 /// local state before then, once we're sure that the next commitment_signed and
82 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
83 LocalRemoved(InboundHTLCRemovalReason),
86 struct InboundHTLCOutput {
90 payment_hash: PaymentHash,
91 state: InboundHTLCState,
94 enum OutboundHTLCState {
95 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
96 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
97 /// we will promote to Committed (note that they may not accept it until the next time we
98 /// revoke, but we don't really care about that:
99 /// * they've revoked, so worst case we can announce an old state and get our (option on)
100 /// money back (though we won't), and,
101 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
102 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
103 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
104 /// we'll never get out of sync).
105 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
106 /// OutboundHTLCOutput's size just for a temporary bit
107 LocalAnnounced(Box<msgs::OnionPacket>),
109 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
110 /// the change (though they'll need to revoke before we fail the payment).
111 RemoteRemoved(Option<HTLCFailReason>),
112 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
113 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
114 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
115 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
116 /// remote revoke_and_ack on a previous state before we can do so.
117 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
118 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
119 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
120 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
121 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
122 /// revoke_and_ack to drop completely.
123 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
126 struct OutboundHTLCOutput {
130 payment_hash: PaymentHash,
131 state: OutboundHTLCState,
135 /// See AwaitingRemoteRevoke ChannelState for more info
136 enum HTLCUpdateAwaitingACK {
137 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
141 payment_hash: PaymentHash,
143 onion_routing_packet: msgs::OnionPacket,
146 payment_preimage: PaymentPreimage,
151 err_packet: msgs::OnionErrorPacket,
155 /// There are a few "states" and then a number of flags which can be applied:
156 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
157 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
158 /// move on to ChannelFunded.
159 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
160 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
161 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
163 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
164 OurInitSent = (1 << 0),
165 /// Implies we have received their open_channel/accept_channel message
166 TheirInitSent = (1 << 1),
167 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
168 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
169 /// upon receipt of funding_created, so simply skip this state.
171 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
172 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
173 /// and our counterparty consider the funding transaction confirmed.
175 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
176 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
177 TheirFundingLocked = (1 << 4),
178 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
179 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
180 OurFundingLocked = (1 << 5),
182 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
183 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
185 PeerDisconnected = (1 << 7),
186 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
187 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
188 /// outbound messages until they've managed to do so.
189 MonitorUpdateFailed = (1 << 8),
190 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
191 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
192 /// messages as then we will be unable to determine which HTLCs they included in their
193 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
195 /// Flag is set on ChannelFunded.
196 AwaitingRemoteRevoke = (1 << 9),
197 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
198 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
199 /// to respond with our own shutdown message when possible.
200 RemoteShutdownSent = (1 << 10),
201 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
202 /// point, we may not add any new HTLCs to the channel.
203 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
204 /// us their shutdown.
205 LocalShutdownSent = (1 << 11),
206 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
207 /// to drop us, but we store this anyway.
208 ShutdownComplete = 4096,
210 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
211 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
213 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
215 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
216 /// If channel is public, network should have a liveness view announced by us on a
217 /// best-effort, which means we may filter out some status transitions to avoid spam.
218 /// See further timer_chan_freshness_every_min.
221 /// Status has been gossiped.
223 /// Status has been changed.
225 /// Status has been marked to be gossiped at next flush
229 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
230 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
231 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
233 pub(super) struct Channel<ChanSigner: ChannelKeys> {
234 config: ChannelConfig,
238 channel_id: [u8; 32],
240 channel_outbound: bool,
241 secp_ctx: Secp256k1<secp256k1::All>,
242 channel_value_satoshis: u64,
244 latest_monitor_update_id: u64,
247 local_keys: ChanSigner,
249 pub(super) local_keys: ChanSigner,
250 shutdown_pubkey: PublicKey,
251 destination_script: Script,
253 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
254 // generation start at 0 and count up...this simplifies some parts of implementation at the
255 // cost of others, but should really just be changed.
257 cur_local_commitment_transaction_number: u64,
258 cur_remote_commitment_transaction_number: u64,
259 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
260 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
261 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
262 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
264 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
265 /// need to ensure we resend them in the order we originally generated them. Note that because
266 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
267 /// sufficient to simply set this to the opposite of any message we are generating as we
268 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
269 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
271 resend_order: RAACommitmentOrder,
273 monitor_pending_funding_locked: bool,
274 monitor_pending_revoke_and_ack: bool,
275 monitor_pending_commitment_signed: bool,
276 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
277 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
279 // pending_update_fee is filled when sending and receiving update_fee
280 // For outbound channel, feerate_per_kw is updated with the value from
281 // pending_update_fee when revoke_and_ack is received
283 // For inbound channel, feerate_per_kw is updated when it receives
284 // commitment_signed and revoke_and_ack is generated
285 // The pending value is kept when another pair of update_fee and commitment_signed
286 // is received during AwaitingRemoteRevoke and relieved when the expected
287 // revoke_and_ack is received and new commitment_signed is generated to be
288 // sent to the funder. Otherwise, the pending value is removed when receiving
289 // commitment_signed.
290 pending_update_fee: Option<u64>,
291 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
292 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
293 // is received. holding_cell_update_fee is updated when there are additional
294 // update_fee() during ChannelState::AwaitingRemoteRevoke.
295 holding_cell_update_fee: Option<u64>,
296 next_local_htlc_id: u64,
297 next_remote_htlc_id: u64,
298 channel_update_count: u32,
301 #[cfg(debug_assertions)]
302 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
303 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
304 #[cfg(debug_assertions)]
305 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
306 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
308 last_sent_closing_fee: Option<(u64, u64, Signature)>, // (feerate, fee, our_sig)
310 funding_txo: Option<OutPoint>,
312 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
313 /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
314 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
315 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
316 funding_tx_confirmed_in: Option<Sha256dHash>,
317 short_channel_id: Option<u64>,
318 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
319 /// ChannelManager deserialization (hence pub(super))
320 pub(super) last_block_connected: Sha256dHash,
321 funding_tx_confirmations: u64,
323 their_dust_limit_satoshis: u64,
325 pub(super) our_dust_limit_satoshis: u64,
327 our_dust_limit_satoshis: u64,
329 pub(super) their_max_htlc_value_in_flight_msat: u64,
331 their_max_htlc_value_in_flight_msat: u64,
332 //get_our_max_htlc_value_in_flight_msat(): u64,
333 /// minimum channel reserve for **self** to maintain - set by them.
334 their_channel_reserve_satoshis: u64,
335 //get_our_channel_reserve_satoshis(): u64,
336 their_htlc_minimum_msat: u64,
337 our_htlc_minimum_msat: u64,
338 their_to_self_delay: u16,
339 our_to_self_delay: u16,
341 pub their_max_accepted_htlcs: u16,
343 their_max_accepted_htlcs: u16,
344 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
347 their_pubkeys: Option<ChannelPublicKeys>,
349 their_cur_commitment_point: Option<PublicKey>,
351 their_prev_commitment_point: Option<PublicKey>,
352 their_node_id: PublicKey,
354 their_shutdown_scriptpubkey: Option<Script>,
356 /// Used exclusively to broadcast the latest local state, mostly a historical quirk that this
358 channel_monitor: Option<ChannelMonitor<ChanSigner>>,
359 commitment_secrets: CounterpartyCommitmentSecrets,
361 network_sync: UpdateStatus,
366 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
367 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
368 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
369 /// really allow for this, so instead we're stuck closing it out at that point.
370 const UNCONF_THRESHOLD: u32 = 6;
371 const SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT: u64 = 79; // prevout: 36, nSequence: 4, script len: 1, witness lengths: (3+1)/4, sig: 73/4, if-selector: 1, redeemScript: (6 ops + 2*33 pubkeys + 1*2 delay)/4
372 const B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT: u64 = 104; // prevout: 40, nSequence: 4, script len: 1, witness lengths: 3/4, sig: 73/4, pubkey: 33/4, output: 31 (TODO: Wrong? Useless?)
375 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
377 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
379 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
381 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
383 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
385 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
387 /// Used to return a simple Error back to ChannelManager. Will get converted to a
388 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
389 /// channel_id in ChannelManager.
390 pub(super) enum ChannelError {
391 Ignore(&'static str),
393 CloseDelayBroadcast {
395 update: ChannelMonitorUpdate,
399 impl fmt::Debug for ChannelError {
400 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
402 &ChannelError::Ignore(e) => write!(f, "Ignore : {}", e),
403 &ChannelError::Close(e) => write!(f, "Close : {}", e),
404 &ChannelError::CloseDelayBroadcast { msg, .. } => write!(f, "CloseDelayBroadcast : {}", msg)
409 macro_rules! secp_check {
410 ($res: expr, $err: expr) => {
413 Err(_) => return Err(ChannelError::Close($err)),
418 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
419 // Convert constants + channel value to limits:
420 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
421 channel_value_satoshis * 1000 / 10 //TODO
424 /// Returns a minimum channel reserve value **they** need to maintain
426 /// Guaranteed to return a value no larger than channel_value_satoshis
427 pub(crate) fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
428 let (q, _) = channel_value_satoshis.overflowing_div(100);
429 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
432 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
433 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
436 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
441 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel<ChanSigner>, APIError>
442 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
443 F::Target: FeeEstimator,
445 let chan_keys = keys_provider.get_channel_keys(false, channel_value_satoshis);
447 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
448 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
451 if push_msat > channel_value_satoshis * 1000 {
452 return Err(APIError::APIMisuseError{err: "push value > channel value"});
454 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
455 return Err(APIError::APIMisuseError{err: "Configured with an unreasonable our_to_self_delay putting user funds at risks"});
459 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
460 if Channel::<ChanSigner>::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate) {
461 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
464 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
468 config: config.channel_options.clone(),
470 channel_id: keys_provider.get_channel_id(),
471 channel_state: ChannelState::OurInitSent as u32,
472 channel_outbound: true,
473 secp_ctx: Secp256k1::new(),
474 channel_value_satoshis: channel_value_satoshis,
476 latest_monitor_update_id: 0,
478 local_keys: chan_keys,
479 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
480 destination_script: keys_provider.get_destination_script(),
482 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
483 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
484 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
486 pending_inbound_htlcs: Vec::new(),
487 pending_outbound_htlcs: Vec::new(),
488 holding_cell_htlc_updates: Vec::new(),
489 pending_update_fee: None,
490 holding_cell_update_fee: None,
491 next_local_htlc_id: 0,
492 next_remote_htlc_id: 0,
493 channel_update_count: 1,
495 resend_order: RAACommitmentOrder::CommitmentFirst,
497 monitor_pending_funding_locked: false,
498 monitor_pending_revoke_and_ack: false,
499 monitor_pending_commitment_signed: false,
500 monitor_pending_forwards: Vec::new(),
501 monitor_pending_failures: Vec::new(),
503 #[cfg(debug_assertions)]
504 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
505 #[cfg(debug_assertions)]
506 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
508 last_sent_closing_fee: None,
511 funding_tx_confirmed_in: None,
512 short_channel_id: None,
513 last_block_connected: Default::default(),
514 funding_tx_confirmations: 0,
516 feerate_per_kw: feerate,
517 their_dust_limit_satoshis: 0,
518 our_dust_limit_satoshis: Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate),
519 their_max_htlc_value_in_flight_msat: 0,
520 their_channel_reserve_satoshis: 0,
521 their_htlc_minimum_msat: 0,
522 our_htlc_minimum_msat: Channel::<ChanSigner>::derive_our_htlc_minimum_msat(feerate),
523 their_to_self_delay: 0,
524 our_to_self_delay: config.own_channel_config.our_to_self_delay,
525 their_max_accepted_htlcs: 0,
526 minimum_depth: 0, // Filled in in accept_channel
529 their_cur_commitment_point: None,
531 their_prev_commitment_point: None,
532 their_node_id: their_node_id,
534 their_shutdown_scriptpubkey: None,
536 channel_monitor: None,
537 commitment_secrets: CounterpartyCommitmentSecrets::new(),
539 network_sync: UpdateStatus::Fresh,
545 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
546 where F::Target: FeeEstimator
548 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
549 return Err(ChannelError::Close("Peer's feerate much too low"));
551 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
552 return Err(ChannelError::Close("Peer's feerate much too high"));
557 /// Creates a new channel from a remote sides' request for one.
558 /// Assumes chain_hash has already been checked and corresponds with what we expect!
559 pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel<ChanSigner>, ChannelError>
560 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
561 F::Target: FeeEstimator
563 let mut chan_keys = keys_provider.get_channel_keys(true, msg.funding_satoshis);
564 let their_pubkeys = ChannelPublicKeys {
565 funding_pubkey: msg.funding_pubkey,
566 revocation_basepoint: msg.revocation_basepoint,
567 payment_basepoint: msg.payment_basepoint,
568 delayed_payment_basepoint: msg.delayed_payment_basepoint,
569 htlc_basepoint: msg.htlc_basepoint
571 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
572 let mut local_config = (*config).channel_options.clone();
574 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
575 return Err(ChannelError::Close("Configured with an unreasonable our_to_self_delay putting user funds at risks"));
578 // Check sanity of message fields:
579 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
580 return Err(ChannelError::Close("funding value > 2^24"));
582 if msg.channel_reserve_satoshis > msg.funding_satoshis {
583 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
585 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
586 return Err(ChannelError::Close("push_msat larger than funding value"));
588 if msg.dust_limit_satoshis > msg.funding_satoshis {
589 return Err(ChannelError::Close("Peer never wants payout outputs?"));
591 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
592 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
594 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
595 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
597 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
599 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
600 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
602 if msg.max_accepted_htlcs < 1 {
603 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
605 if msg.max_accepted_htlcs > 483 {
606 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
609 // Now check against optional parameters as set by config...
610 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
611 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
613 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
614 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
616 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
617 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
619 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
620 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
622 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
623 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
625 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
626 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
628 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
629 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
632 // Convert things into internal flags and prep our state:
634 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
635 if config.peer_channel_config_limits.force_announced_channel_preference {
636 if local_config.announced_channel != their_announce {
637 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
640 // we either accept their preference or the preferences match
641 local_config.announced_channel = their_announce;
643 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
645 let our_dust_limit_satoshis = Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate);
646 let our_channel_reserve_satoshis = Channel::<ChanSigner>::get_our_channel_reserve_satoshis(msg.funding_satoshis);
647 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
648 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
650 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
651 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
653 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
654 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
657 // check if the funder's amount for the initial commitment tx is sufficient
658 // for full fee payment
659 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
660 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
661 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
664 let to_local_msat = msg.push_msat;
665 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
666 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
667 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
670 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
671 match &msg.shutdown_scriptpubkey {
672 &OptionalField::Present(ref script) => {
673 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
674 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
676 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
677 } else if script.len() == 0 {
679 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
681 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
684 // 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
685 &OptionalField::Absent => {
686 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
693 config: local_config,
695 channel_id: msg.temporary_channel_id,
696 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
697 channel_outbound: false,
698 secp_ctx: Secp256k1::new(),
700 latest_monitor_update_id: 0,
702 local_keys: chan_keys,
703 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
704 destination_script: keys_provider.get_destination_script(),
706 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
707 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
708 value_to_self_msat: msg.push_msat,
710 pending_inbound_htlcs: Vec::new(),
711 pending_outbound_htlcs: Vec::new(),
712 holding_cell_htlc_updates: Vec::new(),
713 pending_update_fee: None,
714 holding_cell_update_fee: None,
715 next_local_htlc_id: 0,
716 next_remote_htlc_id: 0,
717 channel_update_count: 1,
719 resend_order: RAACommitmentOrder::CommitmentFirst,
721 monitor_pending_funding_locked: false,
722 monitor_pending_revoke_and_ack: false,
723 monitor_pending_commitment_signed: false,
724 monitor_pending_forwards: Vec::new(),
725 monitor_pending_failures: Vec::new(),
727 #[cfg(debug_assertions)]
728 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
729 #[cfg(debug_assertions)]
730 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
732 last_sent_closing_fee: None,
735 funding_tx_confirmed_in: None,
736 short_channel_id: None,
737 last_block_connected: Default::default(),
738 funding_tx_confirmations: 0,
740 feerate_per_kw: msg.feerate_per_kw as u64,
741 channel_value_satoshis: msg.funding_satoshis,
742 their_dust_limit_satoshis: msg.dust_limit_satoshis,
743 our_dust_limit_satoshis: our_dust_limit_satoshis,
744 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
745 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
746 their_htlc_minimum_msat: msg.htlc_minimum_msat,
747 our_htlc_minimum_msat: Channel::<ChanSigner>::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
748 their_to_self_delay: msg.to_self_delay,
749 our_to_self_delay: config.own_channel_config.our_to_self_delay,
750 their_max_accepted_htlcs: msg.max_accepted_htlcs,
751 minimum_depth: config.own_channel_config.minimum_depth,
753 their_pubkeys: Some(their_pubkeys),
754 their_cur_commitment_point: Some(msg.first_per_commitment_point),
756 their_prev_commitment_point: None,
757 their_node_id: their_node_id,
759 their_shutdown_scriptpubkey,
761 channel_monitor: None,
762 commitment_secrets: CounterpartyCommitmentSecrets::new(),
764 network_sync: UpdateStatus::Fresh,
772 // Utilities to derive keys:
774 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
775 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), idx);
776 SecretKey::from_slice(&res).unwrap()
779 // Utilities to build transactions:
781 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
782 let mut sha = Sha256::engine();
783 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key());
785 let their_payment_basepoint = &self.their_pubkeys.as_ref().unwrap().payment_basepoint.serialize();
786 if self.channel_outbound {
787 sha.input(&our_payment_basepoint.serialize());
788 sha.input(their_payment_basepoint);
790 sha.input(their_payment_basepoint);
791 sha.input(&our_payment_basepoint.serialize());
793 let res = Sha256::from_engine(sha).into_inner();
795 ((res[26] as u64) << 5*8) |
796 ((res[27] as u64) << 4*8) |
797 ((res[28] as u64) << 3*8) |
798 ((res[29] as u64) << 2*8) |
799 ((res[30] as u64) << 1*8) |
800 ((res[31] as u64) << 0*8)
803 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
804 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
805 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
806 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
807 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
809 /// @local is used only to convert relevant internal structures which refer to remote vs local
810 /// to decide value of outputs and direction of HTLCs.
811 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
812 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
813 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
814 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
815 /// which peer generated this transaction and "to whom" this transaction flows.
816 /// Returns (the transaction built, the number of HTLC outputs which were present in the
817 /// transaction, the list of HTLCs which were not ignored when building the transaction).
818 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
819 /// sources are provided only for outbound HTLCs in the third return value.
821 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
822 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
825 let mut ins: Vec<TxIn> = Vec::new();
827 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
828 script_sig: Script::new(),
829 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
835 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
836 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
838 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
839 let mut remote_htlc_total_msat = 0;
840 let mut local_htlc_total_msat = 0;
841 let mut value_to_self_msat_offset = 0;
843 log_trace!(self, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), self.get_commitment_transaction_number_obscure_factor(), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
845 macro_rules! get_htlc_in_commitment {
846 ($htlc: expr, $offered: expr) => {
847 HTLCOutputInCommitment {
849 amount_msat: $htlc.amount_msat,
850 cltv_expiry: $htlc.cltv_expiry,
851 payment_hash: $htlc.payment_hash,
852 transaction_output_index: None
857 macro_rules! add_htlc_output {
858 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
859 if $outbound == local { // "offered HTLC output"
860 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
861 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
862 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
864 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
865 value: $htlc.amount_msat / 1000
866 }, Some((htlc_in_tx, $source))));
868 log_trace!(self, " ...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);
869 included_dust_htlcs.push((htlc_in_tx, $source));
872 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
873 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
874 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
875 txouts.push((TxOut { // "received HTLC output"
876 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
877 value: $htlc.amount_msat / 1000
878 }, Some((htlc_in_tx, $source))));
880 log_trace!(self, " ...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);
881 included_dust_htlcs.push((htlc_in_tx, $source));
887 for ref htlc in self.pending_inbound_htlcs.iter() {
888 let (include, state_name) = match htlc.state {
889 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
890 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
891 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
892 InboundHTLCState::Committed => (true, "Committed"),
893 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
897 add_htlc_output!(htlc, false, None, state_name);
898 remote_htlc_total_msat += htlc.amount_msat;
900 log_trace!(self, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
902 &InboundHTLCState::LocalRemoved(ref reason) => {
903 if generated_by_local {
904 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
905 value_to_self_msat_offset += htlc.amount_msat as i64;
914 for ref htlc in self.pending_outbound_htlcs.iter() {
915 let (include, state_name) = match htlc.state {
916 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
917 OutboundHTLCState::Committed => (true, "Committed"),
918 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
919 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
920 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
924 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
925 local_htlc_total_msat += htlc.amount_msat;
927 log_trace!(self, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
929 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
930 value_to_self_msat_offset -= htlc.amount_msat as i64;
932 OutboundHTLCState::RemoteRemoved(None) => {
933 if !generated_by_local {
934 value_to_self_msat_offset -= htlc.amount_msat as i64;
942 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
943 assert!(value_to_self_msat >= 0);
944 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
945 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
946 // "violate" their reserve value by couting those against it. Thus, we have to convert
947 // everything to i64 before subtracting as otherwise we can overflow.
948 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;
949 assert!(value_to_remote_msat >= 0);
951 #[cfg(debug_assertions)]
953 // Make sure that the to_self/to_remote is always either past the appropriate
954 // channel_reserve *or* it is making progress towards it.
955 let mut max_commitment_tx_output = if generated_by_local {
956 self.max_commitment_tx_output_local.lock().unwrap()
958 self.max_commitment_tx_output_remote.lock().unwrap()
960 debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
961 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
962 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
963 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
966 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
967 let (value_to_self, value_to_remote) = if self.channel_outbound {
968 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
970 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
973 let value_to_a = if local { value_to_self } else { value_to_remote };
974 let value_to_b = if local { value_to_remote } else { value_to_self };
976 if value_to_a >= (dust_limit_satoshis as i64) {
977 log_trace!(self, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
979 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
980 if local { self.their_to_self_delay } else { self.our_to_self_delay },
981 &keys.a_delayed_payment_key).to_v0_p2wsh(),
982 value: value_to_a as u64
986 if value_to_b >= (dust_limit_satoshis as i64) {
987 log_trace!(self, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
989 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
990 .push_slice(&Hash160::hash(&keys.b_payment_key.serialize())[..])
992 value: value_to_b as u64
996 transaction_utils::sort_outputs(&mut txouts, |a, b| {
997 if let &Some(ref a_htlc) = a {
998 if let &Some(ref b_htlc) = b {
999 a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
1000 // Note that due to hash collisions, we have to have a fallback comparison
1001 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1003 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
1004 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1005 // close the channel due to mismatches - they're doing something dumb:
1006 } else { cmp::Ordering::Equal }
1007 } else { cmp::Ordering::Equal }
1010 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
1011 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
1012 for (idx, mut out) in txouts.drain(..).enumerate() {
1013 outputs.push(out.0);
1014 if let Some((mut htlc, source_option)) = out.1.take() {
1015 htlc.transaction_output_index = Some(idx as u32);
1016 htlcs_included.push((htlc, source_option));
1019 let non_dust_htlc_count = htlcs_included.len();
1020 htlcs_included.append(&mut included_dust_htlcs);
1024 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1027 }, non_dust_htlc_count, htlcs_included)
1031 fn get_closing_scriptpubkey(&self) -> Script {
1032 let our_channel_close_key_hash = Hash160::hash(&self.shutdown_pubkey.serialize());
1033 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
1037 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
1038 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
1042 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1044 let mut ins: Vec<TxIn> = Vec::new();
1046 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
1047 script_sig: Script::new(),
1048 sequence: 0xffffffff,
1049 witness: Vec::new(),
1054 assert!(self.pending_inbound_htlcs.is_empty());
1055 assert!(self.pending_outbound_htlcs.is_empty());
1056 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1058 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1059 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1060 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
1062 if value_to_self < 0 {
1063 assert!(self.channel_outbound);
1064 total_fee_satoshis += (-value_to_self) as u64;
1065 } else if value_to_remote < 0 {
1066 assert!(!self.channel_outbound);
1067 total_fee_satoshis += (-value_to_remote) as u64;
1070 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1071 txouts.push((TxOut {
1072 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1073 value: value_to_remote as u64
1077 if value_to_self as u64 > self.our_dust_limit_satoshis {
1078 txouts.push((TxOut {
1079 script_pubkey: self.get_closing_scriptpubkey(),
1080 value: value_to_self as u64
1084 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1086 let mut outputs: Vec<TxOut> = Vec::new();
1087 for out in txouts.drain(..) {
1088 outputs.push(out.0);
1096 }, total_fee_satoshis)
1100 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1101 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1102 /// our counterparty!)
1103 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1104 /// TODO Some magic rust shit to compile-time check this?
1105 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1106 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1107 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key());
1108 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1109 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1111 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.payment_basepoint, &their_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys"))
1115 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1116 /// will sign and send to our counterparty.
1117 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1118 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1119 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1120 //may see payments to it!
1121 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key());
1122 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key());
1123 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key());
1124 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1126 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &their_pubkeys.delayed_payment_basepoint, &their_pubkeys.htlc_basepoint, &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1129 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1130 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1131 /// Panics if called before accept_channel/new_from_req
1132 pub fn get_funding_redeemscript(&self) -> Script {
1133 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
1134 make_funding_redeemscript(&our_funding_key, self.their_funding_pubkey())
1137 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1138 /// @local is used only to convert relevant internal structures which refer to remote vs local
1139 /// to decide value of outputs and direction of HTLCs.
1140 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1141 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { self.our_to_self_delay }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1144 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1145 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1146 /// Ok(_) if debug assertions are turned on and preconditions are met.
1147 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> {
1148 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1149 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1150 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1152 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1153 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1155 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1157 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1159 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1160 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1161 // these, but for now we just have to treat them as normal.
1163 let mut pending_idx = std::usize::MAX;
1164 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1165 if htlc.htlc_id == htlc_id_arg {
1166 assert_eq!(htlc.payment_hash, payment_hash_calc);
1168 InboundHTLCState::Committed => {},
1169 InboundHTLCState::LocalRemoved(ref reason) => {
1170 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1172 log_warn!(self, "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()));
1174 return Ok((None, None));
1177 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1178 // Don't return in release mode here so that we can update channel_monitor
1185 if pending_idx == std::usize::MAX {
1186 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1189 // Now update local state:
1191 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1192 // can claim it even if the channel hits the chain before we see their next commitment.
1193 self.latest_monitor_update_id += 1;
1194 let monitor_update = ChannelMonitorUpdate {
1195 update_id: self.latest_monitor_update_id,
1196 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1197 payment_preimage: payment_preimage_arg.clone(),
1200 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1202 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1203 for pending_update in self.holding_cell_htlc_updates.iter() {
1204 match pending_update {
1205 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1206 if htlc_id_arg == htlc_id {
1207 return Ok((None, None));
1210 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1211 if htlc_id_arg == htlc_id {
1212 log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1213 // TODO: We may actually be able to switch to a fulfill here, though its
1214 // rare enough it may not be worth the complexity burden.
1215 return Ok((None, Some(monitor_update)));
1221 log_trace!(self, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1222 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1223 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1225 return Ok((None, Some(monitor_update)));
1229 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1230 if let InboundHTLCState::Committed = htlc.state {
1232 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1233 return Ok((None, Some(monitor_update)));
1235 log_trace!(self, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1236 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1239 Ok((Some(msgs::UpdateFulfillHTLC {
1240 channel_id: self.channel_id(),
1241 htlc_id: htlc_id_arg,
1242 payment_preimage: payment_preimage_arg,
1243 }), Some(monitor_update)))
1246 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> {
1247 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1248 (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1249 let (commitment, mut additional_update) = self.send_commitment_no_status_check()?;
1250 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1251 // strictly increasing by one, so decrement it here.
1252 self.latest_monitor_update_id = monitor_update.update_id;
1253 monitor_update.updates.append(&mut additional_update.updates);
1254 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1256 (Some(update_fulfill_htlc), None) => {
1257 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1258 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1260 (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1261 (None, None) => Ok((None, None))
1265 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1266 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1267 /// Ok(_) if debug assertions are turned on and preconditions are met.
1268 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1269 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1270 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1272 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1274 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1275 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1276 // these, but for now we just have to treat them as normal.
1278 let mut pending_idx = std::usize::MAX;
1279 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1280 if htlc.htlc_id == htlc_id_arg {
1282 InboundHTLCState::Committed => {},
1283 InboundHTLCState::LocalRemoved(_) => {
1287 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1288 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1294 if pending_idx == std::usize::MAX {
1295 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1298 // Now update local state:
1299 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1300 for pending_update in self.holding_cell_htlc_updates.iter() {
1301 match pending_update {
1302 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1303 if htlc_id_arg == htlc_id {
1304 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1307 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1308 if htlc_id_arg == htlc_id {
1309 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1315 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1316 htlc_id: htlc_id_arg,
1323 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1324 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1327 Ok(Some(msgs::UpdateFailHTLC {
1328 channel_id: self.channel_id(),
1329 htlc_id: htlc_id_arg,
1334 // Message handlers:
1336 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1337 // Check sanity of message fields:
1338 if !self.channel_outbound {
1339 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1341 if self.channel_state != ChannelState::OurInitSent as u32 {
1342 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1344 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1345 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1347 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1348 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1350 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1351 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1353 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1354 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1356 if msg.dust_limit_satoshis > Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1357 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1359 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1360 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1362 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1363 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1365 if msg.max_accepted_htlcs < 1 {
1366 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1368 if msg.max_accepted_htlcs > 483 {
1369 return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1372 // Now check against optional parameters as set by config...
1373 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1374 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1376 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1377 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1379 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1380 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1382 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1383 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1385 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1386 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1388 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1389 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1391 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1392 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1395 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1396 match &msg.shutdown_scriptpubkey {
1397 &OptionalField::Present(ref script) => {
1398 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1399 if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1400 Some(script.clone())
1401 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1402 } else if script.len() == 0 {
1404 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1406 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
1409 // 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
1410 &OptionalField::Absent => {
1411 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
1416 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1417 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1418 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1419 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1420 self.their_to_self_delay = msg.to_self_delay;
1421 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1422 self.minimum_depth = msg.minimum_depth;
1424 let their_pubkeys = ChannelPublicKeys {
1425 funding_pubkey: msg.funding_pubkey,
1426 revocation_basepoint: msg.revocation_basepoint,
1427 payment_basepoint: msg.payment_basepoint,
1428 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1429 htlc_basepoint: msg.htlc_basepoint
1432 self.local_keys.set_remote_channel_pubkeys(&their_pubkeys);
1433 self.their_pubkeys = Some(their_pubkeys);
1435 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1436 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1438 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1443 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, LocalCommitmentTransaction, Signature, TxCreationKeys), ChannelError> {
1444 let funding_script = self.get_funding_redeemscript();
1446 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1447 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1448 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1450 // They sign the "local" commitment transaction...
1451 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, self.their_funding_pubkey()), "Invalid funding_created signature from peer");
1453 let localtx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx, sig, &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), self.their_funding_pubkey());
1455 let remote_keys = self.build_remote_transaction_keys()?;
1456 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1457 let remote_signature = self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
1458 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0;
1460 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1461 Ok((remote_initial_commitment_tx, localtx, remote_signature, local_keys))
1464 fn their_funding_pubkey(&self) -> &PublicKey {
1465 &self.their_pubkeys.as_ref().expect("their_funding_pubkey() only allowed after accept_channel").funding_pubkey
1468 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor<ChanSigner>), ChannelError> {
1469 if self.channel_outbound {
1470 return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1472 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1473 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1474 // remember the channel, so it's safe to just send an error_message here and drop the
1476 return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1478 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1479 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1480 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1481 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1484 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1485 self.funding_txo = Some(funding_txo.clone());
1487 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1490 self.funding_txo = None;
1495 // Now that we're past error-generating stuff, update our local state:
1497 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1498 let funding_redeemscript = self.get_funding_redeemscript();
1499 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1500 macro_rules! create_monitor {
1502 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1503 &self.shutdown_pubkey, self.our_to_self_delay,
1504 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1505 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1506 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1507 self.get_commitment_transaction_number_obscure_factor(),
1508 self.logger.clone());
1510 channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1511 channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys.clone(), self.feerate_per_kw, Vec::new()).unwrap();
1516 self.channel_monitor = Some(create_monitor!());
1517 let channel_monitor = create_monitor!();
1519 self.channel_state = ChannelState::FundingSent as u32;
1520 self.channel_id = funding_txo.to_channel_id();
1521 self.cur_remote_commitment_transaction_number -= 1;
1522 self.cur_local_commitment_transaction_number -= 1;
1524 Ok((msgs::FundingSigned {
1525 channel_id: self.channel_id,
1526 signature: our_signature
1527 }, channel_monitor))
1530 /// Handles a funding_signed message from the remote end.
1531 /// If this call is successful, broadcast the funding transaction (and not before!)
1532 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitorUpdate, (Option<ChannelMonitorUpdate>, ChannelError)> {
1533 if !self.channel_outbound {
1534 return Err((None, ChannelError::Close("Received funding_signed for an inbound channel?")));
1536 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1537 return Err((None, ChannelError::Close("Received funding_signed in strange state!")));
1539 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1540 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1541 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1542 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1545 let funding_script = self.get_funding_redeemscript();
1547 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1548 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1549 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1551 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1553 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1554 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, their_funding_pubkey) {
1555 return Err((None, ChannelError::Close("Invalid funding_signed signature from peer")));
1558 self.latest_monitor_update_id += 1;
1559 let monitor_update = ChannelMonitorUpdate {
1560 update_id: self.latest_monitor_update_id,
1561 updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
1562 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx, &msg.signature, &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), their_funding_pubkey),
1563 local_keys, feerate_per_kw: self.feerate_per_kw, htlc_outputs: Vec::new(),
1566 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1567 self.channel_state = ChannelState::FundingSent as u32 | (self.channel_state & (ChannelState::MonitorUpdateFailed as u32));
1568 self.cur_local_commitment_transaction_number -= 1;
1570 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1573 Err((Some(monitor_update),
1574 ChannelError::Ignore("Previous monitor update failure prevented funding_signed from allowing funding broadcast")))
1578 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1579 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1580 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1583 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1585 if non_shutdown_state == ChannelState::FundingSent as u32 {
1586 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1587 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1588 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1589 self.channel_update_count += 1;
1590 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1591 // Note that funding_signed/funding_created will have decremented both by 1!
1592 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1593 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1594 // If we reconnected before sending our funding locked they may still resend theirs:
1595 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1596 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1597 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1598 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1600 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1603 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1606 self.their_prev_commitment_point = self.their_cur_commitment_point;
1607 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1611 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1612 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1613 let mut htlc_inbound_value_msat = 0;
1614 for ref htlc in self.pending_inbound_htlcs.iter() {
1615 htlc_inbound_value_msat += htlc.amount_msat;
1617 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1620 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1622 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1623 let mut htlc_outbound_value_msat = 0;
1624 for ref htlc in self.pending_outbound_htlcs.iter() {
1625 htlc_outbound_value_msat += htlc.amount_msat;
1628 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1629 for update in self.holding_cell_htlc_updates.iter() {
1630 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1631 htlc_outbound_count += 1;
1632 htlc_outbound_value_msat += amount_msat;
1636 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1639 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1640 /// Doesn't bother handling the
1641 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1642 /// corner case properly.
1643 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1644 // Note that we have to handle overflow due to the above case.
1645 (cmp::min(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1646 cmp::min(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1649 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1650 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1651 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1653 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1654 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1656 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1657 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1659 if msg.amount_msat < self.our_htlc_minimum_msat {
1660 return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1663 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1664 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1665 return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1667 // Check our_max_htlc_value_in_flight_msat
1668 if htlc_inbound_value_msat + msg.amount_msat > Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1669 return Err(ChannelError::Close("Remote HTLC add would put them over our max HTLC value"));
1671 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1672 // the reserve_satoshis we told them to always have as direct payment so that they lose
1673 // something if we punish them for broadcasting an old state).
1674 // Note that we don't really care about having a small/no to_remote output in our local
1675 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1676 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1677 // present in the next commitment transaction we send them (at least for fulfilled ones,
1678 // failed ones won't modify value_to_self).
1679 // Note that we will send HTLCs which another instance of rust-lightning would think
1680 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1681 // Channel state once they will not be present in the next received commitment
1683 let mut removed_outbound_total_msat = 0;
1684 for ref htlc in self.pending_outbound_htlcs.iter() {
1685 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1686 removed_outbound_total_msat += htlc.amount_msat;
1687 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1688 removed_outbound_total_msat += htlc.amount_msat;
1691 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1692 return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1694 if self.next_remote_htlc_id != msg.htlc_id {
1695 return Err(ChannelError::Close("Remote skipped HTLC ID"));
1697 if msg.cltv_expiry >= 500000000 {
1698 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1701 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1703 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1704 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1705 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1709 // Now update local state:
1710 self.next_remote_htlc_id += 1;
1711 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1712 htlc_id: msg.htlc_id,
1713 amount_msat: msg.amount_msat,
1714 payment_hash: msg.payment_hash,
1715 cltv_expiry: msg.cltv_expiry,
1716 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1721 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1723 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1724 for htlc in self.pending_outbound_htlcs.iter_mut() {
1725 if htlc.htlc_id == htlc_id {
1726 match check_preimage {
1728 Some(payment_hash) =>
1729 if payment_hash != htlc.payment_hash {
1730 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1734 OutboundHTLCState::LocalAnnounced(_) =>
1735 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1736 OutboundHTLCState::Committed => {
1737 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1739 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1740 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1742 return Ok(&htlc.source);
1745 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1748 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1749 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1750 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1752 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1753 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1756 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1757 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1760 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1761 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1762 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1764 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1765 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1768 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1772 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1773 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1774 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1776 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1777 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1780 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1784 pub fn commitment_signed<F: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)> where F::Target: FeeEstimator {
1785 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1786 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state")));
1788 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1789 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish")));
1791 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1792 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds")));
1795 let funding_script = self.get_funding_redeemscript();
1797 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1799 let mut update_fee = false;
1800 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1802 self.pending_update_fee.unwrap()
1807 let mut local_commitment_tx = {
1808 let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1809 let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1810 (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1812 let local_commitment_txid = local_commitment_tx.0.txid();
1813 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1814 log_trace!(self, "Checking commitment tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_commitment_tx.0), encode::serialize_hex(&funding_script));
1815 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1816 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer")));
1819 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1821 let num_htlcs = local_commitment_tx.1;
1822 let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1824 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1825 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee")));
1829 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1830 return Err((None, ChannelError::Close("Got wrong number of HTLC signatures from remote")));
1833 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1834 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1835 if let Some(_) = htlc.transaction_output_index {
1836 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1837 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1838 log_trace!(self, "Checking HTLC tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript));
1839 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1840 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
1841 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer")));
1843 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
1845 htlcs_and_sigs.push((htlc, None, source));
1849 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1850 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 1);
1852 // Update state now that we've passed all the can-fail calls...
1853 let mut need_our_commitment = false;
1854 if !self.channel_outbound {
1855 if let Some(fee_update) = self.pending_update_fee {
1856 self.feerate_per_kw = fee_update;
1857 // We later use the presence of pending_update_fee to indicate we should generate a
1858 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1859 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1860 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1861 need_our_commitment = true;
1862 self.pending_update_fee = None;
1867 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1869 self.latest_monitor_update_id += 1;
1870 let mut monitor_update = ChannelMonitorUpdate {
1871 update_id: self.latest_monitor_update_id,
1872 updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
1873 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_commitment_tx.0, &msg.signature, &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), &their_funding_pubkey),
1874 local_keys, feerate_per_kw: self.feerate_per_kw, htlc_outputs: htlcs_and_sigs
1877 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1879 for htlc in self.pending_inbound_htlcs.iter_mut() {
1880 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1881 Some(forward_info.clone())
1883 if let Some(forward_info) = new_forward {
1884 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1885 need_our_commitment = true;
1888 for htlc in self.pending_outbound_htlcs.iter_mut() {
1889 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1890 Some(fail_reason.take())
1892 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1893 need_our_commitment = true;
1897 self.cur_local_commitment_transaction_number -= 1;
1898 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1899 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1900 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1902 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1903 // In case we initially failed monitor updating without requiring a response, we need
1904 // to make sure the RAA gets sent first.
1905 self.monitor_pending_revoke_and_ack = true;
1906 if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1907 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1908 // the corresponding HTLC status updates so that get_last_commitment_update
1909 // includes the right HTLCs.
1910 self.monitor_pending_commitment_signed = true;
1911 let (_, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1912 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1913 // strictly increasing by one, so decrement it here.
1914 self.latest_monitor_update_id = monitor_update.update_id;
1915 monitor_update.updates.append(&mut additional_update.updates);
1917 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1918 // re-send the message on restoration)
1919 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA")));
1922 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1923 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1924 // we'll send one right away when we get the revoke_and_ack when we
1925 // free_holding_cell_htlcs().
1926 let (msg, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1927 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1928 // strictly increasing by one, so decrement it here.
1929 self.latest_monitor_update_id = monitor_update.update_id;
1930 monitor_update.updates.append(&mut additional_update.updates);
1932 } else if !need_our_commitment {
1933 (None, self.maybe_propose_first_closing_signed(fee_estimator))
1934 } else { (None, None) };
1936 Ok((msgs::RevokeAndACK {
1937 channel_id: self.channel_id,
1938 per_commitment_secret: per_commitment_secret,
1939 next_per_commitment_point: next_per_commitment_point,
1940 }, our_commitment_signed, closing_signed, monitor_update))
1943 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1944 /// fulfilling or failing the last pending HTLC)
1945 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, ChannelError> {
1946 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1947 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1948 log_trace!(self, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
1950 let mut monitor_update = ChannelMonitorUpdate {
1951 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
1952 updates: Vec::new(),
1955 let mut htlc_updates = Vec::new();
1956 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1957 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1958 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1959 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1961 for htlc_update in htlc_updates.drain(..) {
1962 // Note that this *can* fail, though it should be due to rather-rare conditions on
1963 // fee races with adding too many outputs which push our total payments just over
1964 // the limit. In case it's less rare than I anticipate, we may want to revisit
1965 // handling this case better and maybe fulfilling some of the HTLCs while attempting
1966 // to rebalance channels.
1967 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1968 self.holding_cell_htlc_updates.push(htlc_update);
1970 match &htlc_update {
1971 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
1972 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1973 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1976 ChannelError::Ignore(ref msg) => {
1977 log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
1980 log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
1987 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
1988 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
1989 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
1990 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
1991 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
1992 monitor_update.updates.append(&mut additional_monitor_update.updates);
1996 if let ChannelError::Ignore(_) = e {}
1998 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2003 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2004 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2005 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2007 if let ChannelError::Ignore(_) = e {}
2009 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2016 self.holding_cell_htlc_updates.push(htlc_update);
2017 if let Some(ChannelError::Ignore(_)) = err {
2018 // If we failed to add the HTLC, but got an Ignore error, we should
2019 // still send the new commitment_signed, so reset the err to None.
2025 //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2026 //fail it back the route, if it's a temporary issue we can ignore it...
2029 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2030 // This should never actually happen and indicates we got some Errs back
2031 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2032 // case there is some strange way to hit duplicate HTLC removes.
2035 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2036 self.pending_update_fee = self.holding_cell_update_fee.take();
2037 Some(msgs::UpdateFee {
2038 channel_id: self.channel_id,
2039 feerate_per_kw: feerate as u32,
2045 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2046 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2047 // but we want them to be strictly increasing by one, so reset it here.
2048 self.latest_monitor_update_id = monitor_update.update_id;
2049 monitor_update.updates.append(&mut additional_update.updates);
2051 Ok(Some((msgs::CommitmentUpdate {
2053 update_fulfill_htlcs,
2055 update_fail_malformed_htlcs: Vec::new(),
2056 update_fee: update_fee,
2058 }, monitor_update)))
2067 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2068 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2069 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2070 /// generating an appropriate error *after* the channel state has been updated based on the
2071 /// revoke_and_ack message.
2072 pub fn revoke_and_ack<F: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), ChannelError>
2073 where F::Target: FeeEstimator
2075 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2076 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2078 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2079 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2081 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2082 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2085 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2086 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
2087 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2091 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2092 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2093 // haven't given them a new commitment transaction to broadcast). We should probably
2094 // take advantage of this by updating our channel monitor, sending them an error, and
2095 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2096 // lot of work, and there's some chance this is all a misunderstanding anyway.
2097 // We have to do *something*, though, since our signer may get mad at us for otherwise
2098 // jumping a remote commitment number, so best to just force-close and move on.
2099 return Err(ChannelError::Close("Received an unexpected revoke_and_ack"));
2102 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2103 .map_err(|_| ChannelError::Close("Previous secrets did not match new one"))?;
2104 self.latest_monitor_update_id += 1;
2105 let mut monitor_update = ChannelMonitorUpdate {
2106 update_id: self.latest_monitor_update_id,
2107 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2108 idx: self.cur_remote_commitment_transaction_number + 1,
2109 secret: msg.per_commitment_secret,
2112 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
2114 // Update state now that we've passed all the can-fail calls...
2115 // (note that we may still fail to generate the new commitment_signed message, but that's
2116 // OK, we step the channel here and *then* if the new generation fails we can fail the
2117 // channel based on that, but stepping stuff here should be safe either way.
2118 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2119 self.their_prev_commitment_point = self.their_cur_commitment_point;
2120 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2121 self.cur_remote_commitment_transaction_number -= 1;
2123 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2124 let mut to_forward_infos = Vec::new();
2125 let mut revoked_htlcs = Vec::new();
2126 let mut update_fail_htlcs = Vec::new();
2127 let mut update_fail_malformed_htlcs = Vec::new();
2128 let mut require_commitment = false;
2129 let mut value_to_self_msat_diff: i64 = 0;
2132 // Take references explicitly so that we can hold multiple references to self.
2133 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2134 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2135 let logger = LogHolder { logger: &self.logger };
2137 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2138 pending_inbound_htlcs.retain(|htlc| {
2139 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2140 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2141 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2142 value_to_self_msat_diff += htlc.amount_msat as i64;
2147 pending_outbound_htlcs.retain(|htlc| {
2148 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2149 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2150 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2151 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2153 // They fulfilled, so we sent them money
2154 value_to_self_msat_diff -= htlc.amount_msat as i64;
2159 for htlc in pending_inbound_htlcs.iter_mut() {
2160 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2161 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2163 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2164 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2168 let mut state = InboundHTLCState::Committed;
2169 mem::swap(&mut state, &mut htlc.state);
2171 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2172 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2173 require_commitment = true;
2174 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2175 match forward_info {
2176 PendingHTLCStatus::Fail(fail_msg) => {
2177 require_commitment = true;
2179 HTLCFailureMsg::Relay(msg) => {
2180 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2181 update_fail_htlcs.push(msg)
2183 HTLCFailureMsg::Malformed(msg) => {
2184 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2185 update_fail_malformed_htlcs.push(msg)
2189 PendingHTLCStatus::Forward(forward_info) => {
2190 to_forward_infos.push((forward_info, htlc.htlc_id));
2191 htlc.state = InboundHTLCState::Committed;
2197 for htlc in pending_outbound_htlcs.iter_mut() {
2198 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2199 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2200 htlc.state = OutboundHTLCState::Committed;
2202 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2203 Some(fail_reason.take())
2205 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2206 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2207 require_commitment = true;
2211 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2213 if self.channel_outbound {
2214 if let Some(feerate) = self.pending_update_fee.take() {
2215 self.feerate_per_kw = feerate;
2218 if let Some(feerate) = self.pending_update_fee {
2219 // Because a node cannot send two commitment_signeds in a row without getting a
2220 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2221 // it should use to create keys with) and because a node can't send a
2222 // commitment_signed without changes, checking if the feerate is equal to the
2223 // pending feerate update is sufficient to detect require_commitment.
2224 if feerate == self.feerate_per_kw {
2225 require_commitment = true;
2226 self.pending_update_fee = None;
2231 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2232 // We can't actually generate a new commitment transaction (incl by freeing holding
2233 // cells) while we can't update the monitor, so we just return what we have.
2234 if require_commitment {
2235 self.monitor_pending_commitment_signed = true;
2236 // When the monitor updating is restored we'll call get_last_commitment_update(),
2237 // which does not update state, but we're definitely now awaiting a remote revoke
2238 // before we can step forward any more, so set it here.
2239 let (_, mut additional_update) = self.send_commitment_no_status_check()?;
2240 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2241 // strictly increasing by one, so decrement it here.
2242 self.latest_monitor_update_id = monitor_update.update_id;
2243 monitor_update.updates.append(&mut additional_update.updates);
2245 self.monitor_pending_forwards.append(&mut to_forward_infos);
2246 self.monitor_pending_failures.append(&mut revoked_htlcs);
2247 return Ok((None, Vec::new(), Vec::new(), None, monitor_update))
2250 match self.free_holding_cell_htlcs()? {
2251 Some((mut commitment_update, mut additional_update)) => {
2252 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2253 for fail_msg in update_fail_htlcs.drain(..) {
2254 commitment_update.update_fail_htlcs.push(fail_msg);
2256 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2257 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2258 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2261 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2262 // strictly increasing by one, so decrement it here.
2263 self.latest_monitor_update_id = monitor_update.update_id;
2264 monitor_update.updates.append(&mut additional_update.updates);
2266 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update))
2269 if require_commitment {
2270 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2272 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2273 // strictly increasing by one, so decrement it here.
2274 self.latest_monitor_update_id = monitor_update.update_id;
2275 monitor_update.updates.append(&mut additional_update.updates);
2277 Ok((Some(msgs::CommitmentUpdate {
2278 update_add_htlcs: Vec::new(),
2279 update_fulfill_htlcs: Vec::new(),
2281 update_fail_malformed_htlcs,
2284 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2286 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update))
2293 /// Adds a pending update to this channel. See the doc for send_htlc for
2294 /// further details on the optionness of the return value.
2295 /// You MUST call send_commitment prior to any other calls on this Channel
2296 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2297 if !self.channel_outbound {
2298 panic!("Cannot send fee from inbound channel");
2300 if !self.is_usable() {
2301 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2303 if !self.is_live() {
2304 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2307 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2308 self.holding_cell_update_fee = Some(feerate_per_kw);
2312 debug_assert!(self.pending_update_fee.is_none());
2313 self.pending_update_fee = Some(feerate_per_kw);
2315 Some(msgs::UpdateFee {
2316 channel_id: self.channel_id,
2317 feerate_per_kw: feerate_per_kw as u32,
2321 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> {
2322 match self.send_update_fee(feerate_per_kw) {
2323 Some(update_fee) => {
2324 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2325 Ok(Some((update_fee, commitment_signed, monitor_update)))
2331 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2332 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2333 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2334 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2335 /// No further message handling calls may be made until a channel_reestablish dance has
2337 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2338 let mut outbound_drops = Vec::new();
2340 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2341 if self.channel_state < ChannelState::FundingSent as u32 {
2342 self.channel_state = ChannelState::ShutdownComplete as u32;
2343 return outbound_drops;
2345 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2346 // will be retransmitted.
2347 self.last_sent_closing_fee = None;
2349 let mut inbound_drop_count = 0;
2350 self.pending_inbound_htlcs.retain(|htlc| {
2352 InboundHTLCState::RemoteAnnounced(_) => {
2353 // They sent us an update_add_htlc but we never got the commitment_signed.
2354 // We'll tell them what commitment_signed we're expecting next and they'll drop
2355 // this HTLC accordingly
2356 inbound_drop_count += 1;
2359 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2360 // We received a commitment_signed updating this HTLC and (at least hopefully)
2361 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2362 // in response to it yet, so don't touch it.
2365 InboundHTLCState::Committed => true,
2366 InboundHTLCState::LocalRemoved(_) => {
2367 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2368 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2369 // (that we missed). Keep this around for now and if they tell us they missed
2370 // the commitment_signed we can re-transmit the update then.
2375 self.next_remote_htlc_id -= inbound_drop_count;
2377 for htlc in self.pending_outbound_htlcs.iter_mut() {
2378 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2379 // They sent us an update to remove this but haven't yet sent the corresponding
2380 // commitment_signed, we need to move it back to Committed and they can re-send
2381 // the update upon reconnection.
2382 htlc.state = OutboundHTLCState::Committed;
2386 self.holding_cell_htlc_updates.retain(|htlc_update| {
2388 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2389 outbound_drops.push((source.clone(), payment_hash.clone()));
2392 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2395 self.channel_state |= ChannelState::PeerDisconnected as u32;
2396 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2400 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2401 /// updates are partially paused.
2402 /// This must be called immediately after the call which generated the ChannelMonitor update
2403 /// which failed. The messages which were generated from that call which generated the
2404 /// monitor update failure must *not* have been sent to the remote end, and must instead
2405 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2406 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)>) {
2407 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2408 self.monitor_pending_revoke_and_ack = resend_raa;
2409 self.monitor_pending_commitment_signed = resend_commitment;
2410 assert!(self.monitor_pending_forwards.is_empty());
2411 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2412 assert!(self.monitor_pending_failures.is_empty());
2413 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2414 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2417 /// Indicates that the latest ChannelMonitor update has been committed by the client
2418 /// successfully and we should restore normal operation. Returns messages which should be sent
2419 /// to the remote side.
2420 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) {
2421 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2422 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2424 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2426 // Because we will never generate a FundingBroadcastSafe event when we're in
2427 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2428 // they received the FundingBroadcastSafe event, we can only ever hit
2429 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2430 // monitor on funding_created, and we even got the funding transaction confirmed before the
2431 // monitor was persisted.
2432 let funding_locked = if self.monitor_pending_funding_locked {
2433 assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2434 self.monitor_pending_funding_locked = false;
2435 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2436 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2437 Some(msgs::FundingLocked {
2438 channel_id: self.channel_id(),
2439 next_per_commitment_point: next_per_commitment_point,
2443 let mut forwards = Vec::new();
2444 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2445 let mut failures = Vec::new();
2446 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2448 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2449 self.monitor_pending_revoke_and_ack = false;
2450 self.monitor_pending_commitment_signed = false;
2451 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2454 let raa = if self.monitor_pending_revoke_and_ack {
2455 Some(self.get_last_revoke_and_ack())
2457 let commitment_update = if self.monitor_pending_commitment_signed {
2458 Some(self.get_last_commitment_update())
2461 self.monitor_pending_revoke_and_ack = false;
2462 self.monitor_pending_commitment_signed = false;
2463 let order = self.resend_order.clone();
2464 log_trace!(self, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2465 if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2466 if commitment_update.is_some() { "a" } else { "no" },
2467 if raa.is_some() { "an" } else { "no" },
2468 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2469 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2472 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2473 where F::Target: FeeEstimator
2475 if self.channel_outbound {
2476 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2478 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2479 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2481 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2482 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2483 self.channel_update_count += 1;
2487 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2488 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2489 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 2);
2490 msgs::RevokeAndACK {
2491 channel_id: self.channel_id,
2492 per_commitment_secret,
2493 next_per_commitment_point,
2497 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2498 let mut update_add_htlcs = Vec::new();
2499 let mut update_fulfill_htlcs = Vec::new();
2500 let mut update_fail_htlcs = Vec::new();
2501 let mut update_fail_malformed_htlcs = Vec::new();
2503 for htlc in self.pending_outbound_htlcs.iter() {
2504 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2505 update_add_htlcs.push(msgs::UpdateAddHTLC {
2506 channel_id: self.channel_id(),
2507 htlc_id: htlc.htlc_id,
2508 amount_msat: htlc.amount_msat,
2509 payment_hash: htlc.payment_hash,
2510 cltv_expiry: htlc.cltv_expiry,
2511 onion_routing_packet: (**onion_packet).clone(),
2516 for htlc in self.pending_inbound_htlcs.iter() {
2517 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2519 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2520 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2521 channel_id: self.channel_id(),
2522 htlc_id: htlc.htlc_id,
2523 reason: err_packet.clone()
2526 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2527 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2528 channel_id: self.channel_id(),
2529 htlc_id: htlc.htlc_id,
2530 sha256_of_onion: sha256_of_onion.clone(),
2531 failure_code: failure_code.clone(),
2534 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2535 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2536 channel_id: self.channel_id(),
2537 htlc_id: htlc.htlc_id,
2538 payment_preimage: payment_preimage.clone(),
2545 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2546 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2547 msgs::CommitmentUpdate {
2548 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2550 commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2554 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2555 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2556 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2557 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2558 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2559 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2560 // just close here instead of trying to recover.
2561 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2564 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2565 msg.next_local_commitment_number == 0 {
2566 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2569 if msg.next_remote_commitment_number > 0 {
2570 match msg.data_loss_protect {
2571 OptionalField::Present(ref data_loss) => {
2572 if chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1) != data_loss.your_last_per_commitment_secret {
2573 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided"));
2575 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2576 self.latest_monitor_update_id += 1;
2577 let monitor_update = ChannelMonitorUpdate {
2578 update_id: self.latest_monitor_update_id,
2579 updates: vec![ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo {
2580 their_current_per_commitment_point: data_loss.my_current_per_commitment_point
2583 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
2584 return Err(ChannelError::CloseDelayBroadcast {
2585 msg: "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",
2586 update: monitor_update
2590 OptionalField::Absent => {}
2594 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2595 // remaining cases either succeed or ErrorMessage-fail).
2596 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2598 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2599 Some(msgs::Shutdown {
2600 channel_id: self.channel_id,
2601 scriptpubkey: self.get_closing_scriptpubkey(),
2605 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2606 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2607 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2608 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2609 if msg.next_remote_commitment_number != 0 {
2610 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2612 // Short circuit the whole handler as there is nothing we can resend them
2613 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2616 // We have OurFundingLocked set!
2617 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2618 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2619 return Ok((Some(msgs::FundingLocked {
2620 channel_id: self.channel_id(),
2621 next_per_commitment_point: next_per_commitment_point,
2622 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2625 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2626 // Remote isn't waiting on any RevokeAndACK from us!
2627 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2629 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2630 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2631 self.monitor_pending_revoke_and_ack = true;
2634 Some(self.get_last_revoke_and_ack())
2637 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2640 // We increment cur_remote_commitment_transaction_number only upon receipt of
2641 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2642 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2643 // the corresponding revoke_and_ack back yet.
2644 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2646 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2647 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2648 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2649 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2650 Some(msgs::FundingLocked {
2651 channel_id: self.channel_id(),
2652 next_per_commitment_point: next_per_commitment_point,
2656 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2657 if required_revoke.is_some() {
2658 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2660 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2663 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2664 // We're up-to-date and not waiting on a remote revoke (if we are our
2665 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2666 // have received some updates while we were disconnected. Free the holding cell
2668 match self.free_holding_cell_htlcs() {
2669 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2670 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast { .. }) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2671 Ok(Some((commitment_update, monitor_update))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg)),
2672 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2675 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2677 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2678 if required_revoke.is_some() {
2679 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2681 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2684 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2685 self.monitor_pending_commitment_signed = true;
2686 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2689 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, self.resend_order.clone(), shutdown_msg));
2691 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2695 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2696 where F::Target: FeeEstimator
2698 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2699 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2700 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2704 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2705 if self.feerate_per_kw > proposed_feerate {
2706 proposed_feerate = self.feerate_per_kw;
2708 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2709 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2711 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2712 let our_sig = self.local_keys
2713 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2715 if our_sig.is_none() { return None; }
2717 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2718 Some(msgs::ClosingSigned {
2719 channel_id: self.channel_id,
2720 fee_satoshis: total_fee_satoshis,
2721 signature: our_sig.unwrap(),
2725 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2726 where F::Target: FeeEstimator
2728 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2729 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2731 if self.channel_state < ChannelState::FundingSent as u32 {
2732 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2733 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2734 // can do that via error message without getting a connection fail anyway...
2735 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2737 for htlc in self.pending_inbound_htlcs.iter() {
2738 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2739 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2742 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2744 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2745 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2746 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2747 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2750 //Check shutdown_scriptpubkey form as BOLT says we must
2751 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2752 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2755 if self.their_shutdown_scriptpubkey.is_some() {
2756 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2757 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2760 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2763 // From here on out, we may not fail!
2765 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2766 self.channel_update_count += 1;
2768 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2769 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2770 // cell HTLCs and return them to fail the payment.
2771 self.holding_cell_update_fee = None;
2772 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2773 self.holding_cell_htlc_updates.retain(|htlc_update| {
2775 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2776 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2782 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2783 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2784 // any further commitment updates after we set LocalShutdownSent.
2786 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2789 Some(msgs::Shutdown {
2790 channel_id: self.channel_id,
2791 scriptpubkey: self.get_closing_scriptpubkey(),
2795 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2796 self.channel_update_count += 1;
2798 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2801 fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2802 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2803 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2804 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2806 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2808 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()).serialize();
2809 let their_funding_key = self.their_funding_pubkey().serialize();
2810 if our_funding_key[..] < their_funding_key[..] {
2811 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2812 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2814 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2815 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2817 tx.input[0].witness[1].push(SigHashType::All as u8);
2818 tx.input[0].witness[2].push(SigHashType::All as u8);
2820 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2823 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2824 where F::Target: FeeEstimator
2826 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2827 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2829 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2830 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2832 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2833 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2835 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2836 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2839 let funding_redeemscript = self.get_funding_redeemscript();
2840 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2841 if used_total_fee != msg.fee_satoshis {
2842 return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2844 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2846 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2848 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
2851 // The remote end may have decided to revoke their output due to inconsistent dust
2852 // limits, so check for that case by re-checking the signature here.
2853 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2854 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2855 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer");
2859 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
2860 if last_fee == msg.fee_satoshis {
2861 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2862 self.channel_state = ChannelState::ShutdownComplete as u32;
2863 self.channel_update_count += 1;
2864 return Ok((None, Some(closing_tx)));
2868 macro_rules! propose_new_feerate {
2869 ($new_feerate: expr) => {
2870 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2871 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2872 let our_sig = self.local_keys
2873 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2874 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2875 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
2876 return Ok((Some(msgs::ClosingSigned {
2877 channel_id: self.channel_id,
2878 fee_satoshis: used_total_fee,
2884 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight() as u64;
2885 if self.channel_outbound {
2886 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2887 if proposed_sat_per_kw > our_max_feerate {
2888 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2889 if our_max_feerate <= last_feerate {
2890 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2893 propose_new_feerate!(our_max_feerate);
2896 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2897 if proposed_sat_per_kw < our_min_feerate {
2898 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2899 if our_min_feerate >= last_feerate {
2900 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2903 propose_new_feerate!(our_min_feerate);
2907 let our_sig = self.local_keys
2908 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2909 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2910 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2912 self.channel_state = ChannelState::ShutdownComplete as u32;
2913 self.channel_update_count += 1;
2915 Ok((Some(msgs::ClosingSigned {
2916 channel_id: self.channel_id,
2917 fee_satoshis: msg.fee_satoshis,
2919 }), Some(closing_tx)))
2922 // Public utilities:
2924 pub fn channel_id(&self) -> [u8; 32] {
2928 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2929 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2930 pub fn get_user_id(&self) -> u64 {
2934 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2935 pub fn channel_monitor(&mut self) -> &mut ChannelMonitor<ChanSigner> {
2936 if self.channel_state < ChannelState::FundingCreated as u32 {
2937 panic!("Can't get a channel monitor until funding has been created");
2939 self.channel_monitor.as_mut().unwrap()
2942 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2943 /// is_usable() returns true).
2944 /// Allowed in any state (including after shutdown)
2945 pub fn get_short_channel_id(&self) -> Option<u64> {
2946 self.short_channel_id
2949 /// Returns the funding_txo we either got from our peer, or were given by
2950 /// get_outbound_funding_created.
2951 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2955 /// Allowed in any state (including after shutdown)
2956 pub fn get_their_node_id(&self) -> PublicKey {
2960 /// Allowed in any state (including after shutdown)
2961 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2962 self.our_htlc_minimum_msat
2965 /// Allowed in any state (including after shutdown)
2966 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2967 self.our_htlc_minimum_msat
2970 pub fn get_value_satoshis(&self) -> u64 {
2971 self.channel_value_satoshis
2974 pub fn get_fee_proportional_millionths(&self) -> u32 {
2975 self.config.fee_proportional_millionths
2979 pub fn get_feerate(&self) -> u64 {
2983 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2984 self.cur_local_commitment_transaction_number + 1
2987 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2988 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2991 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2992 self.cur_remote_commitment_transaction_number + 2
2996 pub fn get_local_keys(&self) -> &ChanSigner {
3001 pub fn get_value_stat(&self) -> ChannelValueStat {
3003 value_to_self_msat: self.value_to_self_msat,
3004 channel_value_msat: self.channel_value_satoshis * 1000,
3005 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
3006 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3007 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3008 holding_cell_outbound_amount_msat: {
3010 for h in self.holding_cell_htlc_updates.iter() {
3012 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3020 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3024 /// Allowed in any state (including after shutdown)
3025 pub fn get_channel_update_count(&self) -> u32 {
3026 self.channel_update_count
3029 pub fn get_latest_monitor_update_id(&self) -> u64 {
3030 self.latest_monitor_update_id
3033 pub fn should_announce(&self) -> bool {
3034 self.config.announced_channel
3037 pub fn is_outbound(&self) -> bool {
3038 self.channel_outbound
3041 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3042 /// Allowed in any state (including after shutdown)
3043 pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3044 where F::Target: FeeEstimator
3046 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3047 // output value back into a transaction with the regular channel output:
3049 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3050 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3052 if self.channel_outbound {
3053 // + the marginal fee increase cost to us in the commitment transaction:
3054 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3057 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3058 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3063 /// Returns true if we've ever received a message from the remote end for this Channel
3064 pub fn have_received_message(&self) -> bool {
3065 self.channel_state > (ChannelState::OurInitSent as u32)
3068 /// Returns true if this channel is fully established and not known to be closing.
3069 /// Allowed in any state (including after shutdown)
3070 pub fn is_usable(&self) -> bool {
3071 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3072 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3075 /// Returns true if this channel is currently available for use. This is a superset of
3076 /// is_usable() and considers things like the channel being temporarily disabled.
3077 /// Allowed in any state (including after shutdown)
3078 pub fn is_live(&self) -> bool {
3079 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3082 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3083 /// Allowed in any state (including after shutdown)
3084 pub fn is_awaiting_monitor_update(&self) -> bool {
3085 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3088 /// Returns true if funding_created was sent/received.
3089 pub fn is_funding_initiated(&self) -> bool {
3090 self.channel_state >= ChannelState::FundingCreated as u32
3093 /// Returns true if this channel is fully shut down. True here implies that no further actions
3094 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3095 /// will be handled appropriately by the chain monitor.
3096 pub fn is_shutdown(&self) -> bool {
3097 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3098 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3103 pub fn to_disabled_staged(&mut self) {
3104 self.network_sync = UpdateStatus::DisabledStaged;
3107 pub fn to_disabled_marked(&mut self) {
3108 self.network_sync = UpdateStatus::DisabledMarked;
3111 pub fn to_fresh(&mut self) {
3112 self.network_sync = UpdateStatus::Fresh;
3115 pub fn is_disabled_staged(&self) -> bool {
3116 self.network_sync == UpdateStatus::DisabledStaged
3119 pub fn is_disabled_marked(&self) -> bool {
3120 self.network_sync == UpdateStatus::DisabledMarked
3123 /// Called by channelmanager based on chain blocks being connected.
3124 /// Note that we only need to use this to detect funding_signed, anything else is handled by
3125 /// the channel_monitor.
3126 /// In case of Err, the channel may have been closed, at which point the standard requirements
3127 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
3128 /// Only returns an ErrorAction of DisconnectPeer, if Err.
3129 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
3130 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3131 if header.bitcoin_hash() != self.last_block_connected {
3132 if self.funding_tx_confirmations > 0 {
3133 self.funding_tx_confirmations += 1;
3136 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3137 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3138 if tx.txid() == self.funding_txo.unwrap().txid {
3139 let txo_idx = self.funding_txo.unwrap().index as usize;
3140 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3141 tx.output[txo_idx].value != self.channel_value_satoshis {
3142 if self.channel_outbound {
3143 // If we generated the funding transaction and it doesn't match what it
3144 // should, the client is really broken and we should just panic and
3145 // tell them off. That said, because hash collisions happen with high
3146 // probability in fuzztarget mode, if we're fuzzing we just close the
3147 // channel and move on.
3148 #[cfg(not(feature = "fuzztarget"))]
3149 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3151 self.channel_state = ChannelState::ShutdownComplete as u32;
3152 self.channel_update_count += 1;
3153 return Err(msgs::ErrorMessage {
3154 channel_id: self.channel_id(),
3155 data: "funding tx had wrong script/value".to_owned()
3158 if self.channel_outbound {
3159 for input in tx.input.iter() {
3160 if input.witness.is_empty() {
3161 // We generated a malleable funding transaction, implying we've
3162 // just exposed ourselves to funds loss to our counterparty.
3163 #[cfg(not(feature = "fuzztarget"))]
3164 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3168 self.funding_tx_confirmations = 1;
3169 self.short_channel_id = Some(((height as u64) << (5*8)) |
3170 ((*index_in_block as u64) << (2*8)) |
3171 ((txo_idx as u64) << (0*8)));
3176 if header.bitcoin_hash() != self.last_block_connected {
3177 self.last_block_connected = header.bitcoin_hash();
3178 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3179 channel_monitor.last_block_hash = self.last_block_connected;
3181 if self.funding_tx_confirmations > 0 {
3182 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3183 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3184 self.channel_state |= ChannelState::OurFundingLocked as u32;
3186 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3187 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3188 self.channel_update_count += 1;
3190 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3191 // We got a reorg but not enough to trigger a force close, just update
3192 // funding_tx_confirmed_in and return.
3194 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3195 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3197 // We got a reorg but not enough to trigger a force close, just update
3198 // funding_tx_confirmed_in and return.
3201 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3203 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3204 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3205 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3206 //a protocol oversight, but I assume I'm just missing something.
3207 if need_commitment_update {
3208 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3209 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3210 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
3211 return Ok(Some(msgs::FundingLocked {
3212 channel_id: self.channel_id,
3213 next_per_commitment_point: next_per_commitment_point,
3216 self.monitor_pending_funding_locked = true;
3226 /// Called by channelmanager based on chain blocks being disconnected.
3227 /// Returns true if we need to close the channel now due to funding transaction
3228 /// unconfirmation/reorg.
3229 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3230 if self.funding_tx_confirmations > 0 {
3231 self.funding_tx_confirmations -= 1;
3232 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3236 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3237 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3239 self.last_block_connected = header.bitcoin_hash();
3240 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3241 channel_monitor.last_block_hash = self.last_block_connected;
3246 // Methods to get unprompted messages to send to the remote end (or where we already returned
3247 // something in the handler for the message that prompted this message):
3249 pub fn get_open_channel<F: Deref>(&self, chain_hash: Sha256dHash, fee_estimator: &F) -> msgs::OpenChannel
3250 where F::Target: FeeEstimator
3252 if !self.channel_outbound {
3253 panic!("Tried to open a channel for an inbound channel?");
3255 if self.channel_state != ChannelState::OurInitSent as u32 {
3256 panic!("Cannot generate an open_channel after we've moved forward");
3259 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3260 panic!("Tried to send an open_channel for a channel that has already advanced");
3263 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3266 chain_hash: chain_hash,
3267 temporary_channel_id: self.channel_id,
3268 funding_satoshis: self.channel_value_satoshis,
3269 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3270 dust_limit_satoshis: self.our_dust_limit_satoshis,
3271 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3272 channel_reserve_satoshis: Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3273 htlc_minimum_msat: self.our_htlc_minimum_msat,
3274 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3275 to_self_delay: self.our_to_self_delay,
3276 max_accepted_htlcs: OUR_MAX_HTLCS,
3277 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3278 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3279 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key()),
3280 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3281 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3282 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3283 channel_flags: if self.config.announced_channel {1} else {0},
3284 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3288 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3289 if self.channel_outbound {
3290 panic!("Tried to send accept_channel for an outbound channel?");
3292 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3293 panic!("Tried to send accept_channel after channel had moved forward");
3295 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3296 panic!("Tried to send an accept_channel for a channel that has already advanced");
3299 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3301 msgs::AcceptChannel {
3302 temporary_channel_id: self.channel_id,
3303 dust_limit_satoshis: self.our_dust_limit_satoshis,
3304 max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3305 channel_reserve_satoshis: Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3306 htlc_minimum_msat: self.our_htlc_minimum_msat,
3307 minimum_depth: self.minimum_depth,
3308 to_self_delay: self.our_to_self_delay,
3309 max_accepted_htlcs: OUR_MAX_HTLCS,
3310 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3311 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3312 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key()),
3313 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3314 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3315 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3316 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3320 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3321 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
3322 let remote_keys = self.build_remote_transaction_keys()?;
3323 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3324 Ok((self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
3325 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0, remote_initial_commitment_tx))
3328 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3329 /// a funding_created message for the remote peer.
3330 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3331 /// or if called on an inbound channel.
3332 /// Note that channel_id changes during this call!
3333 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3334 /// If an Err is returned, it is a ChannelError::Close.
3335 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor<ChanSigner>), ChannelError> {
3336 if !self.channel_outbound {
3337 panic!("Tried to create outbound funding_created message on an inbound channel!");
3339 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3340 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)");
3342 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3343 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3344 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3345 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3348 self.funding_txo = Some(funding_txo.clone());
3349 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3352 log_error!(self, "Got bad signatures: {:?}!", e);
3353 self.funding_txo = None;
3358 let temporary_channel_id = self.channel_id;
3360 // Now that we're past error-generating stuff, update our local state:
3362 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
3363 let funding_redeemscript = self.get_funding_redeemscript();
3364 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
3365 macro_rules! create_monitor {
3367 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
3368 &self.shutdown_pubkey, self.our_to_self_delay,
3369 &self.destination_script, (funding_txo, funding_txo_script.clone()),
3370 &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
3371 self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
3372 self.get_commitment_transaction_number_obscure_factor(),
3373 self.logger.clone());
3375 channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3380 self.channel_monitor = Some(create_monitor!());
3381 let channel_monitor = create_monitor!();
3383 self.channel_state = ChannelState::FundingCreated as u32;
3384 self.channel_id = funding_txo.to_channel_id();
3385 self.cur_remote_commitment_transaction_number -= 1;
3387 Ok((msgs::FundingCreated {
3388 temporary_channel_id: temporary_channel_id,
3389 funding_txid: funding_txo.txid,
3390 funding_output_index: funding_txo.index,
3391 signature: our_signature
3392 }, channel_monitor))
3395 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3396 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3397 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3398 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3399 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3401 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3402 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3403 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3404 if !self.config.announced_channel {
3405 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3407 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3408 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3410 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3411 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3414 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3415 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
3417 let msg = msgs::UnsignedChannelAnnouncement {
3418 features: ChannelFeatures::supported(),
3419 chain_hash: chain_hash,
3420 short_channel_id: self.get_short_channel_id().unwrap(),
3421 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3422 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3423 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey().clone() },
3424 bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { our_bitcoin_key },
3425 excess_data: Vec::new(),
3428 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3429 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement"))?;
3434 /// May panic if called on a channel that wasn't immediately-previously
3435 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3436 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3437 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3438 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3439 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3440 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3441 log_trace!(self, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3442 OptionalField::Present(DataLossProtect {
3443 your_last_per_commitment_secret: remote_last_secret,
3444 my_current_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number + 1))
3447 log_debug!(self, "We don't seen yet any revoked secret, if this channnel has already been updated it means we are fallen-behind, you should wait for other peer closing");
3448 OptionalField::Present(DataLossProtect {
3449 your_last_per_commitment_secret: [0;32],
3450 my_current_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number))
3453 msgs::ChannelReestablish {
3454 channel_id: self.channel_id(),
3455 // The protocol has two different commitment number concepts - the "commitment
3456 // transaction number", which starts from 0 and counts up, and the "revocation key
3457 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3458 // commitment transaction numbers by the index which will be used to reveal the
3459 // revocation key for that commitment transaction, which means we have to convert them
3460 // to protocol-level commitment numbers here...
3462 // next_local_commitment_number is the next commitment_signed number we expect to
3463 // receive (indicating if they need to resend one that we missed).
3464 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3465 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3466 // receive, however we track it by the next commitment number for a remote transaction
3467 // (which is one further, as they always revoke previous commitment transaction, not
3468 // the one we send) so we have to decrement by 1. Note that if
3469 // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3470 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3472 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3478 // Send stuff to our remote peers:
3480 /// Adds a pending outbound HTLC to this channel, note that you probably want
3481 /// send_htlc_and_commit instead cause you'll want both messages at once.
3482 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3483 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3484 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3485 /// You MUST call send_commitment prior to any other calls on this Channel
3486 /// If an Err is returned, it's a ChannelError::Ignore!
3487 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> {
3488 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3489 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3492 if amount_msat > self.channel_value_satoshis * 1000 {
3493 return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3495 if amount_msat < self.their_htlc_minimum_msat {
3496 return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3499 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3500 // Note that this should never really happen, if we're !is_live() on receipt of an
3501 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3502 // the user to send directly into a !is_live() channel. However, if we
3503 // disconnected during the time the previous hop was doing the commitment dance we may
3504 // end up getting here after the forwarding delay. In any case, returning an
3505 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3506 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3509 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3510 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3511 return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3513 // Check their_max_htlc_value_in_flight_msat
3514 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3515 return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
3518 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3519 // reserve for them to have something to claim if we misbehave)
3520 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3521 return Err(ChannelError::Ignore("Cannot send value that would put us over their reserve value"));
3524 //TODO: Check cltv_expiry? Do this in channel manager?
3526 // Now update local state:
3527 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3528 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3529 amount_msat: amount_msat,
3530 payment_hash: payment_hash,
3531 cltv_expiry: cltv_expiry,
3533 onion_routing_packet: onion_routing_packet,
3538 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3539 htlc_id: self.next_local_htlc_id,
3540 amount_msat: amount_msat,
3541 payment_hash: payment_hash.clone(),
3542 cltv_expiry: cltv_expiry,
3543 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3547 let res = msgs::UpdateAddHTLC {
3548 channel_id: self.channel_id,
3549 htlc_id: self.next_local_htlc_id,
3550 amount_msat: amount_msat,
3551 payment_hash: payment_hash,
3552 cltv_expiry: cltv_expiry,
3553 onion_routing_packet: onion_routing_packet,
3555 self.next_local_htlc_id += 1;
3560 /// Creates a signed commitment transaction to send to the remote peer.
3561 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3562 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3563 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3564 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3565 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3566 panic!("Cannot create commitment tx until channel is fully established");
3568 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3569 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3571 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3572 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3574 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3575 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");
3577 let mut have_updates = self.pending_update_fee.is_some();
3578 for htlc in self.pending_outbound_htlcs.iter() {
3579 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3580 have_updates = true;
3582 if have_updates { break; }
3584 for htlc in self.pending_inbound_htlcs.iter() {
3585 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3586 have_updates = true;
3588 if have_updates { break; }
3591 panic!("Cannot create commitment tx until we have some updates to send");
3593 self.send_commitment_no_status_check()
3595 /// Only fails in case of bad keys
3596 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3597 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3598 // fail to generate this, we still are at least at a position where upgrading their status
3600 for htlc in self.pending_inbound_htlcs.iter_mut() {
3601 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3602 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3604 if let Some(state) = new_state {
3608 for htlc in self.pending_outbound_htlcs.iter_mut() {
3609 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3610 Some(fail_reason.take())
3612 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3615 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3617 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3618 Ok((res, (remote_commitment_tx, mut htlcs))) => {
3619 // Update state now that we've passed all the can-fail calls...
3620 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3621 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3622 (res, remote_commitment_tx, htlcs_no_ref)
3624 Err(e) => return Err(e),
3627 self.latest_monitor_update_id += 1;
3628 let monitor_update = ChannelMonitorUpdate {
3629 update_id: self.latest_monitor_update_id,
3630 updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3631 unsigned_commitment_tx: remote_commitment_tx.clone(),
3632 htlc_outputs: htlcs.clone(),
3633 commitment_number: self.cur_remote_commitment_transaction_number,
3634 their_revocation_point: self.their_cur_commitment_point.unwrap()
3637 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
3638 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3639 Ok((res, monitor_update))
3642 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3643 /// when we shouldn't change HTLC/channel state.
3644 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3645 let mut feerate_per_kw = self.feerate_per_kw;
3646 if let Some(feerate) = self.pending_update_fee {
3647 if self.channel_outbound {
3648 feerate_per_kw = feerate;
3652 let remote_keys = self.build_remote_transaction_keys()?;
3653 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3654 let (signature, htlc_signatures);
3657 let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3658 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3662 let res = self.local_keys.sign_remote_commitment(feerate_per_kw, &remote_commitment_tx.0, &remote_keys, &htlcs, self.our_to_self_delay, &self.secp_ctx)
3663 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?;
3665 htlc_signatures = res.1;
3667 log_trace!(self, "Signed remote commitment tx {} with redeemscript {} -> {}",
3668 encode::serialize_hex(&remote_commitment_tx.0),
3669 encode::serialize_hex(&self.get_funding_redeemscript()),
3670 log_bytes!(signature.serialize_compact()[..]));
3672 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3673 log_trace!(self, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3674 encode::serialize_hex(&chan_utils::build_htlc_transaction(&remote_commitment_tx.0.txid(), feerate_per_kw, self.our_to_self_delay, htlc, &remote_keys.a_delayed_payment_key, &remote_keys.revocation_key)),
3675 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &remote_keys)),
3676 log_bytes!(remote_keys.a_htlc_key.serialize()),
3677 log_bytes!(htlc_sig.serialize_compact()[..]));
3681 Ok((msgs::CommitmentSigned {
3682 channel_id: self.channel_id,
3685 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3688 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3689 /// to send to the remote peer in one go.
3690 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3692 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> {
3693 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3694 Some(update_add_htlc) => {
3695 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3696 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3702 /// Begins the shutdown process, getting a message for the remote peer and returning all
3703 /// holding cell HTLCs for payment failure.
3704 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3705 for htlc in self.pending_outbound_htlcs.iter() {
3706 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3707 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3710 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3711 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3712 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3714 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3715 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3718 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3719 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3720 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3723 let our_closing_script = self.get_closing_scriptpubkey();
3725 // From here on out, we may not fail!
3726 if self.channel_state < ChannelState::FundingSent as u32 {
3727 self.channel_state = ChannelState::ShutdownComplete as u32;
3729 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3731 self.channel_update_count += 1;
3733 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3734 // our shutdown until we've committed all of the pending changes.
3735 self.holding_cell_update_fee = None;
3736 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3737 self.holding_cell_htlc_updates.retain(|htlc_update| {
3739 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3740 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3747 Ok((msgs::Shutdown {
3748 channel_id: self.channel_id,
3749 scriptpubkey: our_closing_script,
3750 }, dropped_outbound_htlcs))
3753 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3754 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3755 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3756 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3757 /// immediately (others we will have to allow to time out).
3758 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>) {
3759 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3761 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3762 // return them to fail the payment.
3763 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3764 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3766 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3767 dropped_outbound_htlcs.push((source, payment_hash));
3773 for _htlc in self.pending_outbound_htlcs.drain(..) {
3774 //TODO: Do something with the remaining HTLCs
3775 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3779 self.channel_state = ChannelState::ShutdownComplete as u32;
3780 self.channel_update_count += 1;
3781 if self.channel_monitor.is_some() {
3782 (self.channel_monitor.as_mut().unwrap().get_latest_local_commitment_txn(), dropped_outbound_htlcs)
3784 // We aren't even signed funding yet, so can't broadcast anything
3785 (Vec::new(), dropped_outbound_htlcs)
3790 const SERIALIZATION_VERSION: u8 = 1;
3791 const MIN_SERIALIZATION_VERSION: u8 = 1;
3793 impl Writeable for InboundHTLCRemovalReason {
3794 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3796 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3798 error_packet.write(writer)?;
3800 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3802 onion_hash.write(writer)?;
3803 err_code.write(writer)?;
3805 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3807 payment_preimage.write(writer)?;
3814 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3815 fn read(reader: &mut R) -> Result<Self, DecodeError> {
3816 Ok(match <u8 as Readable<R>>::read(reader)? {
3817 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3818 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3819 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3820 _ => return Err(DecodeError::InvalidValue),
3825 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
3826 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3827 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3828 // called but include holding cell updates (and obviously we don't modify self).
3830 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3831 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3833 self.user_id.write(writer)?;
3834 self.config.write(writer)?;
3836 self.channel_id.write(writer)?;
3837 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3838 self.channel_outbound.write(writer)?;
3839 self.channel_value_satoshis.write(writer)?;
3841 self.latest_monitor_update_id.write(writer)?;
3843 self.local_keys.write(writer)?;
3844 self.shutdown_pubkey.write(writer)?;
3845 self.destination_script.write(writer)?;
3847 self.cur_local_commitment_transaction_number.write(writer)?;
3848 self.cur_remote_commitment_transaction_number.write(writer)?;
3849 self.value_to_self_msat.write(writer)?;
3851 let mut dropped_inbound_htlcs = 0;
3852 for htlc in self.pending_inbound_htlcs.iter() {
3853 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3854 dropped_inbound_htlcs += 1;
3857 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3858 for htlc in self.pending_inbound_htlcs.iter() {
3859 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
3862 htlc.htlc_id.write(writer)?;
3863 htlc.amount_msat.write(writer)?;
3864 htlc.cltv_expiry.write(writer)?;
3865 htlc.payment_hash.write(writer)?;
3867 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
3868 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3870 htlc_state.write(writer)?;
3872 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3874 htlc_state.write(writer)?;
3876 &InboundHTLCState::Committed => {
3879 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3881 removal_reason.write(writer)?;
3886 macro_rules! write_option {
3889 &None => 0u8.write(writer)?,
3898 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3899 for htlc in self.pending_outbound_htlcs.iter() {
3900 htlc.htlc_id.write(writer)?;
3901 htlc.amount_msat.write(writer)?;
3902 htlc.cltv_expiry.write(writer)?;
3903 htlc.payment_hash.write(writer)?;
3904 htlc.source.write(writer)?;
3906 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3908 onion_packet.write(writer)?;
3910 &OutboundHTLCState::Committed => {
3913 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3915 write_option!(*fail_reason);
3917 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3919 write_option!(*fail_reason);
3921 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3923 write_option!(*fail_reason);
3928 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3929 for update in self.holding_cell_htlc_updates.iter() {
3931 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3933 amount_msat.write(writer)?;
3934 cltv_expiry.write(writer)?;
3935 payment_hash.write(writer)?;
3936 source.write(writer)?;
3937 onion_routing_packet.write(writer)?;
3939 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3941 payment_preimage.write(writer)?;
3942 htlc_id.write(writer)?;
3944 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3946 htlc_id.write(writer)?;
3947 err_packet.write(writer)?;
3952 match self.resend_order {
3953 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3954 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3957 self.monitor_pending_funding_locked.write(writer)?;
3958 self.monitor_pending_revoke_and_ack.write(writer)?;
3959 self.monitor_pending_commitment_signed.write(writer)?;
3961 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3962 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3963 pending_forward.write(writer)?;
3964 htlc_id.write(writer)?;
3967 (self.monitor_pending_failures.len() as u64).write(writer)?;
3968 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3969 htlc_source.write(writer)?;
3970 payment_hash.write(writer)?;
3971 fail_reason.write(writer)?;
3974 write_option!(self.pending_update_fee);
3975 write_option!(self.holding_cell_update_fee);
3977 self.next_local_htlc_id.write(writer)?;
3978 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3979 self.channel_update_count.write(writer)?;
3980 self.feerate_per_kw.write(writer)?;
3982 match self.last_sent_closing_fee {
3983 Some((feerate, fee, sig)) => {
3985 feerate.write(writer)?;
3989 None => 0u8.write(writer)?,
3992 write_option!(self.funding_txo);
3993 write_option!(self.funding_tx_confirmed_in);
3994 write_option!(self.short_channel_id);
3996 self.last_block_connected.write(writer)?;
3997 self.funding_tx_confirmations.write(writer)?;
3999 self.their_dust_limit_satoshis.write(writer)?;
4000 self.our_dust_limit_satoshis.write(writer)?;
4001 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4002 self.their_channel_reserve_satoshis.write(writer)?;
4003 self.their_htlc_minimum_msat.write(writer)?;
4004 self.our_htlc_minimum_msat.write(writer)?;
4005 self.their_to_self_delay.write(writer)?;
4006 self.our_to_self_delay.write(writer)?;
4007 self.their_max_accepted_htlcs.write(writer)?;
4008 self.minimum_depth.write(writer)?;
4010 write_option!(self.their_pubkeys);
4011 write_option!(self.their_cur_commitment_point);
4013 write_option!(self.their_prev_commitment_point);
4014 self.their_node_id.write(writer)?;
4016 write_option!(self.their_shutdown_scriptpubkey);
4018 self.commitment_secrets.write(writer)?;
4020 self.channel_monitor.as_ref().unwrap().write_for_disk(writer)?;
4025 impl<R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R, Arc<Logger>> for Channel<ChanSigner> {
4026 fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
4027 let _ver: u8 = Readable::read(reader)?;
4028 let min_ver: u8 = Readable::read(reader)?;
4029 if min_ver > SERIALIZATION_VERSION {
4030 return Err(DecodeError::UnknownVersion);
4033 let user_id = Readable::read(reader)?;
4034 let config: ChannelConfig = Readable::read(reader)?;
4036 let channel_id = Readable::read(reader)?;
4037 let channel_state = Readable::read(reader)?;
4038 let channel_outbound = Readable::read(reader)?;
4039 let channel_value_satoshis = Readable::read(reader)?;
4041 let latest_monitor_update_id = Readable::read(reader)?;
4043 let local_keys = Readable::read(reader)?;
4044 let shutdown_pubkey = Readable::read(reader)?;
4045 let destination_script = Readable::read(reader)?;
4047 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4048 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4049 let value_to_self_msat = Readable::read(reader)?;
4051 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4052 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4053 for _ in 0..pending_inbound_htlc_count {
4054 pending_inbound_htlcs.push(InboundHTLCOutput {
4055 htlc_id: Readable::read(reader)?,
4056 amount_msat: Readable::read(reader)?,
4057 cltv_expiry: Readable::read(reader)?,
4058 payment_hash: Readable::read(reader)?,
4059 state: match <u8 as Readable<R>>::read(reader)? {
4060 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4061 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4062 3 => InboundHTLCState::Committed,
4063 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4064 _ => return Err(DecodeError::InvalidValue),
4069 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4070 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4071 for _ in 0..pending_outbound_htlc_count {
4072 pending_outbound_htlcs.push(OutboundHTLCOutput {
4073 htlc_id: Readable::read(reader)?,
4074 amount_msat: Readable::read(reader)?,
4075 cltv_expiry: Readable::read(reader)?,
4076 payment_hash: Readable::read(reader)?,
4077 source: Readable::read(reader)?,
4078 state: match <u8 as Readable<R>>::read(reader)? {
4079 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4080 1 => OutboundHTLCState::Committed,
4081 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4082 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4083 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4084 _ => return Err(DecodeError::InvalidValue),
4089 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4090 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4091 for _ in 0..holding_cell_htlc_update_count {
4092 holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
4093 0 => HTLCUpdateAwaitingACK::AddHTLC {
4094 amount_msat: Readable::read(reader)?,
4095 cltv_expiry: Readable::read(reader)?,
4096 payment_hash: Readable::read(reader)?,
4097 source: Readable::read(reader)?,
4098 onion_routing_packet: Readable::read(reader)?,
4100 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4101 payment_preimage: Readable::read(reader)?,
4102 htlc_id: Readable::read(reader)?,
4104 2 => HTLCUpdateAwaitingACK::FailHTLC {
4105 htlc_id: Readable::read(reader)?,
4106 err_packet: Readable::read(reader)?,
4108 _ => return Err(DecodeError::InvalidValue),
4112 let resend_order = match <u8 as Readable<R>>::read(reader)? {
4113 0 => RAACommitmentOrder::CommitmentFirst,
4114 1 => RAACommitmentOrder::RevokeAndACKFirst,
4115 _ => return Err(DecodeError::InvalidValue),
4118 let monitor_pending_funding_locked = Readable::read(reader)?;
4119 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4120 let monitor_pending_commitment_signed = Readable::read(reader)?;
4122 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4123 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4124 for _ in 0..monitor_pending_forwards_count {
4125 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4128 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4129 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4130 for _ in 0..monitor_pending_failures_count {
4131 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4134 let pending_update_fee = Readable::read(reader)?;
4135 let holding_cell_update_fee = Readable::read(reader)?;
4137 let next_local_htlc_id = Readable::read(reader)?;
4138 let next_remote_htlc_id = Readable::read(reader)?;
4139 let channel_update_count = Readable::read(reader)?;
4140 let feerate_per_kw = Readable::read(reader)?;
4142 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
4144 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4145 _ => return Err(DecodeError::InvalidValue),
4148 let funding_txo = Readable::read(reader)?;
4149 let funding_tx_confirmed_in = Readable::read(reader)?;
4150 let short_channel_id = Readable::read(reader)?;
4152 let last_block_connected = Readable::read(reader)?;
4153 let funding_tx_confirmations = Readable::read(reader)?;
4155 let their_dust_limit_satoshis = Readable::read(reader)?;
4156 let our_dust_limit_satoshis = Readable::read(reader)?;
4157 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4158 let their_channel_reserve_satoshis = Readable::read(reader)?;
4159 let their_htlc_minimum_msat = Readable::read(reader)?;
4160 let our_htlc_minimum_msat = Readable::read(reader)?;
4161 let their_to_self_delay = Readable::read(reader)?;
4162 let our_to_self_delay = Readable::read(reader)?;
4163 let their_max_accepted_htlcs = Readable::read(reader)?;
4164 let minimum_depth = Readable::read(reader)?;
4166 let their_pubkeys = Readable::read(reader)?;
4167 let their_cur_commitment_point = Readable::read(reader)?;
4169 let their_prev_commitment_point = Readable::read(reader)?;
4170 let their_node_id = Readable::read(reader)?;
4172 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4173 let commitment_secrets = Readable::read(reader)?;
4175 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
4176 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
4177 // doing full block connection operations on the internal ChannelMonitor copies
4178 if monitor_last_block != last_block_connected {
4179 return Err(DecodeError::InvalidValue);
4189 secp_ctx: Secp256k1::new(),
4190 channel_value_satoshis,
4192 latest_monitor_update_id,
4198 cur_local_commitment_transaction_number,
4199 cur_remote_commitment_transaction_number,
4202 pending_inbound_htlcs,
4203 pending_outbound_htlcs,
4204 holding_cell_htlc_updates,
4208 monitor_pending_funding_locked,
4209 monitor_pending_revoke_and_ack,
4210 monitor_pending_commitment_signed,
4211 monitor_pending_forwards,
4212 monitor_pending_failures,
4215 holding_cell_update_fee,
4217 next_remote_htlc_id,
4218 channel_update_count,
4221 #[cfg(debug_assertions)]
4222 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4223 #[cfg(debug_assertions)]
4224 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4226 last_sent_closing_fee,
4229 funding_tx_confirmed_in,
4231 last_block_connected,
4232 funding_tx_confirmations,
4234 their_dust_limit_satoshis,
4235 our_dust_limit_satoshis,
4236 their_max_htlc_value_in_flight_msat,
4237 their_channel_reserve_satoshis,
4238 their_htlc_minimum_msat,
4239 our_htlc_minimum_msat,
4240 their_to_self_delay,
4242 their_max_accepted_htlcs,
4246 their_cur_commitment_point,
4248 their_prev_commitment_point,
4251 their_shutdown_scriptpubkey,
4253 channel_monitor: Some(channel_monitor),
4256 network_sync: UpdateStatus::Fresh,
4265 use bitcoin::util::bip143;
4266 use bitcoin::consensus::encode::serialize;
4267 use bitcoin::blockdata::script::{Script, Builder};
4268 use bitcoin::blockdata::transaction::Transaction;
4269 use bitcoin::blockdata::opcodes;
4270 use bitcoin_hashes::hex::FromHex;
4272 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4273 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4274 use ln::channel::MAX_FUNDING_SATOSHIS;
4276 use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4277 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4278 use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4279 use chain::transaction::OutPoint;
4280 use util::config::UserConfig;
4281 use util::test_utils;
4282 use util::logger::Logger;
4283 use secp256k1::{Secp256k1, Message, Signature, All};
4284 use secp256k1::key::{SecretKey,PublicKey};
4285 use bitcoin_hashes::sha256::Hash as Sha256;
4286 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
4287 use bitcoin_hashes::hash160::Hash as Hash160;
4288 use bitcoin_hashes::Hash;
4291 struct TestFeeEstimator {
4294 impl FeeEstimator for TestFeeEstimator {
4295 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4301 fn test_max_funding_satoshis() {
4302 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4303 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4307 chan_keys: InMemoryChannelKeys,
4309 impl KeysInterface for Keys {
4310 type ChanKeySigner = InMemoryChannelKeys;
4312 fn get_node_secret(&self) -> SecretKey { panic!(); }
4313 fn get_destination_script(&self) -> Script {
4314 let secp_ctx = Secp256k1::signing_only();
4315 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4316 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4317 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4320 fn get_shutdown_pubkey(&self) -> PublicKey {
4321 let secp_ctx = Secp256k1::signing_only();
4322 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4323 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4326 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4327 self.chan_keys.clone()
4329 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) { panic!(); }
4330 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4333 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4334 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4338 fn outbound_commitment_test() {
4339 // Test vectors from BOLT 3 Appendix C:
4340 let feeest = TestFeeEstimator{fee_est: 15000};
4341 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4342 let secp_ctx = Secp256k1::new();
4344 let chan_keys = InMemoryChannelKeys::new(
4346 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4347 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4348 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4349 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4350 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4352 // These aren't set in the test vectors:
4353 [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],
4357 assert_eq!(PublicKey::from_secret_key(&secp_ctx, chan_keys.funding_key()).serialize()[..],
4358 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4359 let keys_provider = Keys { chan_keys };
4361 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4362 let mut config = UserConfig::default();
4363 config.channel_options.announced_channel = false;
4364 let mut chan = Channel::<InMemoryChannelKeys>::new_outbound(&&feeest, &&keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4365 chan.their_to_self_delay = 144;
4366 chan.our_dust_limit_satoshis = 546;
4368 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4369 chan.funding_txo = Some(funding_info);
4371 let their_pubkeys = ChannelPublicKeys {
4372 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4373 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4374 payment_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4375 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4376 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4379 assert_eq!(their_pubkeys.payment_basepoint.serialize()[..],
4380 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4382 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4383 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4385 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4386 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4388 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4389 // derived from a commitment_seed, so instead we copy it here and call
4390 // build_commitment_transaction.
4391 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.delayed_payment_base_key());
4392 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4393 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4394 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.htlc_base_key());
4395 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.payment_basepoint, &their_pubkeys.htlc_basepoint).unwrap();
4397 chan.their_pubkeys = Some(their_pubkeys);
4399 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4401 macro_rules! test_commitment {
4402 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
4404 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4405 let htlcs = res.2.drain(..)
4406 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4410 let redeemscript = chan.get_funding_redeemscript();
4411 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4412 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4413 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4415 let mut localtx = LocalCommitmentTransaction::new_missing_local_sig(unsigned_tx.0.clone(), &their_signature, &PublicKey::from_secret_key(&secp_ctx, chan.local_keys.funding_key()), chan.their_funding_pubkey());
4416 localtx.add_local_sig(chan.local_keys.funding_key(), &redeemscript, chan.channel_value_satoshis, &chan.secp_ctx);
4418 assert_eq!(serialize(localtx.with_valid_witness())[..],
4419 hex::decode($tx_hex).unwrap()[..]);
4423 macro_rules! test_htlc_output {
4424 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4425 let remote_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4427 let ref htlc = unsigned_tx.1[$htlc_idx];
4428 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4429 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4430 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4431 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4433 let mut preimage: Option<PaymentPreimage> = None;
4436 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4437 if out == htlc.payment_hash {
4438 preimage = Some(PaymentPreimage([i; 32]));
4442 assert!(preimage.is_some());
4445 chan_utils::sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys.a_htlc_key, &keys.b_htlc_key, &keys.revocation_key, &keys.per_commitment_point, chan.local_keys.htlc_base_key(), &chan.secp_ctx).unwrap();
4446 assert_eq!(serialize(&htlc_tx)[..],
4447 hex::decode($tx_hex).unwrap()[..]);
4452 // simple commitment tx with no HTLCs
4453 chan.value_to_self_msat = 7000000000;
4455 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4456 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4457 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4460 chan.pending_inbound_htlcs.push({
4461 let mut out = InboundHTLCOutput{
4463 amount_msat: 1000000,
4465 payment_hash: PaymentHash([0; 32]),
4466 state: InboundHTLCState::Committed,
4468 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4471 chan.pending_inbound_htlcs.push({
4472 let mut out = InboundHTLCOutput{
4474 amount_msat: 2000000,
4476 payment_hash: PaymentHash([0; 32]),
4477 state: InboundHTLCState::Committed,
4479 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4482 chan.pending_outbound_htlcs.push({
4483 let mut out = OutboundHTLCOutput{
4485 amount_msat: 2000000,
4487 payment_hash: PaymentHash([0; 32]),
4488 state: OutboundHTLCState::Committed,
4489 source: HTLCSource::dummy(),
4491 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4494 chan.pending_outbound_htlcs.push({
4495 let mut out = OutboundHTLCOutput{
4497 amount_msat: 3000000,
4499 payment_hash: PaymentHash([0; 32]),
4500 state: OutboundHTLCState::Committed,
4501 source: HTLCSource::dummy(),
4503 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4506 chan.pending_inbound_htlcs.push({
4507 let mut out = InboundHTLCOutput{
4509 amount_msat: 4000000,
4511 payment_hash: PaymentHash([0; 32]),
4512 state: InboundHTLCState::Committed,
4514 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4519 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4520 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4521 chan.feerate_per_kw = 0;
4523 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4524 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4525 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4527 assert_eq!(unsigned_tx.1.len(), 5);
4529 test_htlc_output!(0,
4530 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4531 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4532 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4534 test_htlc_output!(1,
4535 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4536 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4537 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4539 test_htlc_output!(2,
4540 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4541 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4542 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4544 test_htlc_output!(3,
4545 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4546 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4547 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4549 test_htlc_output!(4,
4550 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4551 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4552 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4556 // commitment tx with seven outputs untrimmed (maximum feerate)
4557 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4558 chan.feerate_per_kw = 647;
4560 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4561 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4562 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4564 assert_eq!(unsigned_tx.1.len(), 5);
4566 test_htlc_output!(0,
4567 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4568 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4569 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4571 test_htlc_output!(1,
4572 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4573 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4574 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4576 test_htlc_output!(2,
4577 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4578 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4579 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4581 test_htlc_output!(3,
4582 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4583 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4584 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4586 test_htlc_output!(4,
4587 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4588 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4589 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4593 // commitment tx with six outputs untrimmed (minimum feerate)
4594 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4595 chan.feerate_per_kw = 648;
4597 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4598 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4599 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4601 assert_eq!(unsigned_tx.1.len(), 4);
4603 test_htlc_output!(0,
4604 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4605 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4606 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4608 test_htlc_output!(1,
4609 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4610 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4611 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4613 test_htlc_output!(2,
4614 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4615 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4616 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4618 test_htlc_output!(3,
4619 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4620 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4621 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4625 // commitment tx with six outputs untrimmed (maximum feerate)
4626 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4627 chan.feerate_per_kw = 2069;
4629 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4630 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4631 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4633 assert_eq!(unsigned_tx.1.len(), 4);
4635 test_htlc_output!(0,
4636 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4637 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4638 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4640 test_htlc_output!(1,
4641 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4642 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4643 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4645 test_htlc_output!(2,
4646 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4647 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4648 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4650 test_htlc_output!(3,
4651 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4652 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4653 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4657 // commitment tx with five outputs untrimmed (minimum feerate)
4658 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4659 chan.feerate_per_kw = 2070;
4661 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4662 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4663 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4665 assert_eq!(unsigned_tx.1.len(), 3);
4667 test_htlc_output!(0,
4668 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4669 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4670 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4672 test_htlc_output!(1,
4673 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4674 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4675 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4677 test_htlc_output!(2,
4678 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4679 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4680 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4684 // commitment tx with five outputs untrimmed (maximum feerate)
4685 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4686 chan.feerate_per_kw = 2194;
4688 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4689 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4690 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4692 assert_eq!(unsigned_tx.1.len(), 3);
4694 test_htlc_output!(0,
4695 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4696 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4697 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4699 test_htlc_output!(1,
4700 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4701 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4702 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4704 test_htlc_output!(2,
4705 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4706 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4707 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4711 // commitment tx with four outputs untrimmed (minimum feerate)
4712 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4713 chan.feerate_per_kw = 2195;
4715 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4716 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4717 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4719 assert_eq!(unsigned_tx.1.len(), 2);
4721 test_htlc_output!(0,
4722 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4723 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4724 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4726 test_htlc_output!(1,
4727 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4728 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4729 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4733 // commitment tx with four outputs untrimmed (maximum feerate)
4734 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4735 chan.feerate_per_kw = 3702;
4737 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4738 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4739 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4741 assert_eq!(unsigned_tx.1.len(), 2);
4743 test_htlc_output!(0,
4744 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4745 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4746 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4748 test_htlc_output!(1,
4749 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4750 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4751 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4755 // commitment tx with three outputs untrimmed (minimum feerate)
4756 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4757 chan.feerate_per_kw = 3703;
4759 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4760 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4761 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4763 assert_eq!(unsigned_tx.1.len(), 1);
4765 test_htlc_output!(0,
4766 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4767 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4768 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4772 // commitment tx with three outputs untrimmed (maximum feerate)
4773 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4774 chan.feerate_per_kw = 4914;
4776 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4777 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4778 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4780 assert_eq!(unsigned_tx.1.len(), 1);
4782 test_htlc_output!(0,
4783 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4784 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4785 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4789 // commitment tx with two outputs untrimmed (minimum feerate)
4790 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4791 chan.feerate_per_kw = 4915;
4793 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4794 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4795 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4797 assert_eq!(unsigned_tx.1.len(), 0);
4801 // commitment tx with two outputs untrimmed (maximum feerate)
4802 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4803 chan.feerate_per_kw = 9651180;
4805 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4806 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4807 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4809 assert_eq!(unsigned_tx.1.len(), 0);
4813 // commitment tx with one output untrimmed (minimum feerate)
4814 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4815 chan.feerate_per_kw = 9651181;
4817 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4818 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4819 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4821 assert_eq!(unsigned_tx.1.len(), 0);
4825 // commitment tx with fee greater than funder amount
4826 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4827 chan.feerate_per_kw = 9651936;
4829 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4830 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4831 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4833 assert_eq!(unsigned_tx.1.len(), 0);
4838 fn test_per_commitment_secret_gen() {
4839 // Test vectors from BOLT 3 Appendix D:
4841 let mut seed = [0; 32];
4842 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4843 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4844 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4846 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4847 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4848 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4850 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
4851 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4853 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
4854 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4856 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4857 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
4858 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4862 fn test_key_derivation() {
4863 // Test vectors from BOLT 3 Appendix E:
4864 let secp_ctx = Secp256k1::new();
4866 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4867 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4869 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4870 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4872 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4873 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4875 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4876 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4878 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4879 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4881 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4882 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4884 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4885 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());