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::{Sha256dHash, Hash160};
6 use bitcoin::util::bip143;
8 use bitcoin::network::serialize::{BitcoinHash, RawDecoder, RawEncoder};
9 use bitcoin::network::encodable::{ConsensusEncodable, ConsensusDecodable};
11 use secp256k1::key::{PublicKey,SecretKey};
12 use secp256k1::{Secp256k1,Message,Signature};
15 use crypto::digest::Digest;
18 use ln::msgs::{DecodeError, ErrorAction, HandleError};
19 use ln::channelmonitor::ChannelMonitor;
20 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder};
21 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
23 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
24 use chain::transaction::OutPoint;
25 use chain::keysinterface::{ChannelKeys, KeysInterface};
26 use util::{transaction_utils,rng};
27 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
28 use util::sha2::Sha256;
29 use util::logger::Logger;
30 use util::errors::APIError;
33 use std::default::Default;
35 use std::time::Instant;
39 pub struct ChannelValueStat {
40 pub value_to_self_msat: u64,
41 pub channel_value_msat: u64,
42 pub channel_reserve_msat: u64,
43 pub pending_outbound_htlcs_amount_msat: u64,
44 pub pending_inbound_htlcs_amount_msat: u64,
45 pub holding_cell_outbound_amount_msat: u64,
46 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
49 enum InboundHTLCRemovalReason {
50 FailRelay(msgs::OnionErrorPacket),
51 FailMalformed(([u8; 32], u16)),
55 enum InboundHTLCState {
56 /// Added by remote, to be included in next local commitment tx.
57 RemoteAnnounced(PendingHTLCStatus),
58 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
59 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
60 /// accept this HTLC. Implies AwaitingRemoteRevoke.
61 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
62 /// a remote revoke_and_ack on a previous state before we can do so.
63 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
64 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
65 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
66 /// accept this HTLC. Implies AwaitingRemoteRevoke.
67 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
69 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
71 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
72 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
74 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
75 /// commitment transaction without it as otherwise we'll have to force-close the channel to
76 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
77 /// anyway). That said, ChannelMonitor does this for us (see
78 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
79 /// local state before then, once we're sure that the next commitment_signed and
80 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
81 LocalRemoved(InboundHTLCRemovalReason),
84 struct InboundHTLCOutput {
88 payment_hash: [u8; 32],
89 state: InboundHTLCState,
92 enum OutboundHTLCState {
93 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
94 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
95 /// we will promote to Committed (note that they may not accept it until the next time we
96 /// revoke, but we dont really care about that:
97 /// * they've revoked, so worst case we can announce an old state and get our (option on)
98 /// money back (though we wont), and,
99 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
100 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
101 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
102 /// we'll never get out of sync).
103 /// Note that we Box the OnionPacket as its rather large and we don't want to blow up
104 /// OutboundHTLCOutput's size just for a temporary bit
105 LocalAnnounced(Box<msgs::OnionPacket>),
107 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
108 /// the change (though they'll need to revoke before we fail the payment).
110 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
111 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
113 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
114 /// remote revoke_and_ack on a previous state before we can do so.
115 AwaitingRemoteRevokeToRemove,
116 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
117 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
119 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
120 /// revoke_and_ack to drop completely.
121 AwaitingRemovedRemoteRevoke,
124 struct OutboundHTLCOutput {
128 payment_hash: [u8; 32],
129 state: OutboundHTLCState,
131 /// If we're in a removed state, set if they failed, otherwise None
132 fail_reason: Option<HTLCFailReason>,
135 macro_rules! get_htlc_in_commitment {
136 ($htlc: expr, $offered: expr) => {
137 HTLCOutputInCommitment {
139 amount_msat: $htlc.amount_msat,
140 cltv_expiry: $htlc.cltv_expiry,
141 payment_hash: $htlc.payment_hash,
142 transaction_output_index: 0
147 /// See AwaitingRemoteRevoke ChannelState for more info
148 enum HTLCUpdateAwaitingACK {
153 payment_hash: [u8; 32],
155 onion_routing_packet: msgs::OnionPacket,
156 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
159 payment_preimage: [u8; 32],
164 err_packet: msgs::OnionErrorPacket,
168 /// There are a few "states" and then a number of flags which can be applied:
169 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
170 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
171 /// move on to ChannelFunded.
172 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
173 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
174 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
176 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
177 OurInitSent = (1 << 0),
178 /// Implies we have received their open_channel/accept_channel message
179 TheirInitSent = (1 << 1),
180 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
181 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
182 /// upon receipt of funding_created, so simply skip this state.
184 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
185 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
186 /// and our counterparty consider the funding transaction confirmed.
188 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
189 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
190 TheirFundingLocked = (1 << 4),
191 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
192 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
193 OurFundingLocked = (1 << 5),
195 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
196 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
198 PeerDisconnected = (1 << 7),
199 /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
200 /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
201 /// messages until they've managed to do so.
202 MonitorUpdateFailed = (1 << 8),
203 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
204 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
205 /// messages as then we will be unable to determine which HTLCs they included in their
206 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
208 /// Flag is set on ChannelFunded.
209 AwaitingRemoteRevoke = (1 << 9),
210 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
211 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
212 /// to respond with our own shutdown message when possible.
213 RemoteShutdownSent = (1 << 10),
214 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
215 /// point, we may not add any new HTLCs to the channel.
216 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
217 /// us their shutdown.
218 LocalShutdownSent = (1 << 11),
219 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
220 /// to drop us, but we store this anyway.
221 ShutdownComplete = 4096,
223 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
224 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
226 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
228 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
229 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
230 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
232 pub(super) struct Channel {
235 channel_id: [u8; 32],
237 channel_outbound: bool,
238 secp_ctx: Secp256k1<secp256k1::All>,
239 announce_publicly: bool,
240 channel_value_satoshis: u64,
242 local_keys: ChannelKeys,
243 shutdown_pubkey: PublicKey,
245 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
246 // generation start at 0 and count up...this simplifies some parts of implementation at the
247 // cost of others, but should really just be changed.
249 cur_local_commitment_transaction_number: u64,
250 cur_remote_commitment_transaction_number: u64,
251 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
252 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
253 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
254 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
255 /// remote revoke when we received the latest commitment update from the remote we have to make
256 /// sure that commitment update gets resent first.
257 received_commitment_while_awaiting_raa: bool,
258 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
259 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
260 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
262 monitor_pending_revoke_and_ack: bool,
263 monitor_pending_commitment_signed: bool,
264 monitor_pending_order: Option<RAACommitmentOrder>,
265 monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
266 monitor_pending_failures: Vec<(HTLCSource, [u8; 32], HTLCFailReason)>,
268 // pending_update_fee is filled when sending and receiving update_fee
269 // For outbound channel, feerate_per_kw is updated with the value from
270 // pending_update_fee when revoke_and_ack is received
272 // For inbound channel, feerate_per_kw is updated when it receives
273 // commitment_signed and revoke_and_ack is generated
274 // The pending value is kept when another pair of update_fee and commitment_signed
275 // is received during AwaitingRemoteRevoke and relieved when the expected
276 // revoke_and_ack is received and new commitment_signed is generated to be
277 // sent to the funder. Otherwise, the pending value is removed when receiving
278 // commitment_signed.
279 pending_update_fee: Option<u64>,
280 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
281 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
282 // is received. holding_cell_update_fee is updated when there are additional
283 // update_fee() during ChannelState::AwaitingRemoteRevoke.
284 holding_cell_update_fee: Option<u64>,
285 next_local_htlc_id: u64,
286 next_remote_htlc_id: u64,
287 channel_update_count: u32,
290 #[cfg(debug_assertions)]
291 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
292 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
293 #[cfg(debug_assertions)]
294 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
295 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
298 // Used in ChannelManager's tests to send a revoked transaction
299 pub last_local_commitment_txn: Vec<Transaction>,
301 last_local_commitment_txn: Vec<Transaction>,
303 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
305 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
306 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
307 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
308 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
309 funding_tx_confirmed_in: Option<Sha256dHash>,
310 short_channel_id: Option<u64>,
311 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
312 /// ChannelManager deserialization (hence pub(super))
313 pub(super) last_block_connected: Sha256dHash,
314 funding_tx_confirmations: u64,
316 their_dust_limit_satoshis: u64,
317 our_dust_limit_satoshis: u64,
318 their_max_htlc_value_in_flight_msat: u64,
319 //get_our_max_htlc_value_in_flight_msat(): u64,
320 /// minimum channel reserve for **self** to maintain - set by them.
321 their_channel_reserve_satoshis: u64,
322 //get_our_channel_reserve_satoshis(): u64,
323 their_htlc_minimum_msat: u64,
324 our_htlc_minimum_msat: u64,
325 their_to_self_delay: u16,
326 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
327 their_max_accepted_htlcs: u16,
328 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
331 their_funding_pubkey: Option<PublicKey>,
332 their_revocation_basepoint: Option<PublicKey>,
333 their_payment_basepoint: Option<PublicKey>,
334 their_delayed_payment_basepoint: Option<PublicKey>,
335 their_htlc_basepoint: Option<PublicKey>,
336 their_cur_commitment_point: Option<PublicKey>,
338 their_prev_commitment_point: Option<PublicKey>,
339 their_node_id: PublicKey,
341 their_shutdown_scriptpubkey: Option<Script>,
343 channel_monitor: ChannelMonitor,
348 const OUR_MAX_HTLCS: u16 = 5; //TODO
349 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
350 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
351 /// really allow for this, so instead we're stuck closing it out at that point.
352 const UNCONF_THRESHOLD: u32 = 6;
353 /// The amount of time we require our counterparty wait to claim their money (ie time between when
354 /// we, or our watchtower, must check for them having broadcast a theft transaction).
355 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
356 /// The amount of time we're willing to wait to claim money back to us
357 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
358 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
359 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
360 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
361 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?)
362 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
364 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
366 /// Used to return a simple Error back to ChannelManager. Will get converted to a
367 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
368 /// channel_id in ChannelManager.
369 pub(super) enum ChannelError {
370 Ignore(&'static str),
374 macro_rules! secp_call {
375 ( $res: expr, $err: expr, $chan_id: expr ) => {
378 Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
383 macro_rules! secp_derived_key {
384 ( $res: expr, $chan_id: expr ) => {
385 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
389 // Convert constants + channel value to limits:
390 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
391 channel_value_satoshis * 1000 / 10 //TODO
394 /// Returns a minimum channel reserve value **they** need to maintain
396 /// Guaranteed to return a value no larger than channel_value_satoshis
397 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
398 let (q, _) = channel_value_satoshis.overflowing_div(100);
399 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
402 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
403 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
406 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
410 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
411 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
413 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
418 pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, announce_publicly: bool, user_id: u64, logger: Arc<Logger>) -> Result<Channel, APIError> {
419 let chan_keys = keys_provider.get_channel_keys(false);
421 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
422 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
425 if push_msat > channel_value_satoshis * 1000 {
426 return Err(APIError::APIMisuseError{err: "push value > channel value"});
430 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
431 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
432 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
435 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
437 let secp_ctx = Secp256k1::new();
438 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
439 &chan_keys.htlc_base_key, BREAKDOWN_TIMEOUT,
440 keys_provider.get_destination_script(), logger.clone());
445 channel_id: rng::rand_u832(),
446 channel_state: ChannelState::OurInitSent as u32,
447 channel_outbound: true,
449 announce_publicly: announce_publicly,
450 channel_value_satoshis: channel_value_satoshis,
452 local_keys: chan_keys,
453 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
454 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
455 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
456 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
457 received_commitment_while_awaiting_raa: false,
459 pending_inbound_htlcs: Vec::new(),
460 pending_outbound_htlcs: Vec::new(),
461 holding_cell_htlc_updates: Vec::new(),
462 pending_update_fee: None,
463 holding_cell_update_fee: None,
464 next_local_htlc_id: 0,
465 next_remote_htlc_id: 0,
466 channel_update_count: 1,
468 monitor_pending_revoke_and_ack: false,
469 monitor_pending_commitment_signed: false,
470 monitor_pending_order: None,
471 monitor_pending_forwards: Vec::new(),
472 monitor_pending_failures: Vec::new(),
474 #[cfg(debug_assertions)]
475 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
476 #[cfg(debug_assertions)]
477 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
479 last_local_commitment_txn: Vec::new(),
481 last_sent_closing_fee: None,
483 funding_tx_confirmed_in: None,
484 short_channel_id: None,
485 last_block_connected: Default::default(),
486 funding_tx_confirmations: 0,
488 feerate_per_kw: feerate,
489 their_dust_limit_satoshis: 0,
490 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
491 their_max_htlc_value_in_flight_msat: 0,
492 their_channel_reserve_satoshis: 0,
493 their_htlc_minimum_msat: 0,
494 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
495 their_to_self_delay: 0,
496 their_max_accepted_htlcs: 0,
497 minimum_depth: 0, // Filled in in accept_channel
499 their_funding_pubkey: None,
500 their_revocation_basepoint: None,
501 their_payment_basepoint: None,
502 their_delayed_payment_basepoint: None,
503 their_htlc_basepoint: None,
504 their_cur_commitment_point: None,
506 their_prev_commitment_point: None,
507 their_node_id: their_node_id,
509 their_shutdown_scriptpubkey: None,
511 channel_monitor: channel_monitor,
517 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
518 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
519 return Err(ChannelError::Close("Peer's feerate much too low"));
521 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
522 return Err(ChannelError::Close("Peer's feerate much too high"));
527 /// Creates a new channel from a remote sides' request for one.
528 /// Assumes chain_hash has already been checked and corresponds with what we expect!
529 pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, require_announce: bool, allow_announce: bool, logger: Arc<Logger>) -> Result<Channel, ChannelError> {
530 let chan_keys = keys_provider.get_channel_keys(true);
532 // Check sanity of message fields:
533 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
534 return Err(ChannelError::Close("funding value > 2^24"));
536 if msg.channel_reserve_satoshis > msg.funding_satoshis {
537 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
539 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
540 return Err(ChannelError::Close("push_msat larger than funding value"));
542 if msg.dust_limit_satoshis > msg.funding_satoshis {
543 return Err(ChannelError::Close("Peer never wants payout outputs?"));
545 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
546 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
548 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
549 return Err(ChannelError::Close("Miminum htlc value is full channel value"));
551 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
553 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
554 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
556 if msg.max_accepted_htlcs < 1 {
557 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
559 if msg.max_accepted_htlcs > 483 {
560 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
563 // Convert things into internal flags and prep our state:
565 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
566 if require_announce && !their_announce {
567 return Err(ChannelError::Close("Peer tried to open unannounced channel, but we require public ones"));
569 if !allow_announce && their_announce {
570 return Err(ChannelError::Close("Peer tried to open announced channel, but we require private ones"));
573 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
575 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
576 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
577 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
578 return Err(ChannelError::Close("Suitalbe channel reserve not found. aborting"));
580 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
581 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
583 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
584 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
587 // check if the funder's amount for the initial commitment tx is sufficient
588 // for full fee payment
589 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
590 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
591 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
594 let to_local_msat = msg.push_msat;
595 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
596 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
597 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
600 let secp_ctx = Secp256k1::new();
601 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
602 &chan_keys.htlc_base_key, BREAKDOWN_TIMEOUT,
603 keys_provider.get_destination_script(), logger.clone());
604 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
605 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
607 let mut chan = Channel {
610 channel_id: msg.temporary_channel_id,
611 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
612 channel_outbound: false,
614 announce_publicly: their_announce,
616 local_keys: chan_keys,
617 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
618 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
619 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
620 value_to_self_msat: msg.push_msat,
621 received_commitment_while_awaiting_raa: false,
623 pending_inbound_htlcs: Vec::new(),
624 pending_outbound_htlcs: Vec::new(),
625 holding_cell_htlc_updates: Vec::new(),
626 pending_update_fee: None,
627 holding_cell_update_fee: None,
628 next_local_htlc_id: 0,
629 next_remote_htlc_id: 0,
630 channel_update_count: 1,
632 monitor_pending_revoke_and_ack: false,
633 monitor_pending_commitment_signed: false,
634 monitor_pending_order: None,
635 monitor_pending_forwards: Vec::new(),
636 monitor_pending_failures: Vec::new(),
638 #[cfg(debug_assertions)]
639 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
640 #[cfg(debug_assertions)]
641 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
643 last_local_commitment_txn: Vec::new(),
645 last_sent_closing_fee: None,
647 funding_tx_confirmed_in: None,
648 short_channel_id: None,
649 last_block_connected: Default::default(),
650 funding_tx_confirmations: 0,
652 feerate_per_kw: msg.feerate_per_kw as u64,
653 channel_value_satoshis: msg.funding_satoshis,
654 their_dust_limit_satoshis: msg.dust_limit_satoshis,
655 our_dust_limit_satoshis: our_dust_limit_satoshis,
656 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
657 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
658 their_htlc_minimum_msat: msg.htlc_minimum_msat,
659 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
660 their_to_self_delay: msg.to_self_delay,
661 their_max_accepted_htlcs: msg.max_accepted_htlcs,
662 minimum_depth: Channel::derive_minimum_depth(msg.funding_satoshis*1000, msg.push_msat),
664 their_funding_pubkey: Some(msg.funding_pubkey),
665 their_revocation_basepoint: Some(msg.revocation_basepoint),
666 their_payment_basepoint: Some(msg.payment_basepoint),
667 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
668 their_htlc_basepoint: Some(msg.htlc_basepoint),
669 their_cur_commitment_point: Some(msg.first_per_commitment_point),
671 their_prev_commitment_point: None,
672 their_node_id: their_node_id,
674 their_shutdown_scriptpubkey: None,
676 channel_monitor: channel_monitor,
681 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
682 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
687 // Utilities to derive keys:
689 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
690 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
691 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
694 // Utilities to build transactions:
696 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
697 let mut sha = Sha256::new();
698 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
700 if self.channel_outbound {
701 sha.input(&our_payment_basepoint.serialize());
702 sha.input(&self.their_payment_basepoint.unwrap().serialize());
704 sha.input(&self.their_payment_basepoint.unwrap().serialize());
705 sha.input(&our_payment_basepoint.serialize());
707 let mut res = [0; 32];
708 sha.result(&mut res);
710 ((res[26] as u64) << 5*8) |
711 ((res[27] as u64) << 4*8) |
712 ((res[28] as u64) << 3*8) |
713 ((res[29] as u64) << 2*8) |
714 ((res[30] as u64) << 1*8) |
715 ((res[31] as u64) << 0*8)
718 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
719 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
720 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
721 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
722 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
724 /// @local is used only to convert relevant internal structures which refer to remote vs local
725 /// to decide value of outputs and direction of HTLCs.
726 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
727 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
728 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
729 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
730 /// which peer generated this transaction and "to whom" this transaction flows.
732 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>) {
733 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
736 let mut ins: Vec<TxIn> = Vec::new();
738 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
739 script_sig: Script::new(),
740 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
746 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
748 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
749 let mut remote_htlc_total_msat = 0;
750 let mut local_htlc_total_msat = 0;
751 let mut value_to_self_msat_offset = 0;
753 macro_rules! add_htlc_output {
754 ($htlc: expr, $outbound: expr) => {
755 if $outbound == local { // "offered HTLC output"
756 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
757 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
759 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
760 value: $htlc.amount_msat / 1000
761 }, Some(htlc_in_tx)));
764 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
765 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
766 txouts.push((TxOut { // "received HTLC output"
767 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
768 value: $htlc.amount_msat / 1000
769 }, Some(htlc_in_tx)));
775 for ref htlc in self.pending_inbound_htlcs.iter() {
776 let include = match htlc.state {
777 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
778 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
779 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
780 InboundHTLCState::Committed => true,
781 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
785 add_htlc_output!(htlc, false);
786 remote_htlc_total_msat += htlc.amount_msat;
789 &InboundHTLCState::LocalRemoved(ref reason) => {
790 if generated_by_local {
791 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
792 value_to_self_msat_offset += htlc.amount_msat as i64;
801 for ref htlc in self.pending_outbound_htlcs.iter() {
802 let include = match htlc.state {
803 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
804 OutboundHTLCState::Committed => true,
805 OutboundHTLCState::RemoteRemoved => generated_by_local,
806 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
807 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
811 add_htlc_output!(htlc, true);
812 local_htlc_total_msat += htlc.amount_msat;
815 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
816 if htlc.fail_reason.is_none() {
817 value_to_self_msat_offset -= htlc.amount_msat as i64;
820 OutboundHTLCState::RemoteRemoved => {
821 if !generated_by_local && htlc.fail_reason.is_none() {
822 value_to_self_msat_offset -= htlc.amount_msat as i64;
831 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
832 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset;
834 #[cfg(debug_assertions)]
836 // Make sure that the to_self/to_remote is always either past the appropriate
837 // channel_reserve *or* it is making progress towards it.
838 // TODO: This should happen after fee calculation, but we don't handle that correctly
840 let mut max_commitment_tx_output = if generated_by_local {
841 self.max_commitment_tx_output_local.lock().unwrap()
843 self.max_commitment_tx_output_remote.lock().unwrap()
845 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);
846 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
847 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
848 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
851 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
852 let (value_to_self, value_to_remote) = if self.channel_outbound {
853 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
855 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
858 let value_to_a = if local { value_to_self } else { value_to_remote };
859 let value_to_b = if local { value_to_remote } else { value_to_self };
861 if value_to_a >= (dust_limit_satoshis as i64) {
863 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
864 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
865 &keys.a_delayed_payment_key).to_v0_p2wsh(),
866 value: value_to_a as u64
870 if value_to_b >= (dust_limit_satoshis as i64) {
872 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
873 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
875 value: value_to_b as u64
879 transaction_utils::sort_outputs(&mut txouts);
881 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
882 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
883 for (idx, out) in txouts.drain(..).enumerate() {
885 if let Some(out_htlc) = out.1 {
886 htlcs_used.push(out_htlc);
887 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
893 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
900 fn get_closing_scriptpubkey(&self) -> Script {
901 let our_channel_close_key_hash = Hash160::from_data(&self.shutdown_pubkey.serialize());
902 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
906 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
907 (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)
911 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
913 let mut ins: Vec<TxIn> = Vec::new();
915 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
916 script_sig: Script::new(),
917 sequence: 0xffffffff,
923 assert!(self.pending_inbound_htlcs.is_empty());
924 assert!(self.pending_outbound_htlcs.is_empty());
925 let mut txouts: Vec<(TxOut, ())> = Vec::new();
927 let mut total_fee_satoshis = proposed_total_fee_satoshis;
928 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
929 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 };
931 if value_to_self < 0 {
932 assert!(self.channel_outbound);
933 total_fee_satoshis += (-value_to_self) as u64;
934 } else if value_to_remote < 0 {
935 assert!(!self.channel_outbound);
936 total_fee_satoshis += (-value_to_remote) as u64;
939 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
941 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
942 value: value_to_remote as u64
946 if value_to_self as u64 > self.our_dust_limit_satoshis {
948 script_pubkey: self.get_closing_scriptpubkey(),
949 value: value_to_self as u64
953 transaction_utils::sort_outputs(&mut txouts);
955 let mut outputs: Vec<TxOut> = Vec::new();
956 for out in txouts.drain(..) {
965 }, total_fee_satoshis)
969 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
970 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
971 /// our counterparty!)
972 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
973 /// TODO Some magic rust shit to compile-time check this?
974 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
975 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
976 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
977 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
979 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), self.channel_id()))
983 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
984 /// will sign and send to our counterparty.
985 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
986 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
987 //may see payments to it!
988 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
989 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
990 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
992 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), self.channel_id()))
995 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
996 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
997 /// Panics if called before accept_channel/new_from_req
998 pub fn get_funding_redeemscript(&self) -> Script {
999 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1000 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1001 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1002 if our_funding_key[..] < their_funding_key[..] {
1003 builder.push_slice(&our_funding_key)
1004 .push_slice(&their_funding_key)
1006 builder.push_slice(&their_funding_key)
1007 .push_slice(&our_funding_key)
1008 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1011 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1012 if tx.input.len() != 1 {
1013 panic!("Tried to sign commitment transaction that had input count != 1!");
1015 if tx.input[0].witness.len() != 0 {
1016 panic!("Tried to re-sign commitment transaction");
1019 let funding_redeemscript = self.get_funding_redeemscript();
1021 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1022 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1024 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1026 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1027 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1028 if our_funding_key[..] < their_funding_key[..] {
1029 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1030 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1032 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1033 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1035 tx.input[0].witness[1].push(SigHashType::All as u8);
1036 tx.input[0].witness[2].push(SigHashType::All as u8);
1038 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1043 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1044 /// @local is used only to convert relevant internal structures which refer to remote vs local
1045 /// to decide value of outputs and direction of HTLCs.
1046 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1047 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1050 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
1051 if tx.input.len() != 1 {
1052 panic!("Tried to sign HTLC transaction that had input count != 1!");
1055 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1057 let our_htlc_key = secp_derived_key!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), self.channel_id());
1058 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1059 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1060 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1063 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1064 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1065 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1066 if tx.input.len() != 1 {
1067 panic!("Tried to sign HTLC transaction that had input count != 1!");
1069 if tx.input[0].witness.len() != 0 {
1070 panic!("Tried to re-sign HTLC transaction");
1073 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1075 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1077 if local_tx { // b, then a
1078 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1079 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1081 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1082 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1084 tx.input[0].witness[1].push(SigHashType::All as u8);
1085 tx.input[0].witness[2].push(SigHashType::All as u8);
1088 tx.input[0].witness.push(Vec::new());
1090 tx.input[0].witness.push(preimage.unwrap().to_vec());
1093 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1098 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1099 /// debug_assertions are turned on
1100 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1101 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1102 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1103 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1105 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1106 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1108 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1110 let mut sha = Sha256::new();
1111 sha.input(&payment_preimage_arg);
1112 let mut payment_hash_calc = [0; 32];
1113 sha.result(&mut payment_hash_calc);
1115 let mut pending_idx = std::usize::MAX;
1116 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1117 if htlc.htlc_id == htlc_id_arg {
1118 assert_eq!(htlc.payment_hash, payment_hash_calc);
1119 if let InboundHTLCState::Committed = htlc.state {
1121 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1122 // Don't return in release mode here so that we can update channel_monitor
1128 if pending_idx == std::usize::MAX {
1129 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1130 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1133 // Now update local state:
1135 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1136 // can claim it even if the channel hits the chain before we see their next commitment.
1137 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1139 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1140 for pending_update in self.holding_cell_htlc_updates.iter() {
1141 match pending_update {
1142 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1143 if htlc_id_arg == htlc_id {
1144 debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1145 return Ok((None, None));
1148 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1149 if htlc_id_arg == htlc_id {
1150 debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1151 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1157 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1158 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1160 return Ok((None, Some(self.channel_monitor.clone())));
1164 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1165 if let InboundHTLCState::Committed = htlc.state {
1167 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1168 return Ok((None, Some(self.channel_monitor.clone())));
1170 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1173 Ok((Some(msgs::UpdateFulfillHTLC {
1174 channel_id: self.channel_id(),
1175 htlc_id: htlc_id_arg,
1176 payment_preimage: payment_preimage_arg,
1177 }), Some(self.channel_monitor.clone())))
1180 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: [u8; 32]) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), HandleError> {
1181 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1182 (Some(update_fulfill_htlc), _) => {
1183 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1184 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1186 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1187 (None, None) => Ok((None, None))
1191 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1192 /// debug_assertions are turned on
1193 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1194 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1195 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1197 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1199 let mut pending_idx = std::usize::MAX;
1200 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1201 if htlc.htlc_id == htlc_id_arg {
1202 if let InboundHTLCState::Committed = htlc.state {
1204 debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1205 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1210 if pending_idx == std::usize::MAX {
1211 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1212 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1215 // Now update local state:
1216 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1217 for pending_update in self.holding_cell_htlc_updates.iter() {
1218 match pending_update {
1219 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1220 if htlc_id_arg == htlc_id {
1221 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1222 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1225 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1226 if htlc_id_arg == htlc_id {
1227 debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1234 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1235 htlc_id: htlc_id_arg,
1242 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1243 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1246 Ok(Some(msgs::UpdateFailHTLC {
1247 channel_id: self.channel_id(),
1248 htlc_id: htlc_id_arg,
1253 pub fn get_update_fail_htlc_and_commit(&mut self, htlc_id: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
1254 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1255 Some(update_fail_htlc) => {
1256 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1257 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1263 // Message handlers:
1265 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), ChannelError> {
1266 // Check sanity of message fields:
1267 if !self.channel_outbound {
1268 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1270 if self.channel_state != ChannelState::OurInitSent as u32 {
1271 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1273 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1274 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1276 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1277 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1279 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1280 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1282 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1283 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1285 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1286 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1288 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1289 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1291 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1292 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1294 if msg.max_accepted_htlcs < 1 {
1295 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1297 if msg.max_accepted_htlcs > 483 {
1298 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1301 // TODO: Optional additional constraints mentioned in the spec
1302 // MAY fail the channel if
1303 // funding_satoshi is too small
1304 // htlc_minimum_msat too large
1305 // max_htlc_value_in_flight_msat too small
1306 // channel_reserve_satoshis too large
1307 // max_accepted_htlcs too small
1308 // dust_limit_satoshis too small
1310 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1312 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1313 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1314 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1315 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1316 self.their_to_self_delay = msg.to_self_delay;
1317 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1318 self.minimum_depth = msg.minimum_depth;
1319 self.their_funding_pubkey = Some(msg.funding_pubkey);
1320 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1321 self.their_payment_basepoint = Some(msg.payment_basepoint);
1322 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1323 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1324 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1326 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1327 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1328 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1330 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1335 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1336 let funding_script = self.get_funding_redeemscript();
1338 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1339 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1340 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1342 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1343 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1345 let remote_keys = self.build_remote_transaction_keys()?;
1346 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1347 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1349 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1350 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key)))
1353 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1354 if self.channel_outbound {
1355 return Err(HandleError{err: "Received funding_created for an outbound channel?", action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: self.channel_id, data: "Received funding_created for an outbound channel?".to_string()}})});
1357 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1358 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1359 // remember the channel, so its safe to just send an error_message here and drop the
1361 return Err(HandleError{err: "Received funding_created after we got the channel!", action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: self.channel_id, data: "Received funding_created after we got the channel!".to_string()}})});
1363 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1364 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1365 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1366 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1369 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1370 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1371 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1373 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1376 self.channel_monitor.unset_funding_info();
1381 // Now that we're past error-generating stuff, update our local state:
1383 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1384 self.channel_state = ChannelState::FundingSent as u32;
1385 self.channel_id = funding_txo.to_channel_id();
1386 self.cur_remote_commitment_transaction_number -= 1;
1387 self.cur_local_commitment_transaction_number -= 1;
1389 Ok((msgs::FundingSigned {
1390 channel_id: self.channel_id,
1391 signature: our_signature
1392 }, self.channel_monitor.clone()))
1395 /// Handles a funding_signed message from the remote end.
1396 /// If this call is successful, broadcast the funding transaction (and not before!)
1397 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1398 if !self.channel_outbound {
1399 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1401 if self.channel_state != ChannelState::FundingCreated as u32 {
1402 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1404 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1405 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1406 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1407 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1410 let funding_script = self.get_funding_redeemscript();
1412 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1413 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1414 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1416 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1417 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1419 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1420 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1421 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1422 self.channel_state = ChannelState::FundingSent as u32;
1423 self.cur_local_commitment_transaction_number -= 1;
1425 Ok(self.channel_monitor.clone())
1428 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1429 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1430 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1433 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1435 if non_shutdown_state == ChannelState::FundingSent as u32 {
1436 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1437 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1438 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1439 self.channel_update_count += 1;
1440 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1441 // Note that funding_signed/funding_created will have decremented both by 1!
1442 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1443 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1444 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1445 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1447 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1450 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1453 self.their_prev_commitment_point = self.their_cur_commitment_point;
1454 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1458 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1459 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1460 let mut htlc_inbound_value_msat = 0;
1461 for ref htlc in self.pending_inbound_htlcs.iter() {
1462 htlc_inbound_value_msat += htlc.amount_msat;
1464 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1467 /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1468 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1469 let mut htlc_outbound_value_msat = 0;
1470 for ref htlc in self.pending_outbound_htlcs.iter() {
1471 htlc_outbound_value_msat += htlc.amount_msat;
1474 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1477 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1478 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1479 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1481 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1482 return Err(HandleError{err: "Peer sent update_add_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_add_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1484 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1485 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1487 if msg.amount_msat < self.our_htlc_minimum_msat {
1488 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1491 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1492 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1493 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1495 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1496 // Check our_max_htlc_value_in_flight_msat
1497 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1498 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1500 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1501 // the reserve_satoshis we told them to always have as direct payment so that they lose
1502 // something if we punish them for broadcasting an old state).
1503 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 {
1504 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1506 if self.next_remote_htlc_id != msg.htlc_id {
1507 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1509 if msg.cltv_expiry >= 500000000 {
1510 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1513 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1515 // Now update local state:
1516 self.next_remote_htlc_id += 1;
1517 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1518 htlc_id: msg.htlc_id,
1519 amount_msat: msg.amount_msat,
1520 payment_hash: msg.payment_hash,
1521 cltv_expiry: msg.cltv_expiry,
1522 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1528 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1530 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1531 for htlc in self.pending_outbound_htlcs.iter_mut() {
1532 if htlc.htlc_id == htlc_id {
1533 match check_preimage {
1535 Some(payment_hash) =>
1536 if payment_hash != htlc.payment_hash {
1537 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1541 OutboundHTLCState::LocalAnnounced(_) =>
1542 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1543 OutboundHTLCState::Committed => {
1544 htlc.state = OutboundHTLCState::RemoteRemoved;
1545 htlc.fail_reason = fail_reason;
1547 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1548 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1550 return Ok(&htlc.source);
1553 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1556 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, ChannelError> {
1557 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1558 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1560 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1561 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1564 let mut sha = Sha256::new();
1565 sha.input(&msg.payment_preimage);
1566 let mut payment_hash = [0; 32];
1567 sha.result(&mut payment_hash);
1569 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1572 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1573 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1574 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1576 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1577 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1580 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1583 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1584 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1585 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1587 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1588 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1591 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1594 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1595 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1596 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1598 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1599 return Err(HandleError{err: "Peer sent commitment_signed when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent commitment_signed when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1602 let funding_script = self.get_funding_redeemscript();
1604 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1606 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1607 self.pending_update_fee.unwrap()
1612 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1613 let local_commitment_txid = local_commitment_tx.0.txid();
1614 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1615 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1617 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1618 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1621 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1622 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1623 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1625 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1626 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1627 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
1628 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1629 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1630 secp_call!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx siganture from peer", self.channel_id());
1631 let htlc_sig = if htlc.offered {
1632 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1633 new_local_commitment_txn.push(htlc_tx);
1636 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1638 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1641 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1642 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1644 // Update state now that we've passed all the can-fail calls...
1645 let mut need_our_commitment = false;
1646 if !self.channel_outbound {
1647 if let Some(fee_update) = self.pending_update_fee {
1648 self.feerate_per_kw = fee_update;
1649 // We later use the presence of pending_update_fee to indicate we should generate a
1650 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1651 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1652 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1653 need_our_commitment = true;
1654 self.pending_update_fee = None;
1658 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1659 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1660 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1661 self.monitor_pending_order = None;
1664 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1666 for htlc in self.pending_inbound_htlcs.iter_mut() {
1667 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1668 Some(forward_info.clone())
1670 if let Some(forward_info) = new_forward {
1671 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1672 need_our_commitment = true;
1675 for htlc in self.pending_outbound_htlcs.iter_mut() {
1676 if let OutboundHTLCState::RemoteRemoved = htlc.state {
1677 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1678 need_our_commitment = true;
1682 self.cur_local_commitment_transaction_number -= 1;
1683 self.last_local_commitment_txn = new_local_commitment_txn;
1684 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1686 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1687 self.monitor_pending_revoke_and_ack = true;
1688 self.monitor_pending_commitment_signed |= need_our_commitment;
1689 return Err(HandleError{err: "Previous monitor update failure prevented generation of RAA", action: Some(ErrorAction::IgnoreError)});
1692 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1693 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1694 // we'll send one right away when we get the revoke_and_ack when we
1695 // free_holding_cell_htlcs().
1696 let (msg, monitor) = self.send_commitment_no_status_check()?;
1697 (Some(msg), monitor)
1698 } else { (None, self.channel_monitor.clone()) };
1700 Ok((msgs::RevokeAndACK {
1701 channel_id: self.channel_id,
1702 per_commitment_secret: per_commitment_secret,
1703 next_per_commitment_point: next_per_commitment_point,
1704 }, our_commitment_signed, monitor_update))
1707 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1708 /// fulfilling or failing the last pending HTLC)
1709 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1710 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1711 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1712 let mut htlc_updates = Vec::new();
1713 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1714 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1715 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1716 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1718 for htlc_update in htlc_updates.drain(..) {
1719 // Note that this *can* fail, though it should be due to rather-rare conditions on
1720 // fee races with adding too many outputs which push our total payments just over
1721 // the limit. In case its less rare than I anticipate, we may want to revisit
1722 // handling this case better and maybe fufilling some of the HTLCs while attempting
1723 // to rebalance channels.
1724 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1725 self.holding_cell_htlc_updates.push(htlc_update);
1727 match &htlc_update {
1728 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1729 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1730 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1736 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1737 match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1738 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1740 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1742 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1747 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1748 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1749 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1751 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1753 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1760 self.holding_cell_htlc_updates.push(htlc_update);
1764 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1765 //fail it back the route, if its a temporary issue we can ignore it...
1768 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1769 // This should never actually happen and indicates we got some Errs back
1770 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1771 // case there is some strange way to hit duplicate HTLC removes.
1774 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1775 self.pending_update_fee = self.holding_cell_update_fee.take();
1776 Some(msgs::UpdateFee {
1777 channel_id: self.channel_id,
1778 feerate_per_kw: feerate as u32,
1783 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1784 Ok(Some((msgs::CommitmentUpdate {
1786 update_fulfill_htlcs,
1788 update_fail_malformed_htlcs: Vec::new(),
1789 update_fee: update_fee,
1791 }, monitor_update)))
1800 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1801 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1802 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1803 /// generating an appropriate error *after* the channel state has been updated based on the
1804 /// revoke_and_ack message.
1805 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1806 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1807 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1809 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1810 return Err(HandleError{err: "Peer sent revoke_and_ack when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent revoke_and_ack when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1813 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1814 if PublicKey::from_secret_key(&self.secp_ctx, &secp_call!(SecretKey::from_slice(&self.secp_ctx, &msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret", self.channel_id())) != their_prev_commitment_point {
1815 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1818 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret, Some((self.cur_remote_commitment_transaction_number - 1, msg.next_per_commitment_point)))?;
1820 // Update state now that we've passed all the can-fail calls...
1821 // (note that we may still fail to generate the new commitment_signed message, but that's
1822 // OK, we step the channel here and *then* if the new generation fails we can fail the
1823 // channel based on that, but stepping stuff here should be safe either way.
1824 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1825 self.their_prev_commitment_point = self.their_cur_commitment_point;
1826 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1827 self.cur_remote_commitment_transaction_number -= 1;
1828 self.received_commitment_while_awaiting_raa = false;
1829 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1830 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1831 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1832 self.monitor_pending_order = None;
1835 let mut to_forward_infos = Vec::new();
1836 let mut revoked_htlcs = Vec::new();
1837 let mut update_fail_htlcs = Vec::new();
1838 let mut update_fail_malformed_htlcs = Vec::new();
1839 let mut require_commitment = false;
1840 let mut value_to_self_msat_diff: i64 = 0;
1841 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1842 self.pending_inbound_htlcs.retain(|htlc| {
1843 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1844 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1845 value_to_self_msat_diff += htlc.amount_msat as i64;
1850 self.pending_outbound_htlcs.retain(|htlc| {
1851 if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1852 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1853 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1855 // They fulfilled, so we sent them money
1856 value_to_self_msat_diff -= htlc.amount_msat as i64;
1861 for htlc in self.pending_inbound_htlcs.iter_mut() {
1862 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1864 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1868 let mut state = InboundHTLCState::Committed;
1869 mem::swap(&mut state, &mut htlc.state);
1871 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1872 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1873 require_commitment = true;
1874 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1875 match forward_info {
1876 PendingHTLCStatus::Fail(fail_msg) => {
1877 require_commitment = true;
1879 HTLCFailureMsg::Relay(msg) => {
1880 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1881 update_fail_htlcs.push(msg)
1883 HTLCFailureMsg::Malformed(msg) => {
1884 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
1885 update_fail_malformed_htlcs.push(msg)
1889 PendingHTLCStatus::Forward(forward_info) => {
1890 to_forward_infos.push((forward_info, htlc.htlc_id));
1891 htlc.state = InboundHTLCState::Committed;
1897 for htlc in self.pending_outbound_htlcs.iter_mut() {
1898 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
1899 htlc.state = OutboundHTLCState::Committed;
1900 } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
1901 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1902 require_commitment = true;
1905 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1907 if self.channel_outbound {
1908 if let Some(feerate) = self.pending_update_fee.take() {
1909 self.feerate_per_kw = feerate;
1912 if let Some(feerate) = self.pending_update_fee {
1913 // Because a node cannot send two commitment_signed's in a row without getting a
1914 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
1915 // it should use to create keys with) and because a node can't send a
1916 // commitment_signed without changes, checking if the feerate is equal to the
1917 // pending feerate update is sufficient to detect require_commitment.
1918 if feerate == self.feerate_per_kw {
1919 require_commitment = true;
1920 self.pending_update_fee = None;
1925 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
1926 // We can't actually generate a new commitment transaction (incl by freeing holding
1927 // cells) while we can't update the monitor, so we just return what we have.
1928 if require_commitment {
1929 self.monitor_pending_commitment_signed = true;
1931 self.monitor_pending_forwards.append(&mut to_forward_infos);
1932 self.monitor_pending_failures.append(&mut revoked_htlcs);
1933 return Ok((None, Vec::new(), Vec::new(), self.channel_monitor.clone()));
1936 match self.free_holding_cell_htlcs()? {
1937 Some(mut commitment_update) => {
1938 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
1939 for fail_msg in update_fail_htlcs.drain(..) {
1940 commitment_update.0.update_fail_htlcs.push(fail_msg);
1942 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
1943 for fail_msg in update_fail_malformed_htlcs.drain(..) {
1944 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
1946 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
1949 if require_commitment {
1950 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1951 Ok((Some(msgs::CommitmentUpdate {
1952 update_add_htlcs: Vec::new(),
1953 update_fulfill_htlcs: Vec::new(),
1955 update_fail_malformed_htlcs,
1958 }), to_forward_infos, revoked_htlcs, monitor_update))
1960 Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
1967 /// Adds a pending update to this channel. See the doc for send_htlc for
1968 /// further details on the optionness of the return value.
1969 /// You MUST call send_commitment prior to any other calls on this Channel
1970 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
1971 if !self.channel_outbound {
1972 panic!("Cannot send fee from inbound channel");
1974 if !self.is_usable() {
1975 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
1977 if !self.is_live() {
1978 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
1981 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
1982 self.holding_cell_update_fee = Some(feerate_per_kw);
1986 debug_assert!(self.pending_update_fee.is_none());
1987 self.pending_update_fee = Some(feerate_per_kw);
1989 Some(msgs::UpdateFee {
1990 channel_id: self.channel_id,
1991 feerate_per_kw: feerate_per_kw as u32,
1995 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
1996 match self.send_update_fee(feerate_per_kw) {
1997 Some(update_fee) => {
1998 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1999 Ok(Some((update_fee, commitment_signed, monitor_update)))
2005 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2006 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2007 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2008 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2009 /// No further message handling calls may be made until a channel_reestablish dance has
2011 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
2012 let mut outbound_drops = Vec::new();
2014 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2015 if self.channel_state < ChannelState::FundingSent as u32 {
2016 self.channel_state = ChannelState::ShutdownComplete as u32;
2017 return outbound_drops;
2020 let mut inbound_drop_count = 0;
2021 self.pending_inbound_htlcs.retain(|htlc| {
2023 InboundHTLCState::RemoteAnnounced(_) => {
2024 // They sent us an update_add_htlc but we never got the commitment_signed.
2025 // We'll tell them what commitment_signed we're expecting next and they'll drop
2026 // this HTLC accordingly
2027 inbound_drop_count += 1;
2030 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2031 // We received a commitment_signed updating this HTLC and (at least hopefully)
2032 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2033 // in response to it yet, so don't touch it.
2036 InboundHTLCState::Committed => true,
2037 InboundHTLCState::LocalRemoved(_) => {
2038 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2039 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2040 // (that we missed). Keep this around for now and if they tell us they missed
2041 // the commitment_signed we can re-transmit the update then.
2046 self.next_remote_htlc_id -= inbound_drop_count;
2048 for htlc in self.pending_outbound_htlcs.iter_mut() {
2049 if let OutboundHTLCState::RemoteRemoved = htlc.state {
2050 // They sent us an update to remove this but haven't yet sent the corresponding
2051 // commitment_signed, we need to move it back to Committed and they can re-send
2052 // the update upon reconnection.
2053 htlc.state = OutboundHTLCState::Committed;
2057 self.holding_cell_htlc_updates.retain(|htlc_update| {
2059 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2060 outbound_drops.push((source.clone(), payment_hash.clone()));
2063 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2066 self.channel_state |= ChannelState::PeerDisconnected as u32;
2067 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()));
2071 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2072 /// updates are partially paused.
2073 /// This must be called immediately after the call which generated the ChannelMonitor update
2074 /// which failed, with the order argument set to the type of call it represented (ie a
2075 /// commitment update or a revoke_and_ack generation). The messages which were generated from
2076 /// that original call must *not* have been sent to the remote end, and must instead have been
2077 /// dropped. They will be regenerated when monitor_updating_restored is called.
2078 pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder) {
2079 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2081 RAACommitmentOrder::CommitmentFirst => {
2082 self.monitor_pending_revoke_and_ack = false;
2083 self.monitor_pending_commitment_signed = true;
2085 RAACommitmentOrder::RevokeAndACKFirst => {
2086 self.monitor_pending_revoke_and_ack = true;
2087 self.monitor_pending_commitment_signed = false;
2090 self.monitor_pending_order = Some(order);
2091 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2094 /// Indicates that the latest ChannelMonitor update has been committed by the client
2095 /// successfully and we should restore normal operation. Returns messages which should be sent
2096 /// to the remote side.
2097 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>) {
2098 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2099 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2101 let mut forwards = Vec::new();
2102 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2103 let mut failures = Vec::new();
2104 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2106 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2107 // Leave monitor_pending_order so we can order our channel_reestablish responses
2108 self.monitor_pending_revoke_and_ack = false;
2109 self.monitor_pending_commitment_signed = false;
2110 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2113 let raa = if self.monitor_pending_revoke_and_ack {
2114 Some(self.get_last_revoke_and_ack())
2116 let commitment_update = if self.monitor_pending_commitment_signed {
2117 Some(self.get_last_commitment_update())
2120 self.monitor_pending_revoke_and_ack = false;
2121 self.monitor_pending_commitment_signed = false;
2122 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2125 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2126 if self.channel_outbound {
2127 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2129 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2130 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2132 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2134 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2135 self.channel_update_count += 1;
2139 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2140 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2141 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2142 msgs::RevokeAndACK {
2143 channel_id: self.channel_id,
2144 per_commitment_secret,
2145 next_per_commitment_point,
2149 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2150 let mut update_add_htlcs = Vec::new();
2151 let mut update_fulfill_htlcs = Vec::new();
2152 let mut update_fail_htlcs = Vec::new();
2153 let mut update_fail_malformed_htlcs = Vec::new();
2155 for htlc in self.pending_outbound_htlcs.iter() {
2156 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2157 update_add_htlcs.push(msgs::UpdateAddHTLC {
2158 channel_id: self.channel_id(),
2159 htlc_id: htlc.htlc_id,
2160 amount_msat: htlc.amount_msat,
2161 payment_hash: htlc.payment_hash,
2162 cltv_expiry: htlc.cltv_expiry,
2163 onion_routing_packet: (**onion_packet).clone(),
2168 for htlc in self.pending_inbound_htlcs.iter() {
2169 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2171 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2172 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2173 channel_id: self.channel_id(),
2174 htlc_id: htlc.htlc_id,
2175 reason: err_packet.clone()
2178 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2179 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2180 channel_id: self.channel_id(),
2181 htlc_id: htlc.htlc_id,
2182 sha256_of_onion: sha256_of_onion.clone(),
2183 failure_code: failure_code.clone(),
2186 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2187 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2188 channel_id: self.channel_id(),
2189 htlc_id: htlc.htlc_id,
2190 payment_preimage: payment_preimage.clone(),
2197 msgs::CommitmentUpdate {
2198 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2199 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2200 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,
2204 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2205 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2206 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder), ChannelError> {
2207 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2208 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2209 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2210 // just close here instead of trying to recover.
2211 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2214 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
2215 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2218 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2219 // remaining cases either succeed or ErrorMessage-fail).
2220 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2222 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) == ChannelState::FundingSent as u32 {
2223 // Short circuit the whole handler as there is nothing we can resend them
2224 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst));
2227 if msg.next_local_commitment_number == 0 || msg.next_remote_commitment_number == 0 {
2228 if self.channel_state & (ChannelState::FundingSent as u32) != ChannelState::FundingSent as u32 {
2229 return Err(ChannelError::Close("Peer sent a pre-funding channel_reestablish after we exchanged funding_locked"));
2231 // We have OurFundingLocked set!
2232 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2233 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2234 return Ok((Some(msgs::FundingLocked {
2235 channel_id: self.channel_id(),
2236 next_per_commitment_point: next_per_commitment_point,
2237 }), None, None, None, RAACommitmentOrder::CommitmentFirst));
2240 let required_revoke = if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2241 // Remote isn't waiting on any RevokeAndACK from us!
2242 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2244 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2245 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2246 self.monitor_pending_revoke_and_ack = true;
2249 Some(self.get_last_revoke_and_ack())
2252 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2255 // We increment cur_remote_commitment_transaction_number only upon receipt of
2256 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2257 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2258 // the corresponding revoke_and_ack back yet.
2259 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 };
2261 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2262 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2263 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2264 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2265 Some(msgs::FundingLocked {
2266 channel_id: self.channel_id(),
2267 next_per_commitment_point: next_per_commitment_point,
2271 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2272 RAACommitmentOrder::CommitmentFirst
2274 RAACommitmentOrder::RevokeAndACKFirst
2277 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2278 if required_revoke.is_some() {
2279 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2281 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2284 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2285 self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2286 // We're up-to-date and not waiting on a remote revoke (if we are our
2287 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2288 // have received some updates while we were disconnected. Free the holding cell
2290 match self.free_holding_cell_htlcs() {
2292 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
2293 return Err(ChannelError::Close(e.err));
2294 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
2295 return Err(ChannelError::Close(e.err));
2297 panic!("Got non-channel-failing result from free_holding_cell_htlcs");
2300 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order)),
2301 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order)),
2304 return Ok((resend_funding_locked, required_revoke, None, None, order));
2306 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2307 if required_revoke.is_some() {
2308 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2310 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2313 // If monitor_pending_order is set, it must be CommitmentSigned if we have no RAA
2314 debug_assert!(self.monitor_pending_order != Some(RAACommitmentOrder::RevokeAndACKFirst) || required_revoke.is_some());
2316 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2317 self.monitor_pending_commitment_signed = true;
2318 return Ok((resend_funding_locked, None, None, None, order));
2321 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order));
2323 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2327 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), HandleError> {
2328 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2329 return Err(HandleError{err: "Peer sent shutdown when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent shutdown when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
2331 if self.channel_state < ChannelState::FundingSent as u32 {
2332 self.channel_state = ChannelState::ShutdownComplete as u32;
2333 self.channel_update_count += 1;
2334 return Ok((None, None, Vec::new()));
2336 for htlc in self.pending_inbound_htlcs.iter() {
2337 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2338 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
2341 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
2342 return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
2344 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2346 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2347 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2348 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2349 return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
2352 //Check shutdown_scriptpubkey form as BOLT says we must
2353 if !(msg.scriptpubkey.is_p2pkh()) && !(msg.scriptpubkey.is_p2sh())
2354 && !(msg.scriptpubkey.is_v0_p2wpkh()) && !(msg.scriptpubkey.is_v0_p2wsh()){
2355 return Err(HandleError{err: "Got an invalid scriptpubkey from remote peer", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
2358 if self.their_shutdown_scriptpubkey.is_some() {
2359 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2360 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
2363 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2366 let our_closing_script = self.get_closing_scriptpubkey();
2368 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() {
2369 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2370 if self.feerate_per_kw > proposed_feerate {
2371 proposed_feerate = self.feerate_per_kw;
2373 let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
2374 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2376 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2377 let funding_redeemscript = self.get_funding_redeemscript();
2378 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2380 (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key)))
2381 } else { (None, None, None) };
2383 // From here on out, we may not fail!
2385 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2386 self.channel_update_count += 1;
2388 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2389 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2390 // cell HTLCs and return them to fail the payment.
2391 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2392 self.holding_cell_htlc_updates.retain(|htlc_update| {
2394 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2395 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2401 for htlc in self.pending_outbound_htlcs.iter() {
2402 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2403 return Ok((None, None, dropped_outbound_htlcs));
2407 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2410 Some(msgs::Shutdown {
2411 channel_id: self.channel_id,
2412 scriptpubkey: our_closing_script,
2416 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2417 self.channel_update_count += 1;
2418 if self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() && self.channel_outbound {
2419 // There are no more HTLCs and we're the funder, this means we start the closing_signed
2420 // dance with an initial fee proposal!
2421 self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
2422 Ok((our_shutdown, Some(msgs::ClosingSigned {
2423 channel_id: self.channel_id,
2424 fee_satoshis: proposed_fee.unwrap(),
2425 signature: our_sig.unwrap(),
2426 }), dropped_outbound_htlcs))
2428 Ok((our_shutdown, None, dropped_outbound_htlcs))
2432 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2433 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2434 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2436 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2437 return Err(HandleError{err: "Peer sent closing_signed when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent closing_signed when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
2439 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2440 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2442 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2443 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2446 let funding_redeemscript = self.get_funding_redeemscript();
2447 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2448 if used_total_fee != msg.fee_satoshis {
2449 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2451 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2453 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2456 // The remote end may have decided to revoke their output due to inconsistent dust
2457 // limits, so check for that case by re-checking the signature here.
2458 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2459 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2460 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2464 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2465 if last_fee == msg.fee_satoshis {
2466 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2467 self.channel_state = ChannelState::ShutdownComplete as u32;
2468 self.channel_update_count += 1;
2469 return Ok((None, Some(closing_tx)));
2473 macro_rules! propose_new_feerate {
2474 ($new_feerate: expr) => {
2475 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2476 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2477 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2478 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2479 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2480 return Ok((Some(msgs::ClosingSigned {
2481 channel_id: self.channel_id,
2482 fee_satoshis: used_total_fee,
2488 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2489 if self.channel_outbound {
2490 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2491 if proposed_sat_per_kw > our_max_feerate {
2492 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2493 if our_max_feerate <= last_feerate {
2494 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2497 propose_new_feerate!(our_max_feerate);
2500 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2501 if proposed_sat_per_kw < our_min_feerate {
2502 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2503 if our_min_feerate >= last_feerate {
2504 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2507 propose_new_feerate!(our_min_feerate);
2511 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2512 self.channel_state = ChannelState::ShutdownComplete as u32;
2513 self.channel_update_count += 1;
2515 Ok((Some(msgs::ClosingSigned {
2516 channel_id: self.channel_id,
2517 fee_satoshis: msg.fee_satoshis,
2519 }), Some(closing_tx)))
2522 // Public utilities:
2524 pub fn channel_id(&self) -> [u8; 32] {
2528 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2529 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2530 pub fn get_user_id(&self) -> u64 {
2534 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2535 pub fn channel_monitor(&self) -> ChannelMonitor {
2536 if self.channel_state < ChannelState::FundingCreated as u32 {
2537 panic!("Can't get a channel monitor until funding has been created");
2539 self.channel_monitor.clone()
2542 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2543 /// is_usable() returns true).
2544 /// Allowed in any state (including after shutdown)
2545 pub fn get_short_channel_id(&self) -> Option<u64> {
2546 self.short_channel_id
2549 /// Returns the funding_txo we either got from our peer, or were given by
2550 /// get_outbound_funding_created.
2551 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2552 self.channel_monitor.get_funding_txo()
2555 /// Allowed in any state (including after shutdown)
2556 pub fn get_their_node_id(&self) -> PublicKey {
2560 /// Allowed in any state (including after shutdown)
2561 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2562 self.our_htlc_minimum_msat
2565 /// Allowed in any state (including after shutdown)
2566 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2567 self.our_htlc_minimum_msat
2570 pub fn get_value_satoshis(&self) -> u64 {
2571 self.channel_value_satoshis
2575 pub fn get_feerate(&self) -> u64 {
2579 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2580 self.cur_local_commitment_transaction_number + 1
2583 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2584 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2587 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2588 self.cur_remote_commitment_transaction_number + 2
2591 //TODO: Testing purpose only, should be changed in another way after #81
2593 pub fn get_local_keys(&self) -> &ChannelKeys {
2598 pub fn get_value_stat(&self) -> ChannelValueStat {
2600 value_to_self_msat: self.value_to_self_msat,
2601 channel_value_msat: self.channel_value_satoshis * 1000,
2602 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2603 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2604 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2605 holding_cell_outbound_amount_msat: {
2607 for h in self.holding_cell_htlc_updates.iter() {
2609 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2617 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2621 /// Allowed in any state (including after shutdown)
2622 pub fn get_channel_update_count(&self) -> u32 {
2623 self.channel_update_count
2626 pub fn should_announce(&self) -> bool {
2627 self.announce_publicly
2630 pub fn is_outbound(&self) -> bool {
2631 self.channel_outbound
2634 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2635 /// Allowed in any state (including after shutdown)
2636 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2637 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2638 // output value back into a transaction with the regular channel output:
2640 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2641 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2643 if self.channel_outbound {
2644 // + the marginal fee increase cost to us in the commitment transaction:
2645 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2648 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2649 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2654 /// Returns true if we've ever received a message from the remote end for this Channel
2655 pub fn have_received_message(&self) -> bool {
2656 self.channel_state > (ChannelState::OurInitSent as u32)
2659 /// Returns true if this channel is fully established and not known to be closing.
2660 /// Allowed in any state (including after shutdown)
2661 pub fn is_usable(&self) -> bool {
2662 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2663 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2666 /// Returns true if this channel is currently available for use. This is a superset of
2667 /// is_usable() and considers things like the channel being temporarily disabled.
2668 /// Allowed in any state (including after shutdown)
2669 pub fn is_live(&self) -> bool {
2670 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2673 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2674 /// Allowed in any state (including after shutdown)
2675 pub fn is_awaiting_monitor_update(&self) -> bool {
2676 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2679 /// Returns true if funding_created was sent/received.
2680 pub fn is_funding_initiated(&self) -> bool {
2681 self.channel_state >= ChannelState::FundingCreated as u32
2684 /// Returns true if this channel is fully shut down. True here implies that no further actions
2685 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2686 /// will be handled appropriately by the chain monitor.
2687 pub fn is_shutdown(&self) -> bool {
2688 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2689 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2694 /// Called by channelmanager based on chain blocks being connected.
2695 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2696 /// the channel_monitor.
2697 /// In case of Err, the channel may have been closed, at which point the standard requirements
2698 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2699 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2700 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2701 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2702 if header.bitcoin_hash() != self.last_block_connected {
2703 self.last_block_connected = header.bitcoin_hash();
2704 self.channel_monitor.last_block_hash = self.last_block_connected;
2705 if self.funding_tx_confirmations > 0 {
2706 self.funding_tx_confirmations += 1;
2707 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2708 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2709 self.channel_state |= ChannelState::OurFundingLocked as u32;
2711 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2712 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2713 self.channel_update_count += 1;
2715 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2716 // We got a reorg but not enough to trigger a force close, just update
2717 // funding_tx_confirmed_in and return.
2719 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2720 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2722 // We got a reorg but not enough to trigger a force close, just update
2723 // funding_tx_confirmed_in and return.
2726 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2728 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2729 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2730 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2731 //a protocol oversight, but I assume I'm just missing something.
2732 if need_commitment_update {
2733 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2734 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2735 return Ok(Some(msgs::FundingLocked {
2736 channel_id: self.channel_id,
2737 next_per_commitment_point: next_per_commitment_point,
2743 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2744 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2745 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2746 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2747 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2748 tx.output[txo_idx].value != self.channel_value_satoshis {
2749 if self.channel_outbound {
2750 // If we generated the funding transaction and it doesn't match what it
2751 // should, the client is really broken and we should just panic and
2752 // tell them off. That said, because hash collisions happen with high
2753 // probability in fuzztarget mode, if we're fuzzing we just close the
2754 // channel and move on.
2755 #[cfg(not(feature = "fuzztarget"))]
2756 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2758 self.channel_state = ChannelState::ShutdownComplete as u32;
2759 self.channel_update_count += 1;
2760 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2762 self.funding_tx_confirmations = 1;
2763 self.short_channel_id = Some(((height as u64) << (5*8)) |
2764 ((*index_in_block as u64) << (2*8)) |
2765 ((txo_idx as u64) << (0*8)));
2773 /// Called by channelmanager based on chain blocks being disconnected.
2774 /// Returns true if we need to close the channel now due to funding transaction
2775 /// unconfirmation/reorg.
2776 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2777 if self.funding_tx_confirmations > 0 {
2778 self.funding_tx_confirmations -= 1;
2779 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2783 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2784 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2786 self.last_block_connected = header.bitcoin_hash();
2787 self.channel_monitor.last_block_hash = self.last_block_connected;
2791 // Methods to get unprompted messages to send to the remote end (or where we already returned
2792 // something in the handler for the message that prompted this message):
2794 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2795 if !self.channel_outbound {
2796 panic!("Tried to open a channel for an inbound channel?");
2798 if self.channel_state != ChannelState::OurInitSent as u32 {
2799 panic!("Cannot generate an open_channel after we've moved forward");
2802 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2803 panic!("Tried to send an open_channel for a channel that has already advanced");
2806 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2809 chain_hash: chain_hash,
2810 temporary_channel_id: self.channel_id,
2811 funding_satoshis: self.channel_value_satoshis,
2812 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2813 dust_limit_satoshis: self.our_dust_limit_satoshis,
2814 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2815 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2816 htlc_minimum_msat: self.our_htlc_minimum_msat,
2817 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2818 to_self_delay: BREAKDOWN_TIMEOUT,
2819 max_accepted_htlcs: OUR_MAX_HTLCS,
2820 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2821 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2822 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2823 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2824 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2825 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2826 channel_flags: if self.announce_publicly {1} else {0},
2827 shutdown_scriptpubkey: None,
2831 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2832 if self.channel_outbound {
2833 panic!("Tried to send accept_channel for an outbound channel?");
2835 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2836 panic!("Tried to send accept_channel after channel had moved forward");
2838 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2839 panic!("Tried to send an accept_channel for a channel that has already advanced");
2842 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2844 msgs::AcceptChannel {
2845 temporary_channel_id: self.channel_id,
2846 dust_limit_satoshis: self.our_dust_limit_satoshis,
2847 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2848 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2849 htlc_minimum_msat: self.our_htlc_minimum_msat,
2850 minimum_depth: self.minimum_depth,
2851 to_self_delay: BREAKDOWN_TIMEOUT,
2852 max_accepted_htlcs: OUR_MAX_HTLCS,
2853 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2854 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2855 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2856 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2857 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2858 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2859 shutdown_scriptpubkey: None,
2863 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2864 let funding_script = self.get_funding_redeemscript();
2866 let remote_keys = self.build_remote_transaction_keys()?;
2867 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
2868 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
2870 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2871 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2874 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2875 /// a funding_created message for the remote peer.
2876 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2877 /// or if called on an inbound channel.
2878 /// Note that channel_id changes during this call!
2879 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2880 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2881 if !self.channel_outbound {
2882 panic!("Tried to create outbound funding_created message on an inbound channel!");
2884 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2885 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)");
2887 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2888 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2889 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2890 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2893 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2894 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2896 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2899 log_error!(self, "Got bad signatures: {}!", e.err);
2900 self.channel_monitor.unset_funding_info();
2905 let temporary_channel_id = self.channel_id;
2907 // Now that we're past error-generating stuff, update our local state:
2908 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2909 self.channel_state = ChannelState::FundingCreated as u32;
2910 self.channel_id = funding_txo.to_channel_id();
2911 self.cur_remote_commitment_transaction_number -= 1;
2913 Ok((msgs::FundingCreated {
2914 temporary_channel_id: temporary_channel_id,
2915 funding_txid: funding_txo.txid,
2916 funding_output_index: funding_txo.index,
2917 signature: our_signature
2918 }, self.channel_monitor.clone()))
2921 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2922 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2923 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
2924 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2925 /// Will only fail if we're not in a state where channel_announcement may be sent (including
2927 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
2928 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
2929 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
2930 if !self.announce_publicly {
2931 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
2933 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
2934 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
2936 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
2937 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
2940 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2941 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
2943 let msg = msgs::UnsignedChannelAnnouncement {
2944 features: msgs::GlobalFeatures::new(),
2945 chain_hash: chain_hash,
2946 short_channel_id: self.get_short_channel_id().unwrap(),
2947 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2948 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2949 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
2950 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
2951 excess_data: Vec::new(),
2954 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2955 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
2960 /// May panic if called on a channel that wasn't immediately-previously
2961 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
2962 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
2963 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
2964 msgs::ChannelReestablish {
2965 channel_id: self.channel_id(),
2966 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
2967 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number -
2968 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) == (ChannelState::FundingSent as u32) { 1 } else { 0 },
2969 data_loss_protect: None,
2974 // Send stuff to our remote peers:
2976 /// Adds a pending outbound HTLC to this channel, note that you probably want
2977 /// send_htlc_and_commit instead cause you'll want both messages at once.
2978 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2979 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
2980 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
2981 /// You MUST call send_commitment prior to any other calls on this Channel
2982 pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, HandleError> {
2983 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
2984 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
2987 if amount_msat > self.channel_value_satoshis * 1000 {
2988 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
2990 if amount_msat < self.their_htlc_minimum_msat {
2991 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
2994 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
2995 // Note that this should never really happen, if we're !is_live() on receipt of an
2996 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
2997 // the user to send directly into a !is_live() channel. However, if we
2998 // disconnected during the time the previous hop was doing the commitment dance we may
2999 // end up getting here after the forwarding delay. In any case, returning an
3000 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3001 return Err(HandleError{err: "Cannot send an HTLC while disconnected/frozen for channel monitor update", action: Some(ErrorAction::IgnoreError)});
3004 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3005 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3006 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
3008 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3009 // Check their_max_htlc_value_in_flight_msat
3010 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3011 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
3014 let mut holding_cell_outbound_amount_msat = 0;
3015 for holding_htlc in self.holding_cell_htlc_updates.iter() {
3016 match holding_htlc {
3017 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
3018 holding_cell_outbound_amount_msat += *amount_msat;
3024 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3025 // reserve for them to have something to claim if we misbehave)
3026 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
3027 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
3030 //TODO: Check cltv_expiry? Do this in channel manager?
3032 // Now update local state:
3033 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3034 //TODO: Check the limits *including* other pending holding cell HTLCs!
3035 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3036 amount_msat: amount_msat,
3037 payment_hash: payment_hash,
3038 cltv_expiry: cltv_expiry,
3040 onion_routing_packet: onion_routing_packet,
3041 time_created: Instant::now(),
3046 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3047 htlc_id: self.next_local_htlc_id,
3048 amount_msat: amount_msat,
3049 payment_hash: payment_hash.clone(),
3050 cltv_expiry: cltv_expiry,
3051 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3056 let res = msgs::UpdateAddHTLC {
3057 channel_id: self.channel_id,
3058 htlc_id: self.next_local_htlc_id,
3059 amount_msat: amount_msat,
3060 payment_hash: payment_hash,
3061 cltv_expiry: cltv_expiry,
3062 onion_routing_packet: onion_routing_packet,
3064 self.next_local_htlc_id += 1;
3069 /// Creates a signed commitment transaction to send to the remote peer.
3070 /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
3071 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3072 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3073 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3074 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3075 panic!("Cannot create commitment tx until channel is fully established");
3077 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3078 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3080 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3081 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3083 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3084 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");
3086 let mut have_updates = self.pending_update_fee.is_some();
3087 for htlc in self.pending_outbound_htlcs.iter() {
3088 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3089 have_updates = true;
3091 if have_updates { break; }
3094 panic!("Cannot create commitment tx until we have some updates to send");
3096 self.send_commitment_no_status_check()
3098 /// Only fails in case of bad keys
3099 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3100 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3101 // fail to generate this, we still are at least at a position where upgrading their status
3103 for htlc in self.pending_inbound_htlcs.iter_mut() {
3104 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3105 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3107 if let Some(state) = new_state {
3111 for htlc in self.pending_outbound_htlcs.iter_mut() {
3112 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
3113 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
3117 match self.send_commitment_no_state_update() {
3118 Ok((res, remote_commitment_tx)) => {
3119 // Update state now that we've passed all the can-fail calls...
3120 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
3121 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3122 Ok((res, self.channel_monitor.clone()))
3128 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3129 /// when we shouldn't change HTLC/channel state.
3130 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
3131 let funding_script = self.get_funding_redeemscript();
3133 let mut feerate_per_kw = self.feerate_per_kw;
3134 if let Some(feerate) = self.pending_update_fee {
3135 if self.channel_outbound {
3136 feerate_per_kw = feerate;
3140 let remote_keys = self.build_remote_transaction_keys()?;
3141 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3142 let remote_commitment_txid = remote_commitment_tx.0.txid();
3143 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
3144 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3146 let mut htlc_sigs = Vec::new();
3148 for ref htlc in remote_commitment_tx.1.iter() {
3149 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3150 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3151 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3152 let our_htlc_key = secp_derived_key!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), self.channel_id());
3153 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3156 Ok((msgs::CommitmentSigned {
3157 channel_id: self.channel_id,
3159 htlc_signatures: htlc_sigs,
3160 }, remote_commitment_tx))
3163 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3164 /// to send to the remote peer in one go.
3165 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3167 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
3168 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3169 Some(update_add_htlc) => {
3170 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3171 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3177 /// Begins the shutdown process, getting a message for the remote peer and returning all
3178 /// holding cell HTLCs for payment failure.
3179 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
3180 for htlc in self.pending_outbound_htlcs.iter() {
3181 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3182 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3185 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3186 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3187 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3189 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3190 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3193 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3194 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3195 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3198 let our_closing_script = self.get_closing_scriptpubkey();
3200 // From here on out, we may not fail!
3201 if self.channel_state < ChannelState::FundingSent as u32 {
3202 self.channel_state = ChannelState::ShutdownComplete as u32;
3204 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3206 self.channel_update_count += 1;
3208 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3209 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3210 // cell HTLCs and return them to fail the payment.
3211 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3212 self.holding_cell_htlc_updates.retain(|htlc_update| {
3214 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3215 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3222 Ok((msgs::Shutdown {
3223 channel_id: self.channel_id,
3224 scriptpubkey: our_closing_script,
3225 }, dropped_outbound_htlcs))
3228 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3229 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3230 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3231 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3232 /// immediately (others we will have to allow to time out).
3233 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
3234 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3236 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3237 // return them to fail the payment.
3238 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3239 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3241 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3242 dropped_outbound_htlcs.push((source, payment_hash));
3248 for _htlc in self.pending_outbound_htlcs.drain(..) {
3249 //TODO: Do something with the remaining HTLCs
3250 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3254 self.channel_state = ChannelState::ShutdownComplete as u32;
3255 self.channel_update_count += 1;
3256 let mut res = Vec::new();
3257 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3258 (res, dropped_outbound_htlcs)
3262 const SERIALIZATION_VERSION: u8 = 1;
3263 const MIN_SERIALIZATION_VERSION: u8 = 1;
3265 impl Writeable for InboundHTLCRemovalReason {
3266 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3268 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3270 error_packet.write(writer)?;
3272 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3274 onion_hash.write(writer)?;
3275 err_code.write(writer)?;
3277 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3279 payment_preimage.write(writer)?;
3286 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3287 fn read(reader: &mut R) -> Result<Self, DecodeError> {
3288 Ok(match <u8 as Readable<R>>::read(reader)? {
3289 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3290 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3291 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3292 _ => return Err(DecodeError::InvalidValue),
3297 impl Writeable for Channel {
3298 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3299 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3300 // called but include holding cell updates (and obviously we don't modify self).
3302 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3303 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3305 self.user_id.write(writer)?;
3307 self.channel_id.write(writer)?;
3308 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3309 self.channel_outbound.write(writer)?;
3310 self.announce_publicly.write(writer)?;
3311 self.channel_value_satoshis.write(writer)?;
3313 self.local_keys.write(writer)?;
3314 self.shutdown_pubkey.write(writer)?;
3316 self.cur_local_commitment_transaction_number.write(writer)?;
3317 self.cur_remote_commitment_transaction_number.write(writer)?;
3318 self.value_to_self_msat.write(writer)?;
3320 self.received_commitment_while_awaiting_raa.write(writer)?;
3322 let mut dropped_inbound_htlcs = 0;
3323 for htlc in self.pending_inbound_htlcs.iter() {
3324 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3325 dropped_inbound_htlcs += 1;
3328 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3329 for htlc in self.pending_inbound_htlcs.iter() {
3330 htlc.htlc_id.write(writer)?;
3331 htlc.amount_msat.write(writer)?;
3332 htlc.cltv_expiry.write(writer)?;
3333 htlc.payment_hash.write(writer)?;
3335 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3336 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3338 htlc_state.write(writer)?;
3340 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3342 htlc_state.write(writer)?;
3344 &InboundHTLCState::Committed => {
3347 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3349 removal_reason.write(writer)?;
3354 macro_rules! write_option {
3357 &None => 0u8.write(writer)?,
3366 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3367 for htlc in self.pending_outbound_htlcs.iter() {
3368 htlc.htlc_id.write(writer)?;
3369 htlc.amount_msat.write(writer)?;
3370 htlc.cltv_expiry.write(writer)?;
3371 htlc.payment_hash.write(writer)?;
3372 htlc.source.write(writer)?;
3373 write_option!(htlc.fail_reason);
3375 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3377 onion_packet.write(writer)?;
3379 &OutboundHTLCState::Committed => {
3382 &OutboundHTLCState::RemoteRemoved => {
3385 &OutboundHTLCState::AwaitingRemoteRevokeToRemove => {
3388 &OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
3394 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3395 for update in self.holding_cell_htlc_updates.iter() {
3397 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, time_created: _ } => {
3399 amount_msat.write(writer)?;
3400 cltv_expiry.write(writer)?;
3401 payment_hash.write(writer)?;
3402 source.write(writer)?;
3403 onion_routing_packet.write(writer)?;
3404 // time_created is not serialized - we re-init the timeout upon deserialization
3406 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3408 payment_preimage.write(writer)?;
3409 htlc_id.write(writer)?;
3411 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3413 htlc_id.write(writer)?;
3414 err_packet.write(writer)?;
3419 self.monitor_pending_revoke_and_ack.write(writer)?;
3420 self.monitor_pending_commitment_signed.write(writer)?;
3421 match self.monitor_pending_order {
3422 None => 0u8.write(writer)?,
3423 Some(RAACommitmentOrder::CommitmentFirst) => 1u8.write(writer)?,
3424 Some(RAACommitmentOrder::RevokeAndACKFirst) => 2u8.write(writer)?,
3427 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3428 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3429 pending_forward.write(writer)?;
3430 htlc_id.write(writer)?;
3433 (self.monitor_pending_failures.len() as u64).write(writer)?;
3434 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3435 htlc_source.write(writer)?;
3436 payment_hash.write(writer)?;
3437 fail_reason.write(writer)?;
3440 write_option!(self.pending_update_fee);
3441 write_option!(self.holding_cell_update_fee);
3443 self.next_local_htlc_id.write(writer)?;
3444 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3445 self.channel_update_count.write(writer)?;
3446 self.feerate_per_kw.write(writer)?;
3448 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3449 for tx in self.last_local_commitment_txn.iter() {
3450 if let Err(e) = tx.consensus_encode(&mut RawEncoder::new(WriterWriteAdaptor(writer))) {
3452 network::serialize::Error::Io(e) => return Err(e),
3453 _ => panic!("last_local_commitment_txn must have been well-formed!"),
3458 match self.last_sent_closing_fee {
3459 Some((feerate, fee)) => {
3461 feerate.write(writer)?;
3464 None => 0u8.write(writer)?,
3467 write_option!(self.funding_tx_confirmed_in);
3468 write_option!(self.short_channel_id);
3470 self.last_block_connected.write(writer)?;
3471 self.funding_tx_confirmations.write(writer)?;
3473 self.their_dust_limit_satoshis.write(writer)?;
3474 self.our_dust_limit_satoshis.write(writer)?;
3475 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3476 self.their_channel_reserve_satoshis.write(writer)?;
3477 self.their_htlc_minimum_msat.write(writer)?;
3478 self.our_htlc_minimum_msat.write(writer)?;
3479 self.their_to_self_delay.write(writer)?;
3480 self.their_max_accepted_htlcs.write(writer)?;
3481 self.minimum_depth.write(writer)?;
3483 write_option!(self.their_funding_pubkey);
3484 write_option!(self.their_revocation_basepoint);
3485 write_option!(self.their_payment_basepoint);
3486 write_option!(self.their_delayed_payment_basepoint);
3487 write_option!(self.their_htlc_basepoint);
3488 write_option!(self.their_cur_commitment_point);
3490 write_option!(self.their_prev_commitment_point);
3491 self.their_node_id.write(writer)?;
3493 write_option!(self.their_shutdown_scriptpubkey);
3495 self.channel_monitor.write_for_disk(writer)?;
3500 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3501 fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3502 let _ver: u8 = Readable::read(reader)?;
3503 let min_ver: u8 = Readable::read(reader)?;
3504 if min_ver > SERIALIZATION_VERSION {
3505 return Err(DecodeError::UnknownVersion);
3508 let user_id = Readable::read(reader)?;
3510 let channel_id = Readable::read(reader)?;
3511 let channel_state = Readable::read(reader)?;
3512 let channel_outbound = Readable::read(reader)?;
3513 let announce_publicly = Readable::read(reader)?;
3514 let channel_value_satoshis = Readable::read(reader)?;
3516 let local_keys = Readable::read(reader)?;
3517 let shutdown_pubkey = Readable::read(reader)?;
3519 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3520 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3521 let value_to_self_msat = Readable::read(reader)?;
3523 let received_commitment_while_awaiting_raa = Readable::read(reader)?;
3525 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3526 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3527 for _ in 0..pending_inbound_htlc_count {
3528 pending_inbound_htlcs.push(InboundHTLCOutput {
3529 htlc_id: Readable::read(reader)?,
3530 amount_msat: Readable::read(reader)?,
3531 cltv_expiry: Readable::read(reader)?,
3532 payment_hash: Readable::read(reader)?,
3533 state: match <u8 as Readable<R>>::read(reader)? {
3534 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3535 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3536 3 => InboundHTLCState::Committed,
3537 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3538 _ => return Err(DecodeError::InvalidValue),
3543 macro_rules! read_option { () => {
3544 match <u8 as Readable<R>>::read(reader)? {
3546 1 => Some(Readable::read(reader)?),
3547 _ => return Err(DecodeError::InvalidValue),
3551 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3552 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3553 for _ in 0..pending_outbound_htlc_count {
3554 pending_outbound_htlcs.push(OutboundHTLCOutput {
3555 htlc_id: Readable::read(reader)?,
3556 amount_msat: Readable::read(reader)?,
3557 cltv_expiry: Readable::read(reader)?,
3558 payment_hash: Readable::read(reader)?,
3559 source: Readable::read(reader)?,
3560 fail_reason: read_option!(),
3561 state: match <u8 as Readable<R>>::read(reader)? {
3562 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3563 1 => OutboundHTLCState::Committed,
3564 2 => OutboundHTLCState::RemoteRemoved,
3565 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove,
3566 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke,
3567 _ => return Err(DecodeError::InvalidValue),
3572 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3573 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3574 for _ in 0..holding_cell_htlc_update_count {
3575 holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3576 0 => HTLCUpdateAwaitingACK::AddHTLC {
3577 amount_msat: Readable::read(reader)?,
3578 cltv_expiry: Readable::read(reader)?,
3579 payment_hash: Readable::read(reader)?,
3580 source: Readable::read(reader)?,
3581 onion_routing_packet: Readable::read(reader)?,
3582 time_created: Instant::now(),
3584 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3585 payment_preimage: Readable::read(reader)?,
3586 htlc_id: Readable::read(reader)?,
3588 2 => HTLCUpdateAwaitingACK::FailHTLC {
3589 htlc_id: Readable::read(reader)?,
3590 err_packet: Readable::read(reader)?,
3592 _ => return Err(DecodeError::InvalidValue),
3596 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3597 let monitor_pending_commitment_signed = Readable::read(reader)?;
3599 let monitor_pending_order = match <u8 as Readable<R>>::read(reader)? {
3601 1 => Some(RAACommitmentOrder::CommitmentFirst),
3602 2 => Some(RAACommitmentOrder::RevokeAndACKFirst),
3603 _ => return Err(DecodeError::InvalidValue),
3606 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3607 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3608 for _ in 0..monitor_pending_forwards_count {
3609 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3612 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3613 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3614 for _ in 0..monitor_pending_failures_count {
3615 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3618 let pending_update_fee = read_option!();
3619 let holding_cell_update_fee = read_option!();
3621 let next_local_htlc_id = Readable::read(reader)?;
3622 let next_remote_htlc_id = Readable::read(reader)?;
3623 let channel_update_count = Readable::read(reader)?;
3624 let feerate_per_kw = Readable::read(reader)?;
3626 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3627 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3628 for _ in 0..last_local_commitment_txn_count {
3629 last_local_commitment_txn.push(match Transaction::consensus_decode(&mut RawDecoder::new(reader.by_ref())) {
3631 Err(_) => return Err(DecodeError::InvalidValue),
3635 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3637 1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3638 _ => return Err(DecodeError::InvalidValue),
3641 let funding_tx_confirmed_in = read_option!();
3642 let short_channel_id = read_option!();
3644 let last_block_connected = Readable::read(reader)?;
3645 let funding_tx_confirmations = Readable::read(reader)?;
3647 let their_dust_limit_satoshis = Readable::read(reader)?;
3648 let our_dust_limit_satoshis = Readable::read(reader)?;
3649 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3650 let their_channel_reserve_satoshis = Readable::read(reader)?;
3651 let their_htlc_minimum_msat = Readable::read(reader)?;
3652 let our_htlc_minimum_msat = Readable::read(reader)?;
3653 let their_to_self_delay = Readable::read(reader)?;
3654 let their_max_accepted_htlcs = Readable::read(reader)?;
3655 let minimum_depth = Readable::read(reader)?;
3657 let their_funding_pubkey = read_option!();
3658 let their_revocation_basepoint = read_option!();
3659 let their_payment_basepoint = read_option!();
3660 let their_delayed_payment_basepoint = read_option!();
3661 let their_htlc_basepoint = read_option!();
3662 let their_cur_commitment_point = read_option!();
3664 let their_prev_commitment_point = read_option!();
3665 let their_node_id = Readable::read(reader)?;
3667 let their_shutdown_scriptpubkey = read_option!();
3668 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3669 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3670 // doing full block connection operations on the internal CHannelMonitor copies
3671 if monitor_last_block != last_block_connected {
3672 return Err(DecodeError::InvalidValue);
3681 secp_ctx: Secp256k1::new(),
3683 channel_value_satoshis,
3688 cur_local_commitment_transaction_number,
3689 cur_remote_commitment_transaction_number,
3692 received_commitment_while_awaiting_raa,
3693 pending_inbound_htlcs,
3694 pending_outbound_htlcs,
3695 holding_cell_htlc_updates,
3697 monitor_pending_revoke_and_ack,
3698 monitor_pending_commitment_signed,
3699 monitor_pending_order,
3700 monitor_pending_forwards,
3701 monitor_pending_failures,
3704 holding_cell_update_fee,
3706 next_remote_htlc_id,
3707 channel_update_count,
3710 #[cfg(debug_assertions)]
3711 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3712 #[cfg(debug_assertions)]
3713 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3715 last_local_commitment_txn,
3717 last_sent_closing_fee,
3719 funding_tx_confirmed_in,
3721 last_block_connected,
3722 funding_tx_confirmations,
3724 their_dust_limit_satoshis,
3725 our_dust_limit_satoshis,
3726 their_max_htlc_value_in_flight_msat,
3727 their_channel_reserve_satoshis,
3728 their_htlc_minimum_msat,
3729 our_htlc_minimum_msat,
3730 their_to_self_delay,
3731 their_max_accepted_htlcs,
3734 their_funding_pubkey,
3735 their_revocation_basepoint,
3736 their_payment_basepoint,
3737 their_delayed_payment_basepoint,
3738 their_htlc_basepoint,
3739 their_cur_commitment_point,
3741 their_prev_commitment_point,
3744 their_shutdown_scriptpubkey,
3755 use bitcoin::util::hash::{Sha256dHash, Hash160};
3756 use bitcoin::util::bip143;
3757 use bitcoin::network::serialize::serialize;
3758 use bitcoin::blockdata::script::{Script, Builder};
3759 use bitcoin::blockdata::transaction::Transaction;
3760 use bitcoin::blockdata::opcodes;
3762 use ln::channelmanager::HTLCSource;
3763 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3764 use ln::channel::MAX_FUNDING_SATOSHIS;
3766 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3767 use chain::keysinterface::KeysInterface;
3768 use chain::transaction::OutPoint;
3769 use util::test_utils;
3770 use util::logger::Logger;
3771 use secp256k1::{Secp256k1,Message,Signature};
3772 use secp256k1::key::{SecretKey,PublicKey};
3773 use crypto::sha2::Sha256;
3774 use crypto::digest::Digest;
3777 struct TestFeeEstimator {
3780 impl FeeEstimator for TestFeeEstimator {
3781 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3787 fn test_max_funding_satoshis() {
3788 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3789 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3793 chan_keys: ChannelKeys,
3795 impl KeysInterface for Keys {
3796 fn get_node_secret(&self) -> SecretKey { panic!(); }
3797 fn get_destination_script(&self) -> Script {
3798 let secp_ctx = Secp256k1::signing_only();
3799 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3800 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
3801 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
3804 fn get_shutdown_pubkey(&self) -> PublicKey {
3805 let secp_ctx = Secp256k1::signing_only();
3806 let channel_close_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3807 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
3810 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
3814 fn outbound_commitment_test() {
3815 // Test vectors from BOLT 3 Appendix C:
3816 let feeest = TestFeeEstimator{fee_est: 15000};
3817 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3818 let secp_ctx = Secp256k1::new();
3820 let chan_keys = ChannelKeys {
3821 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3822 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3823 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3824 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3826 // These aren't set in the test vectors:
3827 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3828 commitment_seed: [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],
3830 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3831 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3832 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
3834 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
3835 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, false, 42, Arc::clone(&logger)).unwrap(); // Nothing uses their network key in this test
3836 chan.their_to_self_delay = 144;
3837 chan.our_dust_limit_satoshis = 546;
3839 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
3840 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
3842 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3843 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
3844 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3846 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
3847 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
3848 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
3850 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3851 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
3852 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3854 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
3856 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
3857 // derived from a commitment_seed, so instead we copy it here and call
3858 // build_commitment_transaction.
3859 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
3860 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3861 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3862 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
3863 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
3865 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
3867 macro_rules! test_commitment {
3868 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
3869 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
3870 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3871 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &chan.get_funding_redeemscript(), chan.channel_value_satoshis)[..]).unwrap();
3872 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
3874 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
3876 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
3877 hex::decode($tx_hex).unwrap()[..]);
3881 macro_rules! test_htlc_output {
3882 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
3883 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3885 let ref htlc = unsigned_tx.1[$htlc_idx];
3886 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
3887 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
3888 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3889 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
3891 let mut preimage: Option<[u8; 32]> = None;
3894 let mut sha = Sha256::new();
3895 sha.input(&[i; 32]);
3897 let mut out = [0; 32];
3898 sha.result(&mut out);
3900 if out == htlc.payment_hash {
3901 preimage = Some([i; 32]);
3905 assert!(preimage.is_some());
3908 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
3909 assert_eq!(serialize(&htlc_tx).unwrap()[..],
3910 hex::decode($tx_hex).unwrap()[..]);
3915 // simple commitment tx with no HTLCs
3916 chan.value_to_self_msat = 7000000000;
3918 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
3919 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
3920 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3923 chan.pending_inbound_htlcs.push({
3924 let mut out = InboundHTLCOutput{
3926 amount_msat: 1000000,
3928 payment_hash: [0; 32],
3929 state: InboundHTLCState::Committed,
3931 let mut sha = Sha256::new();
3932 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3933 sha.result(&mut out.payment_hash);
3936 chan.pending_inbound_htlcs.push({
3937 let mut out = InboundHTLCOutput{
3939 amount_msat: 2000000,
3941 payment_hash: [0; 32],
3942 state: InboundHTLCState::Committed,
3944 let mut sha = Sha256::new();
3945 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3946 sha.result(&mut out.payment_hash);
3949 chan.pending_outbound_htlcs.push({
3950 let mut out = OutboundHTLCOutput{
3952 amount_msat: 2000000,
3954 payment_hash: [0; 32],
3955 state: OutboundHTLCState::Committed,
3956 source: HTLCSource::dummy(),
3959 let mut sha = Sha256::new();
3960 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3961 sha.result(&mut out.payment_hash);
3964 chan.pending_outbound_htlcs.push({
3965 let mut out = OutboundHTLCOutput{
3967 amount_msat: 3000000,
3969 payment_hash: [0; 32],
3970 state: OutboundHTLCState::Committed,
3971 source: HTLCSource::dummy(),
3974 let mut sha = Sha256::new();
3975 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
3976 sha.result(&mut out.payment_hash);
3979 chan.pending_inbound_htlcs.push({
3980 let mut out = InboundHTLCOutput{
3982 amount_msat: 4000000,
3984 payment_hash: [0; 32],
3985 state: InboundHTLCState::Committed,
3987 let mut sha = Sha256::new();
3988 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
3989 sha.result(&mut out.payment_hash);
3994 // commitment tx with all five HTLCs untrimmed (minimum feerate)
3995 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3996 chan.feerate_per_kw = 0;
3998 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
3999 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4000 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4002 assert_eq!(unsigned_tx.1.len(), 5);
4004 test_htlc_output!(0,
4005 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4006 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4007 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4009 test_htlc_output!(1,
4010 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4011 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4012 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4014 test_htlc_output!(2,
4015 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4016 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4017 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4019 test_htlc_output!(3,
4020 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4021 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4022 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4024 test_htlc_output!(4,
4025 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4026 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4027 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4031 // commitment tx with seven outputs untrimmed (maximum feerate)
4032 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4033 chan.feerate_per_kw = 647;
4035 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4036 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4037 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4039 assert_eq!(unsigned_tx.1.len(), 5);
4041 test_htlc_output!(0,
4042 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4043 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4044 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4046 test_htlc_output!(1,
4047 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4048 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4049 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4051 test_htlc_output!(2,
4052 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4053 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4054 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4056 test_htlc_output!(3,
4057 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4058 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4059 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4061 test_htlc_output!(4,
4062 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4063 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4064 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4068 // commitment tx with six outputs untrimmed (minimum feerate)
4069 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4070 chan.feerate_per_kw = 648;
4072 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4073 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4074 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4076 assert_eq!(unsigned_tx.1.len(), 4);
4078 test_htlc_output!(0,
4079 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4080 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4081 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4083 test_htlc_output!(1,
4084 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4085 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4086 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4088 test_htlc_output!(2,
4089 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4090 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4091 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4093 test_htlc_output!(3,
4094 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4095 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4096 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4100 // commitment tx with six outputs untrimmed (maximum feerate)
4101 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4102 chan.feerate_per_kw = 2069;
4104 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4105 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4106 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4108 assert_eq!(unsigned_tx.1.len(), 4);
4110 test_htlc_output!(0,
4111 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4112 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4113 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4115 test_htlc_output!(1,
4116 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4117 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4118 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4120 test_htlc_output!(2,
4121 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4122 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4123 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4125 test_htlc_output!(3,
4126 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4127 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4128 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4132 // commitment tx with five outputs untrimmed (minimum feerate)
4133 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4134 chan.feerate_per_kw = 2070;
4136 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4137 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4138 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4140 assert_eq!(unsigned_tx.1.len(), 3);
4142 test_htlc_output!(0,
4143 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4144 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4145 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4147 test_htlc_output!(1,
4148 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4149 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4150 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4152 test_htlc_output!(2,
4153 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4154 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4155 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4159 // commitment tx with five outputs untrimmed (maximum feerate)
4160 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4161 chan.feerate_per_kw = 2194;
4163 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4164 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4165 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4167 assert_eq!(unsigned_tx.1.len(), 3);
4169 test_htlc_output!(0,
4170 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4171 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4172 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4174 test_htlc_output!(1,
4175 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4176 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4177 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4179 test_htlc_output!(2,
4180 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4181 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4182 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4186 // commitment tx with four outputs untrimmed (minimum feerate)
4187 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4188 chan.feerate_per_kw = 2195;
4190 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4191 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4192 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4194 assert_eq!(unsigned_tx.1.len(), 2);
4196 test_htlc_output!(0,
4197 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4198 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4199 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4201 test_htlc_output!(1,
4202 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4203 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4204 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4208 // commitment tx with four outputs untrimmed (maximum feerate)
4209 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4210 chan.feerate_per_kw = 3702;
4212 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4213 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4214 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4216 assert_eq!(unsigned_tx.1.len(), 2);
4218 test_htlc_output!(0,
4219 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4220 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4221 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4223 test_htlc_output!(1,
4224 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4225 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4226 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4230 // commitment tx with three outputs untrimmed (minimum feerate)
4231 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4232 chan.feerate_per_kw = 3703;
4234 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4235 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4236 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4238 assert_eq!(unsigned_tx.1.len(), 1);
4240 test_htlc_output!(0,
4241 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4242 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4243 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4247 // commitment tx with three outputs untrimmed (maximum feerate)
4248 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4249 chan.feerate_per_kw = 4914;
4251 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4252 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4253 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4255 assert_eq!(unsigned_tx.1.len(), 1);
4257 test_htlc_output!(0,
4258 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4259 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4260 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4264 // commitment tx with two outputs untrimmed (minimum feerate)
4265 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4266 chan.feerate_per_kw = 4915;
4268 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4269 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4270 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4272 assert_eq!(unsigned_tx.1.len(), 0);
4276 // commitment tx with two outputs untrimmed (maximum feerate)
4277 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4278 chan.feerate_per_kw = 9651180;
4280 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4281 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4282 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4284 assert_eq!(unsigned_tx.1.len(), 0);
4288 // commitment tx with one output untrimmed (minimum feerate)
4289 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4290 chan.feerate_per_kw = 9651181;
4292 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4293 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4294 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4296 assert_eq!(unsigned_tx.1.len(), 0);
4300 // commitment tx with fee greater than funder amount
4301 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4302 chan.feerate_per_kw = 9651936;
4304 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4305 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4306 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4308 assert_eq!(unsigned_tx.1.len(), 0);
4313 fn test_per_commitment_secret_gen() {
4314 // Test vectors from BOLT 3 Appendix D:
4316 let mut seed = [0; 32];
4317 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4318 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4319 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4321 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4322 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4323 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4325 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4326 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4328 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4329 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4331 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4332 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4333 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4337 fn test_key_derivation() {
4338 // Test vectors from BOLT 3 Appendix E:
4339 let secp_ctx = Secp256k1::new();
4341 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4342 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4344 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4345 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4347 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4348 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4350 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4351 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4353 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4354 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4356 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4357 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4359 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4360 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());