_ Git - rust-lightning/blob - lightning/src/ln/channel.rs

   1 use bitcoin::blockdata::block::BlockHeader;
   2 use bitcoin::blockdata::script::{Script,Builder};
   3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
   4 use bitcoin::blockdata::opcodes;
   5 use bitcoin::util::hash::BitcoinHash;
   6 use bitcoin::util::bip143;
   7 use bitcoin::consensus::encode;
   8
   9 use bitcoin::hashes::{Hash, HashEngine};
  10 use bitcoin::hashes::sha256::Hash as Sha256;
  11 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  12
  13 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  14 use bitcoin::secp256k1::{Secp256k1,Signature};
  15 use bitcoin::secp256k1;
  16
  17 use ln::features::{ChannelFeatures, InitFeatures};
  18 use ln::msgs;
  19 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
  20 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
  21 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
  22 use ln::chan_utils::{CounterpartyCommitmentSecrets, LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys};
  23 use ln::chan_utils;
  24 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
  25 use chain::transaction::OutPoint;
  26 use chain::keysinterface::{ChannelKeys, KeysInterface};
  27 use util::transaction_utils;
  28 use util::ser::{Readable, Writeable, Writer};
  29 use util::logger::Logger;
  30 use util::errors::APIError;
  31 use util::config::{UserConfig,ChannelConfig};
  32
  33 use std;
  34 use std::default::Default;
  35 use std::{cmp,mem,fmt};
  36 use std::ops::Deref;
  37
  38 #[cfg(test)]
  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
  47         pub their_dust_limit_msat: u64,
  48 }
  49
  50 enum InboundHTLCRemovalReason {
  51         FailRelay(msgs::OnionErrorPacket),
  52         FailMalformed(([u8; 32], u16)),
  53         Fulfill(PaymentPreimage),
  54 }
  55
  56 enum InboundHTLCState {
  57         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
  58         /// update_add_htlc message for this HTLC.
  59         RemoteAnnounced(PendingHTLCStatus),
  60         /// Included in a received commitment_signed message (implying we've
  61         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
  62         /// state (see the example below). We have not yet included this HTLC in a
  63         /// commitment_signed message because we are waiting on the remote's
  64         /// aforementioned state revocation. One reason this missing remote RAA
  65         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
  66         /// is because every time we create a new "state", i.e. every time we sign a
  67         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
  68         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
  69         /// sent provided the per_commitment_point for our current commitment tx.
  70         /// The other reason we should not send a commitment_signed without their RAA
  71         /// is because their RAA serves to ACK our previous commitment_signed.
  72         ///
  73         /// Here's an example of how an HTLC could come to be in this state:
  74         /// remote --> update_add_htlc(prev_htlc)   --> local
  75         /// remote --> commitment_signed(prev_htlc) --> local
  76         /// remote <-- revoke_and_ack               <-- local
  77         /// remote <-- commitment_signed(prev_htlc) <-- local
  78         /// [note that here, the remote does not respond with a RAA]
  79         /// remote --> update_add_htlc(this_htlc)   --> local
  80         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
  81         /// Now `this_htlc` will be assigned this state. It's unable to be officially
  82         /// accepted, i.e. included in a commitment_signed, because we're missing the
  83         /// RAA that provides our next per_commitment_point. The per_commitment_point
  84         /// is used to derive commitment keys, which are used to construct the
  85         /// signatures in a commitment_signed message.
  86         /// Implies AwaitingRemoteRevoke.
  87         /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
  88         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
  89         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
  90         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
  91         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
  92         /// channel (before it can then get forwarded and/or removed).
  93         /// Implies AwaitingRemoteRevoke.
  94         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
  95         Committed,
  96         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
  97         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
  98         /// we'll drop it.
  99         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
 100         /// commitment transaction without it as otherwise we'll have to force-close the channel to
 101         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
 102         /// anyway). That said, ChannelMonitor does this for us (see
 103         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
 104         /// local state before then, once we're sure that the next commitment_signed and
 105         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
 106         LocalRemoved(InboundHTLCRemovalReason),
 107 }
 108
 109 struct InboundHTLCOutput {
 110         htlc_id: u64,
 111         amount_msat: u64,
 112         cltv_expiry: u32,
 113         payment_hash: PaymentHash,
 114         state: InboundHTLCState,
 115 }
 116
 117 enum OutboundHTLCState {
 118         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
 119         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
 120         /// we will promote to Committed (note that they may not accept it until the next time we
 121         /// revoke, but we don't really care about that:
 122         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
 123         ///    money back (though we won't), and,
 124         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
 125         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
 126         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
 127         ///    we'll never get out of sync).
 128         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
 129         /// OutboundHTLCOutput's size just for a temporary bit
 130         LocalAnnounced(Box<msgs::OnionPacket>),
 131         Committed,
 132         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
 133         /// the change (though they'll need to revoke before we fail the payment).
 134         RemoteRemoved(Option<HTLCFailReason>),
 135         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 136         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 137         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 138         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
 139         /// remote revoke_and_ack on a previous state before we can do so.
 140         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
 141         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 142         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 143         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 144         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
 145         /// revoke_and_ack to drop completely.
 146         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
 147 }
 148
 149 struct OutboundHTLCOutput {
 150         htlc_id: u64,
 151         amount_msat: u64,
 152         cltv_expiry: u32,
 153         payment_hash: PaymentHash,
 154         state: OutboundHTLCState,
 155         source: HTLCSource,
 156 }
 157
 158 /// See AwaitingRemoteRevoke ChannelState for more info
 159 enum HTLCUpdateAwaitingACK {
 160         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
 161                 // always outbound
 162                 amount_msat: u64,
 163                 cltv_expiry: u32,
 164                 payment_hash: PaymentHash,
 165                 source: HTLCSource,
 166                 onion_routing_packet: msgs::OnionPacket,
 167         },
 168         ClaimHTLC {
 169                 payment_preimage: PaymentPreimage,
 170                 htlc_id: u64,
 171         },
 172         FailHTLC {
 173                 htlc_id: u64,
 174                 err_packet: msgs::OnionErrorPacket,
 175         },
 176 }
 177
 178 /// There are a few "states" and then a number of flags which can be applied:
 179 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
 180 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
 181 /// move on to ChannelFunded.
 182 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
 183 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
 184 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
 185 enum ChannelState {
 186         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
 187         OurInitSent = 1 << 0,
 188         /// Implies we have received their open_channel/accept_channel message
 189         TheirInitSent = 1 << 1,
 190         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
 191         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
 192         /// upon receipt of funding_created, so simply skip this state.
 193         FundingCreated = 4,
 194         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
 195         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
 196         /// and our counterparty consider the funding transaction confirmed.
 197         FundingSent = 8,
 198         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
 199         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 200         TheirFundingLocked = 1 << 4,
 201         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
 202         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 203         OurFundingLocked = 1 << 5,
 204         ChannelFunded = 64,
 205         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
 206         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
 207         /// dance.
 208         PeerDisconnected = 1 << 7,
 209         /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
 210         /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
 211         /// outbound messages until they've managed to do so.
 212         MonitorUpdateFailed = 1 << 8,
 213         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
 214         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
 215         /// messages as then we will be unable to determine which HTLCs they included in their
 216         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
 217         /// later.
 218         /// Flag is set on ChannelFunded.
 219         AwaitingRemoteRevoke = 1 << 9,
 220         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
 221         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
 222         /// to respond with our own shutdown message when possible.
 223         RemoteShutdownSent = 1 << 10,
 224         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
 225         /// point, we may not add any new HTLCs to the channel.
 226         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
 227         /// us their shutdown.
 228         LocalShutdownSent = 1 << 11,
 229         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
 230         /// to drop us, but we store this anyway.
 231         ShutdownComplete = 4096,
 232 }
 233 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
 234 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
 235
 236 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
 237
 238 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
 239 /// If channel is public, network should have a liveness view announced by us on a
 240 /// best-effort, which means we may filter out some status transitions to avoid spam.
 241 /// See further timer_chan_freshness_every_min.
 242 #[derive(PartialEq)]
 243 enum UpdateStatus {
 244         /// Status has been gossiped.
 245         Fresh,
 246         /// Status has been changed.
 247         DisabledMarked,
 248         /// Status has been marked to be gossiped at next flush
 249         DisabledStaged,
 250 }
 251
 252 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
 253 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
 254 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
 255 // inbound channel.
 256 pub(super) struct Channel<ChanSigner: ChannelKeys> {
 257         config: ChannelConfig,
 258
 259         user_id: u64,
 260
 261         channel_id: [u8; 32],
 262         channel_state: u32,
 263         channel_outbound: bool,
 264         secp_ctx: Secp256k1<secp256k1::All>,
 265         channel_value_satoshis: u64,
 266
 267         latest_monitor_update_id: u64,
 268
 269         #[cfg(not(test))]
 270         local_keys: ChanSigner,
 271         #[cfg(test)]
 272         pub(super) local_keys: ChanSigner,
 273         shutdown_pubkey: PublicKey,
 274         destination_script: Script,
 275
 276         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
 277         // generation start at 0 and count up...this simplifies some parts of implementation at the
 278         // cost of others, but should really just be changed.
 279
 280         cur_local_commitment_transaction_number: u64,
 281         cur_remote_commitment_transaction_number: u64,
 282         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
 283         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
 284         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
 285         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
 286
 287         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
 288         /// need to ensure we resend them in the order we originally generated them. Note that because
 289         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
 290         /// sufficient to simply set this to the opposite of any message we are generating as we
 291         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
 292         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
 293         /// send it first.
 294         resend_order: RAACommitmentOrder,
 295
 296         monitor_pending_funding_locked: bool,
 297         monitor_pending_revoke_and_ack: bool,
 298         monitor_pending_commitment_signed: bool,
 299         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
 300         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
 301
 302         // pending_update_fee is filled when sending and receiving update_fee
 303         // For outbound channel, feerate_per_kw is updated with the value from
 304         // pending_update_fee when revoke_and_ack is received
 305         //
 306         // For inbound channel, feerate_per_kw is updated when it receives
 307         // commitment_signed and revoke_and_ack is generated
 308         // The pending value is kept when another pair of update_fee and commitment_signed
 309         // is received during AwaitingRemoteRevoke and relieved when the expected
 310         // revoke_and_ack is received and new commitment_signed is generated to be
 311         // sent to the funder. Otherwise, the pending value is removed when receiving
 312         // commitment_signed.
 313         pending_update_fee: Option<u32>,
 314         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
 315         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
 316         // is received. holding_cell_update_fee is updated when there are additional
 317         // update_fee() during ChannelState::AwaitingRemoteRevoke.
 318         holding_cell_update_fee: Option<u32>,
 319         next_local_htlc_id: u64,
 320         next_remote_htlc_id: u64,
 321         update_time_counter: u32,
 322         feerate_per_kw: u32,
 323
 324         #[cfg(debug_assertions)]
 325         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
 326         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
 327         #[cfg(debug_assertions)]
 328         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
 329         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
 330
 331         last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, our_sig)
 332
 333         funding_txo: Option<OutPoint>,
 334
 335         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
 336         /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
 337         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
 338         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
 339         funding_tx_confirmed_in: Option<BlockHash>,
 340         short_channel_id: Option<u64>,
 341         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
 342         /// ChannelManager deserialization (hence pub(super))
 343         pub(super) last_block_connected: BlockHash,
 344         funding_tx_confirmations: u64,
 345
 346         their_dust_limit_satoshis: u64,
 347         #[cfg(test)]
 348         pub(super) our_dust_limit_satoshis: u64,
 349         #[cfg(not(test))]
 350         our_dust_limit_satoshis: u64,
 351         #[cfg(test)]
 352         pub(super) their_max_htlc_value_in_flight_msat: u64,
 353         #[cfg(not(test))]
 354         their_max_htlc_value_in_flight_msat: u64,
 355         //get_our_max_htlc_value_in_flight_msat(): u64,
 356         /// minimum channel reserve for self to maintain - set by them.
 357         local_channel_reserve_satoshis: u64,
 358         // get_remote_channel_reserve_satoshis(channel_value_sats: u64): u64
 359         their_htlc_minimum_msat: u64,
 360         our_htlc_minimum_msat: u64,
 361         their_to_self_delay: u16,
 362         our_to_self_delay: u16,
 363         #[cfg(test)]
 364         pub their_max_accepted_htlcs: u16,
 365         #[cfg(not(test))]
 366         their_max_accepted_htlcs: u16,
 367         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
 368         minimum_depth: u32,
 369
 370         their_pubkeys: Option<ChannelPublicKeys>,
 371
 372         their_cur_commitment_point: Option<PublicKey>,
 373
 374         their_prev_commitment_point: Option<PublicKey>,
 375         their_node_id: PublicKey,
 376
 377         their_shutdown_scriptpubkey: Option<Script>,
 378
 379         /// Used exclusively to broadcast the latest local state, mostly a historical quirk that this
 380         /// is here:
 381         channel_monitor: Option<ChannelMonitor<ChanSigner>>,
 382         commitment_secrets: CounterpartyCommitmentSecrets,
 383
 384         network_sync: UpdateStatus,
 385 }
 386
 387 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
 388 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
 389 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
 390 /// really allow for this, so instead we're stuck closing it out at that point.
 391 const UNCONF_THRESHOLD: u32 = 6;
 392 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
 393 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?)
 394
 395 #[cfg(not(test))]
 396 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 397 #[cfg(test)]
 398 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 399 #[cfg(not(test))]
 400 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 401 #[cfg(test)]
 402 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 403
 404 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
 405 /// it's 2^24.
 406 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
 407
 408 /// Used to return a simple Error back to ChannelManager. Will get converted to a
 409 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
 410 /// channel_id in ChannelManager.
 411 pub(super) enum ChannelError {
 412         Ignore(&'static str),
 413         Close(&'static str),
 414         CloseDelayBroadcast(&'static str),
 415 }
 416
 417 impl fmt::Debug for ChannelError {
 418         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 419                 match self {
 420                         &ChannelError::Ignore(e) => write!(f, "Ignore : {}", e),
 421                         &ChannelError::Close(e) => write!(f, "Close : {}", e),
 422                         &ChannelError::CloseDelayBroadcast(e) => write!(f, "CloseDelayBroadcast : {}", e)
 423                 }
 424         }
 425 }
 426
 427 macro_rules! secp_check {
 428         ($res: expr, $err: expr) => {
 429                 match $res {
 430                         Ok(thing) => thing,
 431                         Err(_) => return Err(ChannelError::Close($err)),
 432                 }
 433         };
 434 }
 435
 436 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 437         // Convert constants + channel value to limits:
 438         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
 439                 channel_value_satoshis * 1000 / 10 //TODO
 440         }
 441
 442         /// Returns a minimum channel reserve value the remote needs to maintain,
 443         /// required by us.
 444         ///
 445         /// Guaranteed to return a value no larger than channel_value_satoshis
 446         pub(crate) fn get_remote_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
 447                 let (q, _) = channel_value_satoshis.overflowing_div(100);
 448                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
 449         }
 450
 451         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u32) -> u64 {
 452                 cmp::max(at_open_background_feerate as u64 * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
 453         }
 454
 455         // Constructors:
 456         pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, APIError>
 457         where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
 458               F::Target: FeeEstimator,
 459         {
 460                 let chan_keys = keys_provider.get_channel_keys(false, channel_value_satoshis);
 461
 462                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
 463                         return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
 464                 }
 465
 466                 if push_msat > channel_value_satoshis * 1000 {
 467                         return Err(APIError::APIMisuseError{err: "push value > channel value"});
 468                 }
 469                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
 470                         return Err(APIError::APIMisuseError{err: "Configured with an unreasonable our_to_self_delay putting user funds at risks"});
 471                 }
 472
 473
 474                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 475                 if Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(channel_value_satoshis) < Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate) {
 476                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
 477                 }
 478
 479                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
 480
 481                 Ok(Channel {
 482                         user_id: user_id,
 483                         config: config.channel_options.clone(),
 484
 485                         channel_id: keys_provider.get_channel_id(),
 486                         channel_state: ChannelState::OurInitSent as u32,
 487                         channel_outbound: true,
 488                         secp_ctx: Secp256k1::new(),
 489                         channel_value_satoshis: channel_value_satoshis,
 490
 491                         latest_monitor_update_id: 0,
 492
 493                         local_keys: chan_keys,
 494                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
 495                         destination_script: keys_provider.get_destination_script(),
 496
 497                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 498                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 499                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
 500
 501                         pending_inbound_htlcs: Vec::new(),
 502                         pending_outbound_htlcs: Vec::new(),
 503                         holding_cell_htlc_updates: Vec::new(),
 504                         pending_update_fee: None,
 505                         holding_cell_update_fee: None,
 506                         next_local_htlc_id: 0,
 507                         next_remote_htlc_id: 0,
 508                         update_time_counter: 1,
 509
 510                         resend_order: RAACommitmentOrder::CommitmentFirst,
 511
 512                         monitor_pending_funding_locked: false,
 513                         monitor_pending_revoke_and_ack: false,
 514                         monitor_pending_commitment_signed: false,
 515                         monitor_pending_forwards: Vec::new(),
 516                         monitor_pending_failures: Vec::new(),
 517
 518                         #[cfg(debug_assertions)]
 519                         max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
 520                         #[cfg(debug_assertions)]
 521                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
 522
 523                         last_sent_closing_fee: None,
 524
 525                         funding_txo: None,
 526                         funding_tx_confirmed_in: None,
 527                         short_channel_id: None,
 528                         last_block_connected: Default::default(),
 529                         funding_tx_confirmations: 0,
 530
 531                         feerate_per_kw: feerate,
 532                         their_dust_limit_satoshis: 0,
 533                         our_dust_limit_satoshis: Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate),
 534                         their_max_htlc_value_in_flight_msat: 0,
 535                         local_channel_reserve_satoshis: 0,
 536                         their_htlc_minimum_msat: 0,
 537                         our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
 538                         their_to_self_delay: 0,
 539                         our_to_self_delay: config.own_channel_config.our_to_self_delay,
 540                         their_max_accepted_htlcs: 0,
 541                         minimum_depth: 0, // Filled in in accept_channel
 542
 543                         their_pubkeys: None,
 544                         their_cur_commitment_point: None,
 545
 546                         their_prev_commitment_point: None,
 547                         their_node_id: their_node_id,
 548
 549                         their_shutdown_scriptpubkey: None,
 550
 551                         channel_monitor: None,
 552                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
 553
 554                         network_sync: UpdateStatus::Fresh,
 555                 })
 556         }
 557
 558         fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
 559                 where F::Target: FeeEstimator
 560         {
 561                 if feerate_per_kw < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
 562                         return Err(ChannelError::Close("Peer's feerate much too low"));
 563                 }
 564                 if feerate_per_kw as u64 > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64  * 2 {
 565                         return Err(ChannelError::Close("Peer's feerate much too high"));
 566                 }
 567                 Ok(())
 568         }
 569
 570         /// Creates a new channel from a remote sides' request for one.
 571         /// Assumes chain_hash has already been checked and corresponds with what we expect!
 572         pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, ChannelError>
 573                 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
 574           F::Target: FeeEstimator
 575         {
 576                 let mut chan_keys = keys_provider.get_channel_keys(true, msg.funding_satoshis);
 577                 let their_pubkeys = ChannelPublicKeys {
 578                         funding_pubkey: msg.funding_pubkey,
 579                         revocation_basepoint: msg.revocation_basepoint,
 580                         payment_point: msg.payment_point,
 581                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
 582                         htlc_basepoint: msg.htlc_basepoint
 583                 };
 584                 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
 585                 let mut local_config = (*config).channel_options.clone();
 586
 587                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
 588                         return Err(ChannelError::Close("Configured with an unreasonable our_to_self_delay putting user funds at risks"));
 589                 }
 590
 591                 // Check sanity of message fields:
 592                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
 593                         return Err(ChannelError::Close("funding value > 2^24"));
 594                 }
 595                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
 596                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
 597                 }
 598                 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
 599                         return Err(ChannelError::Close("push_msat larger than funding value"));
 600                 }
 601                 if msg.dust_limit_satoshis > msg.funding_satoshis {
 602                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
 603                 }
 604                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
 605                         return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
 606                 }
 607                 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
 608                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
 609                 }
 610                 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
 611
 612                 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
 613                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
 614                 }
 615                 if msg.max_accepted_htlcs < 1 {
 616                         return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
 617                 }
 618                 if msg.max_accepted_htlcs > 483 {
 619                         return Err(ChannelError::Close("max_accpted_htlcs > 483"));
 620                 }
 621
 622                 // Now check against optional parameters as set by config...
 623                 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
 624                         return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
 625                 }
 626                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
 627                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
 628                 }
 629                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
 630                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
 631                 }
 632                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
 633                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
 634                 }
 635                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
 636                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
 637                 }
 638                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
 639                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
 640                 }
 641                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
 642                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
 643                 }
 644
 645                 // Convert things into internal flags and prep our state:
 646
 647                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
 648                 if config.peer_channel_config_limits.force_announced_channel_preference {
 649                         if local_config.announced_channel != their_announce {
 650                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
 651                         }
 652                 }
 653                 // we either accept their preference or the preferences match
 654                 local_config.announced_channel = their_announce;
 655
 656                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 657
 658                 let our_dust_limit_satoshis = Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate);
 659                 let remote_channel_reserve_satoshis = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(msg.funding_satoshis);
 660                 if remote_channel_reserve_satoshis < our_dust_limit_satoshis {
 661                         return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
 662                 }
 663                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
 664                         return Err(ChannelError::Close("channel_reserve_satoshis too small"));
 665                 }
 666                 if remote_channel_reserve_satoshis < msg.dust_limit_satoshis {
 667                         return Err(ChannelError::Close("Dust limit too high for the channel reserve we require the remote to keep"));
 668                 }
 669
 670                 // check if the funder's amount for the initial commitment tx is sufficient
 671                 // for full fee payment
 672                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
 673                 if funders_amount_msat < background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT {
 674                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
 675                 }
 676
 677                 let to_local_msat = msg.push_msat;
 678                 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
 679                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= remote_channel_reserve_satoshis * 1000 {
 680                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
 681                 }
 682
 683                 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
 684                         match &msg.shutdown_scriptpubkey {
 685                                 &OptionalField::Present(ref script) => {
 686                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
 687                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
 688                                                 Some(script.clone())
 689                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
 690                                         } else if script.len() == 0 {
 691                                                 None
 692                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
 693                                         } else {
 694                                                 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
 695                                         }
 696                                 },
 697                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
 698                                 &OptionalField::Absent => {
 699                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
 700                                 }
 701                         }
 702                 } else { None };
 703
 704                 let chan = Channel {
 705                         user_id: user_id,
 706                         config: local_config,
 707
 708                         channel_id: msg.temporary_channel_id,
 709                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
 710                         channel_outbound: false,
 711                         secp_ctx: Secp256k1::new(),
 712
 713                         latest_monitor_update_id: 0,
 714
 715                         local_keys: chan_keys,
 716                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
 717                         destination_script: keys_provider.get_destination_script(),
 718
 719                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 720                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 721                         value_to_self_msat: msg.push_msat,
 722
 723                         pending_inbound_htlcs: Vec::new(),
 724                         pending_outbound_htlcs: Vec::new(),
 725                         holding_cell_htlc_updates: Vec::new(),
 726                         pending_update_fee: None,
 727                         holding_cell_update_fee: None,
 728                         next_local_htlc_id: 0,
 729                         next_remote_htlc_id: 0,
 730                         update_time_counter: 1,
 731
 732                         resend_order: RAACommitmentOrder::CommitmentFirst,
 733
 734                         monitor_pending_funding_locked: false,
 735                         monitor_pending_revoke_and_ack: false,
 736                         monitor_pending_commitment_signed: false,
 737                         monitor_pending_forwards: Vec::new(),
 738                         monitor_pending_failures: Vec::new(),
 739
 740                         #[cfg(debug_assertions)]
 741                         max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
 742                         #[cfg(debug_assertions)]
 743                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
 744
 745                         last_sent_closing_fee: None,
 746
 747                         funding_txo: None,
 748                         funding_tx_confirmed_in: None,
 749                         short_channel_id: None,
 750                         last_block_connected: Default::default(),
 751                         funding_tx_confirmations: 0,
 752
 753                         feerate_per_kw: msg.feerate_per_kw,
 754                         channel_value_satoshis: msg.funding_satoshis,
 755                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
 756                         our_dust_limit_satoshis: our_dust_limit_satoshis,
 757                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
 758                         local_channel_reserve_satoshis: msg.channel_reserve_satoshis,
 759                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
 760                         our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
 761                         their_to_self_delay: msg.to_self_delay,
 762                         our_to_self_delay: config.own_channel_config.our_to_self_delay,
 763                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
 764                         minimum_depth: config.own_channel_config.minimum_depth,
 765
 766                         their_pubkeys: Some(their_pubkeys),
 767                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
 768
 769                         their_prev_commitment_point: None,
 770                         their_node_id: their_node_id,
 771
 772                         their_shutdown_scriptpubkey,
 773
 774                         channel_monitor: None,
 775                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
 776
 777                         network_sync: UpdateStatus::Fresh,
 778                 };
 779
 780                 Ok(chan)
 781         }
 782
 783         // Utilities to derive keys:
 784
 785         fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
 786                 let res = self.local_keys.commitment_secret(idx);
 787                 SecretKey::from_slice(&res).unwrap()
 788         }
 789
 790         // Utilities to build transactions:
 791
 792         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
 793                 let mut sha = Sha256::engine();
 794
 795                 let their_payment_point = &self.their_pubkeys.as_ref().unwrap().payment_point.serialize();
 796                 if self.channel_outbound {
 797                         sha.input(&self.local_keys.pubkeys().payment_point.serialize());
 798                         sha.input(their_payment_point);
 799                 } else {
 800                         sha.input(their_payment_point);
 801                         sha.input(&self.local_keys.pubkeys().payment_point.serialize());
 802                 }
 803                 let res = Sha256::from_engine(sha).into_inner();
 804
 805                 ((res[26] as u64) << 5*8) |
 806                 ((res[27] as u64) << 4*8) |
 807                 ((res[28] as u64) << 3*8) |
 808                 ((res[29] as u64) << 2*8) |
 809                 ((res[30] as u64) << 1*8) |
 810                 ((res[31] as u64) << 0*8)
 811         }
 812
 813         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
 814         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
 815         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
 816         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
 817         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
 818         /// an HTLC to a).
 819         /// @local is used only to convert relevant internal structures which refer to remote vs local
 820         /// to decide value of outputs and direction of HTLCs.
 821         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
 822         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
 823         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
 824         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
 825         /// which peer generated this transaction and "to whom" this transaction flows.
 826         /// Returns (the transaction built, the number of HTLC outputs which were present in the
 827         /// transaction, the list of HTLCs which were not ignored when building the transaction).
 828         /// Note that below-dust HTLCs are included in the third return value, but not the second, and
 829         /// sources are provided only for outbound HTLCs in the third return value.
 830         #[inline]
 831         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u32, logger: &L) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
 832                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
 833
 834                 let txins = {
 835                         let mut ins: Vec<TxIn> = Vec::new();
 836                         ins.push(TxIn {
 837                                 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
 838                                 script_sig: Script::new(),
 839                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
 840                                 witness: Vec::new(),
 841                         });
 842                         ins
 843                 };
 844
 845                 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
 846                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
 847
 848                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
 849                 let mut remote_htlc_total_msat = 0;
 850                 let mut local_htlc_total_msat = 0;
 851                 let mut value_to_self_msat_offset = 0;
 852
 853                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), self.get_commitment_transaction_number_obscure_factor(), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
 854
 855                 macro_rules! get_htlc_in_commitment {
 856                         ($htlc: expr, $offered: expr) => {
 857                                 HTLCOutputInCommitment {
 858                                         offered: $offered,
 859                                         amount_msat: $htlc.amount_msat,
 860                                         cltv_expiry: $htlc.cltv_expiry,
 861                                         payment_hash: $htlc.payment_hash,
 862                                         transaction_output_index: None
 863                                 }
 864                         }
 865                 }
 866
 867                 macro_rules! add_htlc_output {
 868                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
 869                                 if $outbound == local { // "offered HTLC output"
 870                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
 871                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
 872                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 873                                                 txouts.push((TxOut {
 874                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 875                                                         value: $htlc.amount_msat / 1000
 876                                                 }, Some((htlc_in_tx, $source))));
 877                                         } else {
 878                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 879                                                 included_dust_htlcs.push((htlc_in_tx, $source));
 880                                         }
 881                                 } else {
 882                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
 883                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
 884                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 885                                                 txouts.push((TxOut { // "received HTLC output"
 886                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 887                                                         value: $htlc.amount_msat / 1000
 888                                                 }, Some((htlc_in_tx, $source))));
 889                                         } else {
 890                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 891                                                 included_dust_htlcs.push((htlc_in_tx, $source));
 892                                         }
 893                                 }
 894                         }
 895                 }
 896
 897                 for ref htlc in self.pending_inbound_htlcs.iter() {
 898                         let (include, state_name) = match htlc.state {
 899                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
 900                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
 901                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
 902                                 InboundHTLCState::Committed => (true, "Committed"),
 903                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
 904                         };
 905
 906                         if include {
 907                                 add_htlc_output!(htlc, false, None, state_name);
 908                                 remote_htlc_total_msat += htlc.amount_msat;
 909                         } else {
 910                                 log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 911                                 match &htlc.state {
 912                                         &InboundHTLCState::LocalRemoved(ref reason) => {
 913                                                 if generated_by_local {
 914                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
 915                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
 916                                                         }
 917                                                 }
 918                                         },
 919                                         _ => {},
 920                                 }
 921                         }
 922                 }
 923
 924                 for ref htlc in self.pending_outbound_htlcs.iter() {
 925                         let (include, state_name) = match htlc.state {
 926                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
 927                                 OutboundHTLCState::Committed => (true, "Committed"),
 928                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
 929                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
 930                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
 931                         };
 932
 933                         if include {
 934                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
 935                                 local_htlc_total_msat += htlc.amount_msat;
 936                         } else {
 937                                 log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 938                                 match htlc.state {
 939                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
 940                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
 941                                         },
 942                                         OutboundHTLCState::RemoteRemoved(None) => {
 943                                                 if !generated_by_local {
 944                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
 945                                                 }
 946                                         },
 947                                         _ => {},
 948                                 }
 949                         }
 950                 }
 951
 952                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
 953                 assert!(value_to_self_msat >= 0);
 954                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
 955                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
 956                 // "violate" their reserve value by couting those against it. Thus, we have to convert
 957                 // everything to i64 before subtracting as otherwise we can overflow.
 958                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
 959                 assert!(value_to_remote_msat >= 0);
 960
 961                 #[cfg(debug_assertions)]
 962                 {
 963                         // Make sure that the to_self/to_remote is always either past the appropriate
 964                         // channel_reserve *or* it is making progress towards it.
 965                         let mut max_commitment_tx_output = if generated_by_local {
 966                                 self.max_commitment_tx_output_local.lock().unwrap()
 967                         } else {
 968                                 self.max_commitment_tx_output_remote.lock().unwrap()
 969                         };
 970                         debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.local_channel_reserve_satoshis as i64);
 971                         max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
 972                         debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
 973                         max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
 974                 }
 975
 976                 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 977                 let (value_to_self, value_to_remote) = if self.channel_outbound {
 978                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
 979                 } else {
 980                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
 981                 };
 982
 983                 let value_to_a = if local { value_to_self } else { value_to_remote };
 984                 let value_to_b = if local { value_to_remote } else { value_to_self };
 985
 986                 if value_to_a >= (dust_limit_satoshis as i64) {
 987                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
 988                         txouts.push((TxOut {
 989                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
 990                                                                                        if local { self.their_to_self_delay } else { self.our_to_self_delay },
 991                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
 992                                 value: value_to_a as u64
 993                         }, None));
 994                 }
 995
 996                 if value_to_b >= (dust_limit_satoshis as i64) {
 997                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
 998                         let static_payment_pk = if local {
 999                                 self.their_pubkeys.as_ref().unwrap().payment_point
1000                         } else {
1001                                 self.local_keys.pubkeys().payment_point
1002                         }.serialize();
1003                         txouts.push((TxOut {
1004                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1005                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1006                                                              .into_script(),
1007                                 value: value_to_b as u64
1008                         }, None));
1009                 }
1010
1011                 transaction_utils::sort_outputs(&mut txouts, |a, b| {
1012                         if let &Some(ref a_htlc) = a {
1013                                 if let &Some(ref b_htlc) = b {
1014                                         a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
1015                                                 // Note that due to hash collisions, we have to have a fallback comparison
1016                                                 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1017                                                 // may fail)!
1018                                                 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
1019                                 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1020                                 // close the channel due to mismatches - they're doing something dumb:
1021                                 } else { cmp::Ordering::Equal }
1022                         } else { cmp::Ordering::Equal }
1023                 });
1024
1025                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
1026                 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
1027                 for (idx, mut out) in txouts.drain(..).enumerate() {
1028                         outputs.push(out.0);
1029                         if let Some((mut htlc, source_option)) = out.1.take() {
1030                                 htlc.transaction_output_index = Some(idx as u32);
1031                                 htlcs_included.push((htlc, source_option));
1032                         }
1033                 }
1034                 let non_dust_htlc_count = htlcs_included.len();
1035                 htlcs_included.append(&mut included_dust_htlcs);
1036
1037                 (Transaction {
1038                         version: 2,
1039                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1040                         input: txins,
1041                         output: outputs,
1042                 }, non_dust_htlc_count, htlcs_included)
1043         }
1044
1045         #[inline]
1046         fn get_closing_scriptpubkey(&self) -> Script {
1047                 let our_channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1048                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
1049         }
1050
1051         #[inline]
1052         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
1053                 (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)
1054         }
1055
1056         #[inline]
1057         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1058                 let txins = {
1059                         let mut ins: Vec<TxIn> = Vec::new();
1060                         ins.push(TxIn {
1061                                 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
1062                                 script_sig: Script::new(),
1063                                 sequence: 0xffffffff,
1064                                 witness: Vec::new(),
1065                         });
1066                         ins
1067                 };
1068
1069                 assert!(self.pending_inbound_htlcs.is_empty());
1070                 assert!(self.pending_outbound_htlcs.is_empty());
1071                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1072
1073                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1074                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1075                 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 };
1076
1077                 if value_to_self < 0 {
1078                         assert!(self.channel_outbound);
1079                         total_fee_satoshis += (-value_to_self) as u64;
1080                 } else if value_to_remote < 0 {
1081                         assert!(!self.channel_outbound);
1082                         total_fee_satoshis += (-value_to_remote) as u64;
1083                 }
1084
1085                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1086                         txouts.push((TxOut {
1087                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1088                                 value: value_to_remote as u64
1089                         }, ()));
1090                 }
1091
1092                 if value_to_self as u64 > self.our_dust_limit_satoshis {
1093                         txouts.push((TxOut {
1094                                 script_pubkey: self.get_closing_scriptpubkey(),
1095                                 value: value_to_self as u64
1096                         }, ()));
1097                 }
1098
1099                 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1100
1101                 let mut outputs: Vec<TxOut> = Vec::new();
1102                 for out in txouts.drain(..) {
1103                         outputs.push(out.0);
1104                 }
1105
1106                 (Transaction {
1107                         version: 2,
1108                         lock_time: 0,
1109                         input: txins,
1110                         output: outputs,
1111                 }, total_fee_satoshis)
1112         }
1113
1114         #[inline]
1115         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1116         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1117         /// our counterparty!)
1118         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1119         /// TODO Some magic rust shit to compile-time check this?
1120         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1121                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1122                 let delayed_payment_base = &self.local_keys.pubkeys().delayed_payment_basepoint;
1123                 let htlc_basepoint = &self.local_keys.pubkeys().htlc_basepoint;
1124                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1125
1126                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys"))
1127         }
1128
1129         #[inline]
1130         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1131         /// will sign and send to our counterparty.
1132         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1133         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1134                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1135                 //may see payments to it!
1136                 let revocation_basepoint = &self.local_keys.pubkeys().revocation_basepoint;
1137                 let htlc_basepoint = &self.local_keys.pubkeys().htlc_basepoint;
1138                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1139
1140                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &their_pubkeys.delayed_payment_basepoint, &their_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint), "Remote tx keys generation got bogus keys"))
1141         }
1142
1143         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1144         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1145         /// Panics if called before accept_channel/new_from_req
1146         pub fn get_funding_redeemscript(&self) -> Script {
1147                 make_funding_redeemscript(&self.local_keys.pubkeys().funding_pubkey, self.their_funding_pubkey())
1148         }
1149
1150         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1151         /// @local is used only to convert relevant internal structures which refer to remote vs local
1152         /// to decide value of outputs and direction of HTLCs.
1153         fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u32) -> Transaction {
1154                 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { self.our_to_self_delay }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1155         }
1156
1157         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1158         /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1159         /// return Ok(_) if debug assertions are turned on or preconditions are met.
1160         ///
1161         /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1162         /// but then have a reorg which settles on an HTLC-failure on chain.
1163         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1164                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1165                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1166                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1167                 // either.
1168                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1169                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1170                 }
1171                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1172
1173                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1174
1175                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1176                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1177                 // these, but for now we just have to treat them as normal.
1178
1179                 let mut pending_idx = std::usize::MAX;
1180                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1181                         if htlc.htlc_id == htlc_id_arg {
1182                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1183                                 match htlc.state {
1184                                         InboundHTLCState::Committed => {},
1185                                         InboundHTLCState::LocalRemoved(ref reason) => {
1186                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1187                                                 } else {
1188                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1189                                                 }
1190                                                 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1191                                                 return Ok((None, None));
1192                                         },
1193                                         _ => {
1194                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1195                                                 // Don't return in release mode here so that we can update channel_monitor
1196                                         }
1197                                 }
1198                                 pending_idx = idx;
1199                                 break;
1200                         }
1201                 }
1202                 if pending_idx == std::usize::MAX {
1203                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1204                 }
1205
1206                 // Now update local state:
1207                 //
1208                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1209                 // can claim it even if the channel hits the chain before we see their next commitment.
1210                 self.latest_monitor_update_id += 1;
1211                 let monitor_update = ChannelMonitorUpdate {
1212                         update_id: self.latest_monitor_update_id,
1213                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1214                                 payment_preimage: payment_preimage_arg.clone(),
1215                         }],
1216                 };
1217                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
1218
1219                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1220                         for pending_update in self.holding_cell_htlc_updates.iter() {
1221                                 match pending_update {
1222                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1223                                                 if htlc_id_arg == htlc_id {
1224                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
1225                                                         self.latest_monitor_update_id -= 1;
1226                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1227                                                         return Ok((None, None));
1228                                                 }
1229                                         },
1230                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1231                                                 if htlc_id_arg == htlc_id {
1232                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1233                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1234                                                         // rare enough it may not be worth the complexity burden.
1235                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1236                                                         return Ok((None, Some(monitor_update)));
1237                                                 }
1238                                         },
1239                                         _ => {}
1240                                 }
1241                         }
1242                         log_trace!(logger, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1243                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1244                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1245                         });
1246                         return Ok((None, Some(monitor_update)));
1247                 }
1248
1249                 {
1250                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1251                         if let InboundHTLCState::Committed = htlc.state {
1252                         } else {
1253                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1254                                 return Ok((None, Some(monitor_update)));
1255                         }
1256                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1257                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1258                 }
1259
1260                 Ok((Some(msgs::UpdateFulfillHTLC {
1261                         channel_id: self.channel_id(),
1262                         htlc_id: htlc_id_arg,
1263                         payment_preimage: payment_preimage_arg,
1264                 }), Some(monitor_update)))
1265         }
1266
1267         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1268                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger)? {
1269                         (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1270                                 let (commitment, mut additional_update) = self.send_commitment_no_status_check(logger)?;
1271                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1272                                 // strictly increasing by one, so decrement it here.
1273                                 self.latest_monitor_update_id = monitor_update.update_id;
1274                                 monitor_update.updates.append(&mut additional_update.updates);
1275                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1276                         },
1277                         (Some(update_fulfill_htlc), None) => {
1278                                 let (commitment, monitor_update) = self.send_commitment_no_status_check(logger)?;
1279                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1280                         },
1281                         (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1282                         (None, None) => Ok((None, None))
1283                 }
1284         }
1285
1286         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1287         /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1288         /// return Ok(_) if debug assertions are turned on or preconditions are met.
1289         ///
1290         /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1291         /// but then have a reorg which settles on an HTLC-failure on chain.
1292         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1293                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1294                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1295                 }
1296                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1297
1298                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1299                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1300                 // these, but for now we just have to treat them as normal.
1301
1302                 let mut pending_idx = std::usize::MAX;
1303                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1304                         if htlc.htlc_id == htlc_id_arg {
1305                                 match htlc.state {
1306                                         InboundHTLCState::Committed => {},
1307                                         InboundHTLCState::LocalRemoved(_) => {
1308                                                 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1309                                                 return Ok(None);
1310                                         },
1311                                         _ => {
1312                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1313                                                 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1314                                         }
1315                                 }
1316                                 pending_idx = idx;
1317                         }
1318                 }
1319                 if pending_idx == std::usize::MAX {
1320                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1321                 }
1322
1323                 // Now update local state:
1324                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1325                         for pending_update in self.holding_cell_htlc_updates.iter() {
1326                                 match pending_update {
1327                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1328                                                 if htlc_id_arg == htlc_id {
1329                                                         debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1330                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1331                                                 }
1332                                         },
1333                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1334                                                 if htlc_id_arg == htlc_id {
1335                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1336                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1337                                                 }
1338                                         },
1339                                         _ => {}
1340                                 }
1341                         }
1342                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1343                                 htlc_id: htlc_id_arg,
1344                                 err_packet,
1345                         });
1346                         return Ok(None);
1347                 }
1348
1349                 {
1350                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1351                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1352                 }
1353
1354                 Ok(Some(msgs::UpdateFailHTLC {
1355                         channel_id: self.channel_id(),
1356                         htlc_id: htlc_id_arg,
1357                         reason: err_packet
1358                 }))
1359         }
1360
1361         // Message handlers:
1362
1363         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1364                 // Check sanity of message fields:
1365                 if !self.channel_outbound {
1366                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1367                 }
1368                 if self.channel_state != ChannelState::OurInitSent as u32 {
1369                         return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1370                 }
1371                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1372                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1373                 }
1374                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1375                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1376                 }
1377                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1378                         return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1379                 }
1380                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1381                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1382                 }
1383                 if msg.dust_limit_satoshis > Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) {
1384                         return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1385                 }
1386                 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1387                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1388                 }
1389                 if msg.to_self_delay > config.peer_channel_config_limits.their_to_self_delay || msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1390                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1391                 }
1392                 if msg.max_accepted_htlcs < 1 {
1393                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1394                 }
1395                 if msg.max_accepted_htlcs > 483 {
1396                         return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1397                 }
1398
1399                 // Now check against optional parameters as set by config...
1400                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1401                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1402                 }
1403                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1404                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1405                 }
1406                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1407                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1408                 }
1409                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1410                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1411                 }
1412                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1413                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1414                 }
1415                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1416                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1417                 }
1418                 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1419                         return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1420                 }
1421
1422                 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1423                         match &msg.shutdown_scriptpubkey {
1424                                 &OptionalField::Present(ref script) => {
1425                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1426                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1427                                                 Some(script.clone())
1428                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1429                                         } else if script.len() == 0 {
1430                                                 None
1431                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1432                                         } else {
1433                                                 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format"));
1434                                         }
1435                                 },
1436                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1437                                 &OptionalField::Absent => {
1438                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out"));
1439                                 }
1440                         }
1441                 } else { None };
1442
1443                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1444                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1445                 self.local_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1446                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1447                 self.their_to_self_delay = msg.to_self_delay;
1448                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1449                 self.minimum_depth = msg.minimum_depth;
1450
1451                 let their_pubkeys = ChannelPublicKeys {
1452                         funding_pubkey: msg.funding_pubkey,
1453                         revocation_basepoint: msg.revocation_basepoint,
1454                         payment_point: msg.payment_point,
1455                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1456                         htlc_basepoint: msg.htlc_basepoint
1457                 };
1458
1459                 self.local_keys.set_remote_channel_pubkeys(&their_pubkeys);
1460                 self.their_pubkeys = Some(their_pubkeys);
1461
1462                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1463                 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1464
1465                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1466
1467                 Ok(())
1468         }
1469
1470         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Transaction, LocalCommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1471                 let funding_script = self.get_funding_redeemscript();
1472
1473                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1474                 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1475                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1476
1477                 // They sign the "local" commitment transaction...
1478                 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_initial_commitment_tx), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1479                 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, self.their_funding_pubkey()), "Invalid funding_created signature from peer");
1480
1481                 let localtx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx, sig.clone(), &self.local_keys.pubkeys().funding_pubkey, self.their_funding_pubkey(), local_keys, self.feerate_per_kw, Vec::new());
1482
1483                 let remote_keys = self.build_remote_transaction_keys()?;
1484                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1485                 let remote_signature = self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
1486                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0;
1487
1488                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1489                 Ok((remote_initial_commitment_tx, localtx, remote_signature))
1490         }
1491
1492         fn their_funding_pubkey(&self) -> &PublicKey {
1493                 &self.their_pubkeys.as_ref().expect("their_funding_pubkey() only allowed after accept_channel").funding_pubkey
1494         }
1495
1496         pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<ChanSigner>), ChannelError> where L::Target: Logger {
1497                 if self.channel_outbound {
1498                         return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1499                 }
1500                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1501                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1502                         // remember the channel, so it's safe to just send an error_message here and drop the
1503                         // channel.
1504                         return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1505                 }
1506                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1507                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1508                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1509                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1510                 }
1511
1512                 let funding_txo = OutPoint{ txid: msg.funding_txid, index: msg.funding_output_index };
1513                 self.funding_txo = Some(funding_txo.clone());
1514
1515                 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature, logger) {
1516                         Ok(res) => res,
1517                         Err(e) => {
1518                                 self.funding_txo = None;
1519                                 return Err(e);
1520                         }
1521                 };
1522
1523                 // Now that we're past error-generating stuff, update our local state:
1524
1525                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1526                 let funding_redeemscript = self.get_funding_redeemscript();
1527                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1528                 macro_rules! create_monitor {
1529                         () => { {
1530                                 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1531                                                                               &self.shutdown_pubkey, self.our_to_self_delay,
1532                                                                               &self.destination_script, (funding_txo, funding_txo_script.clone()),
1533                                                                               &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1534                                                                               self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1535                                                                               self.get_commitment_transaction_number_obscure_factor(),
1536                                                                               local_initial_commitment_tx.clone());
1537
1538                                 channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap(), logger);
1539                                 channel_monitor
1540                         } }
1541                 }
1542
1543                 self.channel_monitor = Some(create_monitor!());
1544                 let channel_monitor = create_monitor!();
1545
1546                 self.channel_state = ChannelState::FundingSent as u32;
1547                 self.channel_id = funding_txo.to_channel_id();
1548                 self.cur_remote_commitment_transaction_number -= 1;
1549                 self.cur_local_commitment_transaction_number -= 1;
1550
1551                 Ok((msgs::FundingSigned {
1552                         channel_id: self.channel_id,
1553                         signature: our_signature
1554                 }, channel_monitor))
1555         }
1556
1557         /// Handles a funding_signed message from the remote end.
1558         /// If this call is successful, broadcast the funding transaction (and not before!)
1559         pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, logger: &L) -> Result<ChannelMonitor<ChanSigner>, ChannelError> where L::Target: Logger {
1560                 if !self.channel_outbound {
1561                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1562                 }
1563                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1564                         return Err(ChannelError::Close("Received funding_signed in strange state!"));
1565                 }
1566                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1567                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1568                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1569                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1570                 }
1571
1572                 let funding_script = self.get_funding_redeemscript();
1573
1574                 let remote_keys = self.build_remote_transaction_keys()?;
1575                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1576
1577                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1578                 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1579                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1580
1581                 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1582
1583                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1584                 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, their_funding_pubkey) {
1585                         return Err(ChannelError::Close("Invalid funding_signed signature from peer"));
1586                 }
1587
1588                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1589                 let funding_redeemscript = self.get_funding_redeemscript();
1590                 let funding_txo = self.funding_txo.as_ref().unwrap();
1591                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1592                 macro_rules! create_monitor {
1593                         () => { {
1594                                 let local_commitment_tx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx.clone(), msg.signature.clone(), &self.local_keys.pubkeys().funding_pubkey, their_funding_pubkey, local_keys.clone(), self.feerate_per_kw, Vec::new());
1595                                 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1596                                                                               &self.shutdown_pubkey, self.our_to_self_delay,
1597                                                                               &self.destination_script, (funding_txo.clone(), funding_txo_script.clone()),
1598                                                                               &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1599                                                                               self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1600                                                                               self.get_commitment_transaction_number_obscure_factor(),
1601                                                                               local_commitment_tx);
1602
1603                                 channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap(), logger);
1604
1605                                 channel_monitor
1606                         } }
1607                 }
1608
1609                 self.channel_monitor = Some(create_monitor!());
1610                 let channel_monitor = create_monitor!();
1611
1612                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1613                 self.channel_state = ChannelState::FundingSent as u32;
1614                 self.cur_local_commitment_transaction_number -= 1;
1615                 self.cur_remote_commitment_transaction_number -= 1;
1616
1617                 Ok(channel_monitor)
1618         }
1619
1620         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1621                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1622                         return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1623                 }
1624
1625                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1626
1627                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1628                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1629                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1630                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1631                         self.update_time_counter += 1;
1632                 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1633                                  // Note that funding_signed/funding_created will have decremented both by 1!
1634                                  self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1635                                  self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1636                                 // If we reconnected before sending our funding locked they may still resend theirs:
1637                                 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1638                                                       (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1639                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1640                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1641                         }
1642                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1643                         return Ok(());
1644                 } else {
1645                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1646                 }
1647
1648                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1649                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1650                 Ok(())
1651         }
1652
1653         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1654         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1655                 let mut htlc_inbound_value_msat = 0;
1656                 for ref htlc in self.pending_inbound_htlcs.iter() {
1657                         htlc_inbound_value_msat += htlc.amount_msat;
1658                 }
1659                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1660         }
1661
1662         /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1663         /// holding cell.
1664         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1665                 let mut htlc_outbound_value_msat = 0;
1666                 for ref htlc in self.pending_outbound_htlcs.iter() {
1667                         htlc_outbound_value_msat += htlc.amount_msat;
1668                 }
1669
1670                 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1671                 for update in self.holding_cell_htlc_updates.iter() {
1672                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1673                                 htlc_outbound_count += 1;
1674                                 htlc_outbound_value_msat += amount_msat;
1675                         }
1676                 }
1677
1678                 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1679         }
1680
1681         /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1682         /// Doesn't bother handling the
1683         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1684         /// corner case properly.
1685         pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1686                 // Note that we have to handle overflow due to the above case.
1687                 (cmp::min(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1688                 cmp::min(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1689         }
1690
1691         // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1692         // Note that num_htlcs should not include dust HTLCs.
1693         fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1694                 // Note that we need to divide before multiplying to round properly,
1695                 // since the lowest denomination of bitcoin on-chain is the satoshi.
1696                 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1697         }
1698
1699         // Get the commitment tx fee for the local (i.e our) next commitment transaction
1700         // based on the number of pending HTLCs that are on track to be in our next
1701         // commitment tx. `addl_htcs` is an optional parameter allowing the caller
1702         // to add a number of additional HTLCs to the calculation. Note that dust
1703         // HTLCs are excluded.
1704         fn next_local_commit_tx_fee_msat(&self, addl_htlcs: usize) -> u64 {
1705                 assert!(self.channel_outbound);
1706
1707                 let mut their_acked_htlcs = self.pending_inbound_htlcs.len();
1708                 for ref htlc in self.pending_outbound_htlcs.iter() {
1709                         if htlc.amount_msat / 1000 <= self.our_dust_limit_satoshis {
1710                                 continue
1711                         }
1712                         match htlc.state {
1713                                 OutboundHTLCState::Committed => their_acked_htlcs += 1,
1714                                 OutboundHTLCState::RemoteRemoved {..} => their_acked_htlcs += 1,
1715                                 OutboundHTLCState::LocalAnnounced {..} => their_acked_htlcs += 1,
1716                                 _ => {},
1717                         }
1718                 }
1719
1720                 for htlc in self.holding_cell_htlc_updates.iter() {
1721                         match htlc {
1722                                 &HTLCUpdateAwaitingACK::AddHTLC { .. } => their_acked_htlcs += 1,
1723                                 _ => {},
1724                         }
1725                 }
1726
1727                 self.commit_tx_fee_msat(their_acked_htlcs + addl_htlcs)
1728         }
1729
1730         // Get the commitment tx fee for the remote's next commitment transaction
1731         // based on the number of pending HTLCs that are on track to be in their
1732         // next commitment tx. `addl_htcs` is an optional parameter allowing the caller
1733         // to add a number of additional HTLCs to the calculation. Note that dust HTLCs
1734         // are excluded.
1735         fn next_remote_commit_tx_fee_msat(&self, addl_htlcs: usize) -> u64 {
1736                 assert!(!self.channel_outbound);
1737
1738                 // When calculating the set of HTLCs which will be included in their next
1739                 // commitment_signed, all inbound HTLCs are included (as all states imply it will be
1740                 // included) and only committed outbound HTLCs, see below.
1741                 let mut their_acked_htlcs = self.pending_inbound_htlcs.len();
1742                 for ref htlc in self.pending_outbound_htlcs.iter() {
1743                         if htlc.amount_msat / 1000 <= self.their_dust_limit_satoshis {
1744                                 continue
1745                         }
1746                         // We only include outbound HTLCs if it will not be included in their next
1747                         // commitment_signed, i.e. if they've responded to us with an RAA after announcement.
1748                         match htlc.state {
1749                                 OutboundHTLCState::Committed => their_acked_htlcs += 1,
1750                                 OutboundHTLCState::RemoteRemoved {..} => their_acked_htlcs += 1,
1751                                 _ => {},
1752                         }
1753                 }
1754
1755                 self.commit_tx_fee_msat(their_acked_htlcs + addl_htlcs)
1756         }
1757
1758         pub fn update_add_htlc<F, L: Deref>(&mut self, msg: &msgs::UpdateAddHTLC, mut pending_forward_status: PendingHTLCStatus, create_pending_htlc_status: F, logger: &L) -> Result<(), ChannelError>
1759         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
1760                 // We can't accept HTLCs sent after we've sent a shutdown.
1761                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1762                 if local_sent_shutdown {
1763                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
1764                 }
1765                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
1766                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1767                 if remote_sent_shutdown {
1768                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1769                 }
1770                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1771                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1772                 }
1773                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1774                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1775                 }
1776                 if msg.amount_msat == 0 {
1777                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC"));
1778                 }
1779                 if msg.amount_msat < self.our_htlc_minimum_msat {
1780                         return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1781                 }
1782
1783                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1784                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1785                         return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1786                 }
1787                 // Check our_max_htlc_value_in_flight_msat
1788                 if htlc_inbound_value_msat + msg.amount_msat > Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1789                         return Err(ChannelError::Close("Remote HTLC add would put them over our max HTLC value"));
1790                 }
1791                 // Check remote_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1792                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1793                 // something if we punish them for broadcasting an old state).
1794                 // Note that we don't really care about having a small/no to_remote output in our local
1795                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1796                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1797                 // present in the next commitment transaction we send them (at least for fulfilled ones,
1798                 // failed ones won't modify value_to_self).
1799                 // Note that we will send HTLCs which another instance of rust-lightning would think
1800                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1801                 // Channel state once they will not be present in the next received commitment
1802                 // transaction).
1803                 let mut removed_outbound_total_msat = 0;
1804                 for ref htlc in self.pending_outbound_htlcs.iter() {
1805                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1806                                 removed_outbound_total_msat += htlc.amount_msat;
1807                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1808                                 removed_outbound_total_msat += htlc.amount_msat;
1809                         }
1810                 }
1811
1812                 let pending_value_to_self_msat =
1813                         self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
1814                 let pending_remote_value_msat =
1815                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
1816                 if pending_remote_value_msat < msg.amount_msat {
1817                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds"));
1818                 }
1819
1820                 // Check that the remote can afford to pay for this HTLC on-chain at the current
1821                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
1822                 let remote_commit_tx_fee_msat = if self.channel_outbound { 0 } else {
1823                         // +1 for this HTLC.
1824                         self.next_remote_commit_tx_fee_msat(1)
1825                 };
1826                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
1827                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees"));
1828                 };
1829
1830                 let chan_reserve_msat =
1831                         Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
1832                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
1833                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value"));
1834                 }
1835
1836                 if !self.channel_outbound {
1837                         // `+1` for this HTLC, `2 *` and `+1` fee spike buffer we keep for the remote. This deviates from the
1838                         // spec because in the spec, the fee spike buffer requirement doesn't exist on the receiver's side,
1839                         // only on the sender's.
1840                         // Note that when we eventually remove support for fee updates and switch to anchor output fees,
1841                         // we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep the extra +1
1842                         // as we should still be able to afford adding this HTLC plus one more future HTLC, regardless of
1843                         // being sensitive to fee spikes.
1844                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(1 + 1);
1845                         if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
1846                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
1847                                 // the HTLC, i.e. its status is already set to failing.
1848                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation");
1849                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
1850                         }
1851                 } else {
1852                         // Check that they won't violate our local required channel reserve by adding this HTLC.
1853
1854                         // +1 for this HTLC.
1855                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(1);
1856                         if self.value_to_self_msat < self.local_channel_reserve_satoshis * 1000 + local_commit_tx_fee_msat {
1857                                 return Err(ChannelError::Close("Cannot receive value that would put us under local channel reserve value"));
1858                         }
1859                 }
1860
1861                 if self.next_remote_htlc_id != msg.htlc_id {
1862                         return Err(ChannelError::Close("Remote skipped HTLC ID"));
1863                 }
1864                 if msg.cltv_expiry >= 500000000 {
1865                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1866                 }
1867
1868                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1869                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
1870                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1871                         }
1872                 }
1873
1874                 // Now update local state:
1875                 self.next_remote_htlc_id += 1;
1876                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1877                         htlc_id: msg.htlc_id,
1878                         amount_msat: msg.amount_msat,
1879                         payment_hash: msg.payment_hash,
1880                         cltv_expiry: msg.cltv_expiry,
1881                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
1882                 });
1883                 Ok(())
1884         }
1885
1886         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1887         #[inline]
1888         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1889                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1890                         if htlc.htlc_id == htlc_id {
1891                                 match check_preimage {
1892                                         None => {},
1893                                         Some(payment_hash) =>
1894                                                 if payment_hash != htlc.payment_hash {
1895                                                         return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1896                                                 }
1897                                 };
1898                                 match htlc.state {
1899                                         OutboundHTLCState::LocalAnnounced(_) =>
1900                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1901                                         OutboundHTLCState::Committed => {
1902                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1903                                         },
1904                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1905                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1906                                 }
1907                                 return Ok(&htlc.source);
1908                         }
1909                 }
1910                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1911         }
1912
1913         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1914                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1915                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1916                 }
1917                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1918                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1919                 }
1920
1921                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1922                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1923         }
1924
1925         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1926                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1927                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1928                 }
1929                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1930                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1931                 }
1932
1933                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1934                 Ok(())
1935         }
1936
1937         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1938                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1939                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1940                 }
1941                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1942                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1943                 }
1944
1945                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1946                 Ok(())
1947         }
1948
1949         pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
1950         where F::Target: FeeEstimator,
1951                                 L::Target: Logger
1952         {
1953                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1954                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state")));
1955                 }
1956                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1957                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish")));
1958                 }
1959                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1960                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds")));
1961                 }
1962
1963                 let funding_script = self.get_funding_redeemscript();
1964
1965                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1966
1967                 let mut update_fee = false;
1968                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1969                         update_fee = true;
1970                         self.pending_update_fee.unwrap()
1971                 } else {
1972                         self.feerate_per_kw
1973                 };
1974
1975                 let mut local_commitment_tx = {
1976                         let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw, logger);
1977                         let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1978                         (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1979                 };
1980                 let local_commitment_txid = local_commitment_tx.0.txid();
1981                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1982                 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_commitment_tx.0), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1983                 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1984                         return Err((None, ChannelError::Close("Invalid commitment tx signature from peer")));
1985                 }
1986
1987                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1988                 if update_fee {
1989                         let num_htlcs = local_commitment_tx.1;
1990                         let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1991
1992                         let remote_reserve_we_require = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
1993                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + remote_reserve_we_require {
1994                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee")));
1995                         }
1996                 }
1997
1998                 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1999                         return Err((None, ChannelError::Close("Got wrong number of HTLC signatures from remote")));
2000                 }
2001
2002                 // TODO: Merge these two, sadly they are currently both required to be passed separately to
2003                 // ChannelMonitor:
2004                 let mut htlcs_without_source = Vec::with_capacity(local_commitment_tx.2.len());
2005                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
2006                 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
2007                         if let Some(_) = htlc.transaction_output_index {
2008                                 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
2009                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
2010                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
2011                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript));
2012                                 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
2013                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer")));
2014                                 }
2015                                 htlcs_without_source.push((htlc.clone(), Some(msg.htlc_signatures[idx])));
2016                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2017                         } else {
2018                                 htlcs_without_source.push((htlc.clone(), None));
2019                                 htlcs_and_sigs.push((htlc, None, source));
2020                         }
2021                 }
2022
2023                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
2024                 let per_commitment_secret = self.local_keys.commitment_secret(self.cur_local_commitment_transaction_number + 1);
2025
2026                 // Update state now that we've passed all the can-fail calls...
2027                 let mut need_our_commitment = false;
2028                 if !self.channel_outbound {
2029                         if let Some(fee_update) = self.pending_update_fee {
2030                                 self.feerate_per_kw = fee_update;
2031                                 // We later use the presence of pending_update_fee to indicate we should generate a
2032                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2033                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2034                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2035                                         need_our_commitment = true;
2036                                         self.pending_update_fee = None;
2037                                 }
2038                         }
2039                 }
2040
2041                 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2042
2043                 self.latest_monitor_update_id += 1;
2044                 let mut monitor_update = ChannelMonitorUpdate {
2045                         update_id: self.latest_monitor_update_id,
2046                         updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
2047                                 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_commitment_tx.0, msg.signature.clone(), &self.local_keys.pubkeys().funding_pubkey, &their_funding_pubkey, local_keys, self.feerate_per_kw, htlcs_without_source),
2048                                 htlc_outputs: htlcs_and_sigs
2049                         }]
2050                 };
2051                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
2052
2053                 for htlc in self.pending_inbound_htlcs.iter_mut() {
2054                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2055                                 Some(forward_info.clone())
2056                         } else { None };
2057                         if let Some(forward_info) = new_forward {
2058                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2059                                 need_our_commitment = true;
2060                         }
2061                 }
2062                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2063                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2064                                 Some(fail_reason.take())
2065                         } else { None } {
2066                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2067                                 need_our_commitment = true;
2068                         }
2069                 }
2070
2071                 self.cur_local_commitment_transaction_number -= 1;
2072                 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
2073                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2074                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2075
2076                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2077                         // In case we initially failed monitor updating without requiring a response, we need
2078                         // to make sure the RAA gets sent first.
2079                         self.monitor_pending_revoke_and_ack = true;
2080                         if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2081                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2082                                 // the corresponding HTLC status updates so that get_last_commitment_update
2083                                 // includes the right HTLCs.
2084                                 self.monitor_pending_commitment_signed = true;
2085                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2086                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2087                                 // strictly increasing by one, so decrement it here.
2088                                 self.latest_monitor_update_id = monitor_update.update_id;
2089                                 monitor_update.updates.append(&mut additional_update.updates);
2090                         }
2091                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2092                         // re-send the message on restoration)
2093                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA")));
2094                 }
2095
2096                 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2097                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2098                         // we'll send one right away when we get the revoke_and_ack when we
2099                         // free_holding_cell_htlcs().
2100                         let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2101                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2102                         // strictly increasing by one, so decrement it here.
2103                         self.latest_monitor_update_id = monitor_update.update_id;
2104                         monitor_update.updates.append(&mut additional_update.updates);
2105                         (Some(msg), None)
2106                 } else if !need_our_commitment {
2107                         (None, self.maybe_propose_first_closing_signed(fee_estimator))
2108                 } else { (None, None) };
2109
2110                 Ok((msgs::RevokeAndACK {
2111                         channel_id: self.channel_id,
2112                         per_commitment_secret: per_commitment_secret,
2113                         next_per_commitment_point: next_per_commitment_point,
2114                 }, our_commitment_signed, closing_signed, monitor_update))
2115         }
2116
2117         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2118         /// fulfilling or failing the last pending HTLC)
2119         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2120                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2121                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2122                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
2123
2124                         let mut monitor_update = ChannelMonitorUpdate {
2125                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2126                                 updates: Vec::new(),
2127                         };
2128
2129                         let mut htlc_updates = Vec::new();
2130                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2131                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2132                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2133                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2134                         let mut err = None;
2135                         for htlc_update in htlc_updates.drain(..) {
2136                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
2137                                 // fee races with adding too many outputs which push our total payments just over
2138                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
2139                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2140                                 // to rebalance channels.
2141                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
2142                                         self.holding_cell_htlc_updates.push(htlc_update);
2143                                 } else {
2144                                         match &htlc_update {
2145                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2146                                                         match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2147                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2148                                                                 Err(e) => {
2149                                                                         match e {
2150                                                                                 ChannelError::Ignore(ref msg) => {
2151                                                                                         log_info!(logger, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2152                                                                                 },
2153                                                                                 _ => {
2154                                                                                         log_info!(logger, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
2155                                                                                 },
2156                                                                         }
2157                                                                         err = Some(e);
2158                                                                 }
2159                                                         }
2160                                                 },
2161                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2162                                                         match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2163                                                                 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2164                                                                         update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2165                                                                         if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2166                                                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
2167                                                                         }
2168                                                                 },
2169                                                                 Err(e) => {
2170                                                                         if let ChannelError::Ignore(_) = e {}
2171                                                                         else {
2172                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2173                                                                         }
2174                                                                 }
2175                                                         }
2176                                                 },
2177                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2178                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2179                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2180                                                                 Err(e) => {
2181                                                                         if let ChannelError::Ignore(_) = e {}
2182                                                                         else {
2183                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2184                                                                         }
2185                                                                 }
2186                                                         }
2187                                                 },
2188                                         }
2189                                         if err.is_some() {
2190                                                 self.holding_cell_htlc_updates.push(htlc_update);
2191                                                 if let Some(ChannelError::Ignore(_)) = err {
2192                                                         // If we failed to add the HTLC, but got an Ignore error, we should
2193                                                         // still send the new commitment_signed, so reset the err to None.
2194                                                         err = None;
2195                                                 }
2196                                         }
2197                                 }
2198                         }
2199                         //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2200                         //fail it back the route, if it's a temporary issue we can ignore it...
2201                         match err {
2202                                 None => {
2203                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2204                                                 // This should never actually happen and indicates we got some Errs back
2205                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2206                                                 // case there is some strange way to hit duplicate HTLC removes.
2207                                                 return Ok(None);
2208                                         }
2209                                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2210                                                         self.pending_update_fee = self.holding_cell_update_fee.take();
2211                                                         Some(msgs::UpdateFee {
2212                                                                 channel_id: self.channel_id,
2213                                                                 feerate_per_kw: feerate as u32,
2214                                                         })
2215                                                 } else {
2216                                                         None
2217                                                 };
2218
2219                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2220                                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2221                                         // but we want them to be strictly increasing by one, so reset it here.
2222                                         self.latest_monitor_update_id = monitor_update.update_id;
2223                                         monitor_update.updates.append(&mut additional_update.updates);
2224
2225                                         Ok(Some((msgs::CommitmentUpdate {
2226                                                 update_add_htlcs,
2227                                                 update_fulfill_htlcs,
2228                                                 update_fail_htlcs,
2229                                                 update_fail_malformed_htlcs: Vec::new(),
2230                                                 update_fee: update_fee,
2231                                                 commitment_signed,
2232                                         }, monitor_update)))
2233                                 },
2234                                 Some(e) => Err(e)
2235                         }
2236                 } else {
2237                         Ok(None)
2238                 }
2239         }
2240
2241         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2242         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2243         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2244         /// generating an appropriate error *after* the channel state has been updated based on the
2245         /// revoke_and_ack message.
2246         pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), ChannelError>
2247                 where F::Target: FeeEstimator,
2248                                         L::Target: Logger,
2249         {
2250                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2251                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2252                 }
2253                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2254                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2255                 }
2256                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2257                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2258                 }
2259
2260                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2261                         if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
2262                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2263                         }
2264                 }
2265
2266                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2267                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
2268                         // haven't given them a new commitment transaction to broadcast). We should probably
2269                         // take advantage of this by updating our channel monitor, sending them an error, and
2270                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2271                         // lot of work, and there's some chance this is all a misunderstanding anyway.
2272                         // We have to do *something*, though, since our signer may get mad at us for otherwise
2273                         // jumping a remote commitment number, so best to just force-close and move on.
2274                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack"));
2275                 }
2276
2277                 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2278                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one"))?;
2279                 self.latest_monitor_update_id += 1;
2280                 let mut monitor_update = ChannelMonitorUpdate {
2281                         update_id: self.latest_monitor_update_id,
2282                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2283                                 idx: self.cur_remote_commitment_transaction_number + 1,
2284                                 secret: msg.per_commitment_secret,
2285                         }],
2286                 };
2287                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
2288
2289                 // Update state now that we've passed all the can-fail calls...
2290                 // (note that we may still fail to generate the new commitment_signed message, but that's
2291                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2292                 // channel based on that, but stepping stuff here should be safe either way.
2293                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2294                 self.their_prev_commitment_point = self.their_cur_commitment_point;
2295                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2296                 self.cur_remote_commitment_transaction_number -= 1;
2297
2298                 log_trace!(logger, "Updating HTLCs on receipt of RAA...");
2299                 let mut to_forward_infos = Vec::new();
2300                 let mut revoked_htlcs = Vec::new();
2301                 let mut update_fail_htlcs = Vec::new();
2302                 let mut update_fail_malformed_htlcs = Vec::new();
2303                 let mut require_commitment = false;
2304                 let mut value_to_self_msat_diff: i64 = 0;
2305
2306                 {
2307                         // Take references explicitly so that we can hold multiple references to self.
2308                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2309                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2310
2311                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2312                         pending_inbound_htlcs.retain(|htlc| {
2313                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2314                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2315                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2316                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2317                                         }
2318                                         false
2319                                 } else { true }
2320                         });
2321                         pending_outbound_htlcs.retain(|htlc| {
2322                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2323                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2324                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2325                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2326                                         } else {
2327                                                 // They fulfilled, so we sent them money
2328                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2329                                         }
2330                                         false
2331                                 } else { true }
2332                         });
2333                         for htlc in pending_inbound_htlcs.iter_mut() {
2334                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2335                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2336                                         true
2337                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2338                                         log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2339                                         true
2340                                 } else { false };
2341                                 if swap {
2342                                         let mut state = InboundHTLCState::Committed;
2343                                         mem::swap(&mut state, &mut htlc.state);
2344
2345                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2346                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2347                                                 require_commitment = true;
2348                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2349                                                 match forward_info {
2350                                                         PendingHTLCStatus::Fail(fail_msg) => {
2351                                                                 require_commitment = true;
2352                                                                 match fail_msg {
2353                                                                         HTLCFailureMsg::Relay(msg) => {
2354                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2355                                                                                 update_fail_htlcs.push(msg)
2356                                                                         },
2357                                                                         HTLCFailureMsg::Malformed(msg) => {
2358                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2359                                                                                 update_fail_malformed_htlcs.push(msg)
2360                                                                         },
2361                                                                 }
2362                                                         },
2363                                                         PendingHTLCStatus::Forward(forward_info) => {
2364                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2365                                                                 htlc.state = InboundHTLCState::Committed;
2366                                                         }
2367                                                 }
2368                                         }
2369                                 }
2370                         }
2371                         for htlc in pending_outbound_htlcs.iter_mut() {
2372                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2373                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2374                                         htlc.state = OutboundHTLCState::Committed;
2375                                 }
2376                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2377                                         Some(fail_reason.take())
2378                                 } else { None } {
2379                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2380                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2381                                         require_commitment = true;
2382                                 }
2383                         }
2384                 }
2385                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2386
2387                 if self.channel_outbound {
2388                         if let Some(feerate) = self.pending_update_fee.take() {
2389                                 self.feerate_per_kw = feerate;
2390                         }
2391                 } else {
2392                         if let Some(feerate) = self.pending_update_fee {
2393                                 // Because a node cannot send two commitment_signeds in a row without getting a
2394                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2395                                 // it should use to create keys with) and because a node can't send a
2396                                 // commitment_signed without changes, checking if the feerate is equal to the
2397                                 // pending feerate update is sufficient to detect require_commitment.
2398                                 if feerate == self.feerate_per_kw {
2399                                         require_commitment = true;
2400                                         self.pending_update_fee = None;
2401                                 }
2402                         }
2403                 }
2404
2405                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2406                         // We can't actually generate a new commitment transaction (incl by freeing holding
2407                         // cells) while we can't update the monitor, so we just return what we have.
2408                         if require_commitment {
2409                                 self.monitor_pending_commitment_signed = true;
2410                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2411                                 // which does not update state, but we're definitely now awaiting a remote revoke
2412                                 // before we can step forward any more, so set it here.
2413                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2414                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2415                                 // strictly increasing by one, so decrement it here.
2416                                 self.latest_monitor_update_id = monitor_update.update_id;
2417                                 monitor_update.updates.append(&mut additional_update.updates);
2418                         }
2419                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2420                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2421                         return Ok((None, Vec::new(), Vec::new(), None, monitor_update))
2422                 }
2423
2424                 match self.free_holding_cell_htlcs(logger)? {
2425                         Some((mut commitment_update, mut additional_update)) => {
2426                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2427                                 for fail_msg in update_fail_htlcs.drain(..) {
2428                                         commitment_update.update_fail_htlcs.push(fail_msg);
2429                                 }
2430                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2431                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2432                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2433                                 }
2434
2435                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2436                                 // strictly increasing by one, so decrement it here.
2437                                 self.latest_monitor_update_id = monitor_update.update_id;
2438                                 monitor_update.updates.append(&mut additional_update.updates);
2439
2440                                 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update))
2441                         },
2442                         None => {
2443                                 if require_commitment {
2444                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2445
2446                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2447                                         // strictly increasing by one, so decrement it here.
2448                                         self.latest_monitor_update_id = monitor_update.update_id;
2449                                         monitor_update.updates.append(&mut additional_update.updates);
2450
2451                                         Ok((Some(msgs::CommitmentUpdate {
2452                                                 update_add_htlcs: Vec::new(),
2453                                                 update_fulfill_htlcs: Vec::new(),
2454                                                 update_fail_htlcs,
2455                                                 update_fail_malformed_htlcs,
2456                                                 update_fee: None,
2457                                                 commitment_signed
2458                                         }), to_forward_infos, revoked_htlcs, None, monitor_update))
2459                                 } else {
2460                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update))
2461                                 }
2462                         }
2463                 }
2464
2465         }
2466
2467         /// Adds a pending update to this channel. See the doc for send_htlc for
2468         /// further details on the optionness of the return value.
2469         /// You MUST call send_commitment prior to any other calls on this Channel
2470         fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2471                 if !self.channel_outbound {
2472                         panic!("Cannot send fee from inbound channel");
2473                 }
2474                 if !self.is_usable() {
2475                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2476                 }
2477                 if !self.is_live() {
2478                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2479                 }
2480
2481                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2482                         self.holding_cell_update_fee = Some(feerate_per_kw);
2483                         return None;
2484                 }
2485
2486                 debug_assert!(self.pending_update_fee.is_none());
2487                 self.pending_update_fee = Some(feerate_per_kw);
2488
2489                 Some(msgs::UpdateFee {
2490                         channel_id: self.channel_id,
2491                         feerate_per_kw: feerate_per_kw,
2492                 })
2493         }
2494
2495         pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2496                 match self.send_update_fee(feerate_per_kw) {
2497                         Some(update_fee) => {
2498                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2499                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2500                         },
2501                         None => Ok(None)
2502                 }
2503         }
2504
2505         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2506         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2507         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2508         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2509         /// No further message handling calls may be made until a channel_reestablish dance has
2510         /// completed.
2511         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Vec<(HTLCSource, PaymentHash)> where L::Target: Logger {
2512                 let mut outbound_drops = Vec::new();
2513
2514                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2515                 if self.channel_state < ChannelState::FundingSent as u32 {
2516                         self.channel_state = ChannelState::ShutdownComplete as u32;
2517                         return outbound_drops;
2518                 }
2519                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2520                 // will be retransmitted.
2521                 self.last_sent_closing_fee = None;
2522
2523                 let mut inbound_drop_count = 0;
2524                 self.pending_inbound_htlcs.retain(|htlc| {
2525                         match htlc.state {
2526                                 InboundHTLCState::RemoteAnnounced(_) => {
2527                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2528                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2529                                         // this HTLC accordingly
2530                                         inbound_drop_count += 1;
2531                                         false
2532                                 },
2533                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2534                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2535                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2536                                         // in response to it yet, so don't touch it.
2537                                         true
2538                                 },
2539                                 InboundHTLCState::Committed => true,
2540                                 InboundHTLCState::LocalRemoved(_) => {
2541                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2542                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2543                                         // (that we missed). Keep this around for now and if they tell us they missed
2544                                         // the commitment_signed we can re-transmit the update then.
2545                                         true
2546                                 },
2547                         }
2548                 });
2549                 self.next_remote_htlc_id -= inbound_drop_count;
2550
2551                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2552                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2553                                 // They sent us an update to remove this but haven't yet sent the corresponding
2554                                 // commitment_signed, we need to move it back to Committed and they can re-send
2555                                 // the update upon reconnection.
2556                                 htlc.state = OutboundHTLCState::Committed;
2557                         }
2558                 }
2559
2560                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2561                         match htlc_update {
2562                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2563                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2564                                         false
2565                                 },
2566                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2567                         }
2568                 });
2569                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2570                 log_debug!(logger, "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()));
2571                 outbound_drops
2572         }
2573
2574         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2575         /// updates are partially paused.
2576         /// This must be called immediately after the call which generated the ChannelMonitor update
2577         /// which failed. The messages which were generated from that call which generated the
2578         /// monitor update failure must *not* have been sent to the remote end, and must instead
2579         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2580         pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2581                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2582                 self.monitor_pending_revoke_and_ack = resend_raa;
2583                 self.monitor_pending_commitment_signed = resend_commitment;
2584                 assert!(self.monitor_pending_forwards.is_empty());
2585                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2586                 assert!(self.monitor_pending_failures.is_empty());
2587                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2588                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2589         }
2590
2591         /// Indicates that the latest ChannelMonitor update has been committed by the client
2592         /// successfully and we should restore normal operation. Returns messages which should be sent
2593         /// to the remote side.
2594         pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) where L::Target: Logger {
2595                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2596                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2597
2598                 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2599
2600                 // Because we will never generate a FundingBroadcastSafe event when we're in
2601                 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2602                 // they received the FundingBroadcastSafe event, we can only ever hit
2603                 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2604                 // monitor on funding_created, and we even got the funding transaction confirmed before the
2605                 // monitor was persisted.
2606                 let funding_locked = if self.monitor_pending_funding_locked {
2607                         assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2608                         self.monitor_pending_funding_locked = false;
2609                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2610                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2611                         Some(msgs::FundingLocked {
2612                                 channel_id: self.channel_id(),
2613                                 next_per_commitment_point: next_per_commitment_point,
2614                         })
2615                 } else { None };
2616
2617                 let mut forwards = Vec::new();
2618                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2619                 let mut failures = Vec::new();
2620                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2621
2622                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2623                         self.monitor_pending_revoke_and_ack = false;
2624                         self.monitor_pending_commitment_signed = false;
2625                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2626                 }
2627
2628                 let raa = if self.monitor_pending_revoke_and_ack {
2629                         Some(self.get_last_revoke_and_ack())
2630                 } else { None };
2631                 let commitment_update = if self.monitor_pending_commitment_signed {
2632                         Some(self.get_last_commitment_update(logger))
2633                 } else { None };
2634
2635                 self.monitor_pending_revoke_and_ack = false;
2636                 self.monitor_pending_commitment_signed = false;
2637                 let order = self.resend_order.clone();
2638                 log_trace!(logger, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2639                         if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2640                         if commitment_update.is_some() { "a" } else { "no" },
2641                         if raa.is_some() { "an" } else { "no" },
2642                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2643                 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2644         }
2645
2646         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2647                 where F::Target: FeeEstimator
2648         {
2649                 if self.channel_outbound {
2650                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2651                 }
2652                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2653                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2654                 }
2655                 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2656                 self.pending_update_fee = Some(msg.feerate_per_kw);
2657                 self.update_time_counter += 1;
2658                 Ok(())
2659         }
2660
2661         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2662                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2663                 let per_commitment_secret = self.local_keys.commitment_secret(self.cur_local_commitment_transaction_number + 2);
2664                 msgs::RevokeAndACK {
2665                         channel_id: self.channel_id,
2666                         per_commitment_secret,
2667                         next_per_commitment_point,
2668                 }
2669         }
2670
2671         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2672                 let mut update_add_htlcs = Vec::new();
2673                 let mut update_fulfill_htlcs = Vec::new();
2674                 let mut update_fail_htlcs = Vec::new();
2675                 let mut update_fail_malformed_htlcs = Vec::new();
2676
2677                 for htlc in self.pending_outbound_htlcs.iter() {
2678                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2679                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2680                                         channel_id: self.channel_id(),
2681                                         htlc_id: htlc.htlc_id,
2682                                         amount_msat: htlc.amount_msat,
2683                                         payment_hash: htlc.payment_hash,
2684                                         cltv_expiry: htlc.cltv_expiry,
2685                                         onion_routing_packet: (**onion_packet).clone(),
2686                                 });
2687                         }
2688                 }
2689
2690                 for htlc in self.pending_inbound_htlcs.iter() {
2691                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2692                                 match reason {
2693                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2694                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2695                                                         channel_id: self.channel_id(),
2696                                                         htlc_id: htlc.htlc_id,
2697                                                         reason: err_packet.clone()
2698                                                 });
2699                                         },
2700                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2701                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2702                                                         channel_id: self.channel_id(),
2703                                                         htlc_id: htlc.htlc_id,
2704                                                         sha256_of_onion: sha256_of_onion.clone(),
2705                                                         failure_code: failure_code.clone(),
2706                                                 });
2707                                         },
2708                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2709                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2710                                                         channel_id: self.channel_id(),
2711                                                         htlc_id: htlc.htlc_id,
2712                                                         payment_preimage: payment_preimage.clone(),
2713                                                 });
2714                                         },
2715                                 }
2716                         }
2717                 }
2718
2719                 log_trace!(logger, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2720                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2721                 msgs::CommitmentUpdate {
2722                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2723                         update_fee: None,
2724                         commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2725                 }
2726         }
2727
2728         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2729         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2730         pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
2731                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2732                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2733                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2734                         // just close here instead of trying to recover.
2735                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2736                 }
2737
2738                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2739                         msg.next_local_commitment_number == 0 {
2740                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2741                 }
2742
2743                 if msg.next_remote_commitment_number > 0 {
2744                         match msg.data_loss_protect {
2745                                 OptionalField::Present(ref data_loss) => {
2746                                         if self.local_keys.commitment_secret(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1) != data_loss.your_last_per_commitment_secret {
2747                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided"));
2748                                         }
2749                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2750                                                 return Err(ChannelError::CloseDelayBroadcast(
2751                                                         "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting"
2752                                                 ));
2753                                         }
2754                                 },
2755                                 OptionalField::Absent => {}
2756                         }
2757                 }
2758
2759                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2760                 // remaining cases either succeed or ErrorMessage-fail).
2761                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2762
2763                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2764                         Some(msgs::Shutdown {
2765                                 channel_id: self.channel_id,
2766                                 scriptpubkey: self.get_closing_scriptpubkey(),
2767                         })
2768                 } else { None };
2769
2770                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2771                         // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2772                         if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2773                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2774                                 if msg.next_remote_commitment_number != 0 {
2775                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2776                                 }
2777                                 // Short circuit the whole handler as there is nothing we can resend them
2778                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2779                         }
2780
2781                         // We have OurFundingLocked set!
2782                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2783                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2784                         return Ok((Some(msgs::FundingLocked {
2785                                 channel_id: self.channel_id(),
2786                                 next_per_commitment_point: next_per_commitment_point,
2787                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2788                 }
2789
2790                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2791                         // Remote isn't waiting on any RevokeAndACK from us!
2792                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2793                         None
2794                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2795                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2796                                 self.monitor_pending_revoke_and_ack = true;
2797                                 None
2798                         } else {
2799                                 Some(self.get_last_revoke_and_ack())
2800                         }
2801                 } else {
2802                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2803                 };
2804
2805                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2806                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2807                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2808                 // the corresponding revoke_and_ack back yet.
2809                 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 };
2810
2811                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2812                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2813                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2814                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2815                         Some(msgs::FundingLocked {
2816                                 channel_id: self.channel_id(),
2817                                 next_per_commitment_point: next_per_commitment_point,
2818                         })
2819                 } else { None };
2820
2821                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2822                         if required_revoke.is_some() {
2823                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2824                         } else {
2825                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2826                         }
2827
2828                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2829                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2830                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2831                                 // have received some updates while we were disconnected. Free the holding cell
2832                                 // now!
2833                                 match self.free_holding_cell_htlcs(logger) {
2834                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2835                                         Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2836                                         Ok(Some((commitment_update, monitor_update))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg)),
2837                                         Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2838                                 }
2839                         } else {
2840                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2841                         }
2842                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2843                         if required_revoke.is_some() {
2844                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2845                         } else {
2846                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2847                         }
2848
2849                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2850                                 self.monitor_pending_commitment_signed = true;
2851                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2852                         }
2853
2854                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), shutdown_msg));
2855                 } else {
2856                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2857                 }
2858         }
2859
2860         fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2861                 where F::Target: FeeEstimator
2862         {
2863                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2864                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2865                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2866                         return None;
2867                 }
2868
2869                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2870                 if self.feerate_per_kw > proposed_feerate {
2871                         proposed_feerate = self.feerate_per_kw;
2872                 }
2873                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2874                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
2875
2876                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2877                 let our_sig = self.local_keys
2878                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2879                         .ok();
2880                 if our_sig.is_none() { return None; }
2881
2882                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2883                 Some(msgs::ClosingSigned {
2884                         channel_id: self.channel_id,
2885                         fee_satoshis: total_fee_satoshis,
2886                         signature: our_sig.unwrap(),
2887                 })
2888         }
2889
2890         pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2891                 where F::Target: FeeEstimator
2892         {
2893                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2894                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2895                 }
2896                 if self.channel_state < ChannelState::FundingSent as u32 {
2897                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2898                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2899                         // can do that via error message without getting a connection fail anyway...
2900                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2901                 }
2902                 for htlc in self.pending_inbound_htlcs.iter() {
2903                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2904                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2905                         }
2906                 }
2907                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2908
2909                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2910                 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2911                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2912                         return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2913                 }
2914
2915                 //Check shutdown_scriptpubkey form as BOLT says we must
2916                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2917                         return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2918                 }
2919
2920                 if self.their_shutdown_scriptpubkey.is_some() {
2921                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2922                                 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2923                         }
2924                 } else {
2925                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2926                 }
2927
2928                 // From here on out, we may not fail!
2929
2930                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2931                 self.update_time_counter += 1;
2932
2933                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2934                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2935                 // cell HTLCs and return them to fail the payment.
2936                 self.holding_cell_update_fee = None;
2937                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2938                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2939                         match htlc_update {
2940                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2941                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2942                                         false
2943                                 },
2944                                 _ => true
2945                         }
2946                 });
2947                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2948                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2949                 // any further commitment updates after we set LocalShutdownSent.
2950
2951                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2952                         None
2953                 } else {
2954                         Some(msgs::Shutdown {
2955                                 channel_id: self.channel_id,
2956                                 scriptpubkey: self.get_closing_scriptpubkey(),
2957                         })
2958                 };
2959
2960                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2961                 self.update_time_counter += 1;
2962
2963                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2964         }
2965
2966         fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2967                 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2968                 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2969                 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2970
2971                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2972
2973                 let our_funding_key = self.local_keys.pubkeys().funding_pubkey.serialize();
2974                 let their_funding_key = self.their_funding_pubkey().serialize();
2975                 if our_funding_key[..] < their_funding_key[..] {
2976                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2977                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2978                 } else {
2979                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2980                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2981                 }
2982                 tx.input[0].witness[1].push(SigHashType::All as u8);
2983                 tx.input[0].witness[2].push(SigHashType::All as u8);
2984
2985                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2986         }
2987
2988         pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2989                 where F::Target: FeeEstimator
2990         {
2991                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2992                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2993                 }
2994                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2995                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2996                 }
2997                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2998                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2999                 }
3000                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
3001                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
3002                 }
3003
3004                 let funding_redeemscript = self.get_funding_redeemscript();
3005                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3006                 if used_total_fee != msg.fee_satoshis {
3007                         return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
3008                 }
3009                 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
3010
3011                 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
3012
3013                 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
3014                         Ok(_) => {},
3015                         Err(_e) => {
3016                                 // The remote end may have decided to revoke their output due to inconsistent dust
3017                                 // limits, so check for that case by re-checking the signature here.
3018                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3019                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
3020                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer");
3021                         },
3022                 };
3023
3024                 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
3025                         if last_fee == msg.fee_satoshis {
3026                                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
3027                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3028                                 self.update_time_counter += 1;
3029                                 return Ok((None, Some(closing_tx)));
3030                         }
3031                 }
3032
3033                 macro_rules! propose_new_feerate {
3034                         ($new_feerate: expr) => {
3035                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
3036                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * closing_tx_max_weight / 1000, false);
3037                                 let our_sig = self.local_keys
3038                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3039                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
3040                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
3041                                 return Ok((Some(msgs::ClosingSigned {
3042                                         channel_id: self.channel_id,
3043                                         fee_satoshis: used_total_fee,
3044                                         signature: our_sig,
3045                                 }), None))
3046                         }
3047                 }
3048
3049                 let proposed_sat_per_kw = msg.fee_satoshis  * 1000 / closing_tx.get_weight() as u64;
3050                 if self.channel_outbound {
3051                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3052                         if (proposed_sat_per_kw as u32) > our_max_feerate {
3053                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3054                                         if our_max_feerate <= last_feerate {
3055                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
3056                                         }
3057                                 }
3058                                 propose_new_feerate!(our_max_feerate);
3059                         }
3060                 } else {
3061                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3062                         if (proposed_sat_per_kw as u32) < our_min_feerate {
3063                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3064                                         if our_min_feerate >= last_feerate {
3065                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
3066                                         }
3067                                 }
3068                                 propose_new_feerate!(our_min_feerate);
3069                         }
3070                 }
3071
3072                 let our_sig = self.local_keys
3073                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3074                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
3075                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
3076
3077                 self.channel_state = ChannelState::ShutdownComplete as u32;
3078                 self.update_time_counter += 1;
3079
3080                 Ok((Some(msgs::ClosingSigned {
3081                         channel_id: self.channel_id,
3082                         fee_satoshis: msg.fee_satoshis,
3083                         signature: our_sig,
3084                 }), Some(closing_tx)))
3085         }
3086
3087         // Public utilities:
3088
3089         pub fn channel_id(&self) -> [u8; 32] {
3090                 self.channel_id
3091         }
3092
3093         /// Gets the "user_id" value passed into the construction of this channel. It has no special
3094         /// meaning and exists only to allow users to have a persistent identifier of a channel.
3095         pub fn get_user_id(&self) -> u64 {
3096                 self.user_id
3097         }
3098
3099         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
3100         pub fn channel_monitor(&mut self) -> &mut ChannelMonitor<ChanSigner> {
3101                 if self.channel_state < ChannelState::FundingSent as u32 {
3102                         panic!("Can't get a channel monitor until funding has been created");
3103                 }
3104                 self.channel_monitor.as_mut().unwrap()
3105         }
3106
3107         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3108         /// is_usable() returns true).
3109         /// Allowed in any state (including after shutdown)
3110         pub fn get_short_channel_id(&self) -> Option<u64> {
3111                 self.short_channel_id
3112         }
3113
3114         /// Returns the funding_txo we either got from our peer, or were given by
3115         /// get_outbound_funding_created.
3116         pub fn get_funding_txo(&self) -> Option<OutPoint> {
3117                 self.funding_txo
3118         }
3119
3120         /// Allowed in any state (including after shutdown)
3121         pub fn get_their_node_id(&self) -> PublicKey {
3122                 self.their_node_id
3123         }
3124
3125         /// Allowed in any state (including after shutdown)
3126         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
3127                 self.our_htlc_minimum_msat
3128         }
3129
3130         /// Allowed in any state (including after shutdown)
3131         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
3132                 self.our_htlc_minimum_msat
3133         }
3134
3135         pub fn get_value_satoshis(&self) -> u64 {
3136                 self.channel_value_satoshis
3137         }
3138
3139         pub fn get_fee_proportional_millionths(&self) -> u32 {
3140                 self.config.fee_proportional_millionths
3141         }
3142
3143         #[cfg(test)]
3144         pub fn get_feerate(&self) -> u32 {
3145                 self.feerate_per_kw
3146         }
3147
3148         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
3149                 self.cur_local_commitment_transaction_number + 1
3150         }
3151
3152         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
3153                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3154         }
3155
3156         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
3157                 self.cur_remote_commitment_transaction_number + 2
3158         }
3159
3160         #[cfg(test)]
3161         pub fn get_local_keys(&self) -> &ChanSigner {
3162                 &self.local_keys
3163         }
3164
3165         #[cfg(test)]
3166         pub fn get_value_stat(&self) -> ChannelValueStat {
3167                 ChannelValueStat {
3168                         value_to_self_msat: self.value_to_self_msat,
3169                         channel_value_msat: self.channel_value_satoshis * 1000,
3170                         channel_reserve_msat: self.local_channel_reserve_satoshis * 1000,
3171                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3172                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3173                         holding_cell_outbound_amount_msat: {
3174                                 let mut res = 0;
3175                                 for h in self.holding_cell_htlc_updates.iter() {
3176                                         match h {
3177                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3178                                                         res += amount_msat;
3179                                                 }
3180                                                 _ => {}
3181                                         }
3182                                 }
3183                                 res
3184                         },
3185                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3186                         their_dust_limit_msat: self.their_dust_limit_satoshis * 1000,
3187                 }
3188         }
3189
3190         /// Allowed in any state (including after shutdown)
3191         pub fn get_update_time_counter(&self) -> u32 {
3192                 self.update_time_counter
3193         }
3194
3195         pub fn get_latest_monitor_update_id(&self) -> u64 {
3196                 self.latest_monitor_update_id
3197         }
3198
3199         pub fn should_announce(&self) -> bool {
3200                 self.config.announced_channel
3201         }
3202
3203         pub fn is_outbound(&self) -> bool {
3204                 self.channel_outbound
3205         }
3206
3207         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3208         /// Allowed in any state (including after shutdown)
3209         pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3210                 where F::Target: FeeEstimator
3211         {
3212                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3213                 // output value back into a transaction with the regular channel output:
3214
3215                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3216                 let mut res = self.feerate_per_kw as u64 * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3217
3218                 if self.channel_outbound {
3219                         // + the marginal fee increase cost to us in the commitment transaction:
3220                         res += self.feerate_per_kw as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3221                 }
3222
3223                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3224                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as u64 * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3225
3226                 res as u32
3227         }
3228
3229         /// Returns true if we've ever received a message from the remote end for this Channel
3230         pub fn have_received_message(&self) -> bool {
3231                 self.channel_state > (ChannelState::OurInitSent as u32)
3232         }
3233
3234         /// Returns true if this channel is fully established and not known to be closing.
3235         /// Allowed in any state (including after shutdown)
3236         pub fn is_usable(&self) -> bool {
3237                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3238                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3239         }
3240
3241         /// Returns true if this channel is currently available for use. This is a superset of
3242         /// is_usable() and considers things like the channel being temporarily disabled.
3243         /// Allowed in any state (including after shutdown)
3244         pub fn is_live(&self) -> bool {
3245                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3246         }
3247
3248         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3249         /// Allowed in any state (including after shutdown)
3250         pub fn is_awaiting_monitor_update(&self) -> bool {
3251                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3252         }
3253
3254         /// Returns true if funding_created was sent/received.
3255         pub fn is_funding_initiated(&self) -> bool {
3256                 self.channel_state >= ChannelState::FundingSent as u32
3257         }
3258
3259         /// Returns true if this channel is fully shut down. True here implies that no further actions
3260         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3261         /// will be handled appropriately by the chain monitor.
3262         pub fn is_shutdown(&self) -> bool {
3263                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
3264                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3265                         true
3266                 } else { false }
3267         }
3268
3269         pub fn to_disabled_staged(&mut self) {
3270                 self.network_sync = UpdateStatus::DisabledStaged;
3271         }
3272
3273         pub fn to_disabled_marked(&mut self) {
3274                 self.network_sync = UpdateStatus::DisabledMarked;
3275         }
3276
3277         pub fn to_fresh(&mut self) {
3278                 self.network_sync = UpdateStatus::Fresh;
3279         }
3280
3281         pub fn is_disabled_staged(&self) -> bool {
3282                 self.network_sync == UpdateStatus::DisabledStaged
3283         }
3284
3285         pub fn is_disabled_marked(&self) -> bool {
3286                 self.network_sync == UpdateStatus::DisabledMarked
3287         }
3288
3289         /// When we receive a new block, we (a) check whether the block contains the funding
3290         /// transaction (which would start us counting blocks until we send the funding_signed), and
3291         /// (b) check the height of the block against outbound holding cell HTLCs in case we need to
3292         /// give up on them prematurely and time them out. Everything else (e.g. commitment
3293         /// transaction broadcasts, channel closure detection, HTLC transaction broadcasting, etc) is
3294         /// handled by the ChannelMonitor.
3295         ///
3296         /// If we return Err, the channel may have been closed, at which point the standard
3297         /// requirements apply - no calls may be made except those explicitly stated to be allowed
3298         /// post-shutdown.
3299         /// Only returns an ErrorAction of DisconnectPeer, if Err.
3300         ///
3301         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3302         /// back.
3303         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[usize]) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
3304                 let mut timed_out_htlcs = Vec::new();
3305                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3306                         match htlc_update {
3307                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3308                                         if *cltv_expiry <= height + HTLC_FAIL_BACK_BUFFER {
3309                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3310                                                 false
3311                                         } else { true }
3312                                 },
3313                                 _ => true
3314                         }
3315                 });
3316                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3317                 if header.bitcoin_hash() != self.last_block_connected {
3318                         if self.funding_tx_confirmations > 0 {
3319                                 self.funding_tx_confirmations += 1;
3320                         }
3321                 }
3322                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3323                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3324                                 if tx.txid() == self.funding_txo.unwrap().txid {
3325                                         let txo_idx = self.funding_txo.unwrap().index as usize;
3326                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3327                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
3328                                                 if self.channel_outbound {
3329                                                         // If we generated the funding transaction and it doesn't match what it
3330                                                         // should, the client is really broken and we should just panic and
3331                                                         // tell them off. That said, because hash collisions happen with high
3332                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
3333                                                         // channel and move on.
3334                                                         #[cfg(not(feature = "fuzztarget"))]
3335                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3336                                                 }
3337                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3338                                                 self.update_time_counter += 1;
3339                                                 return Err(msgs::ErrorMessage {
3340                                                         channel_id: self.channel_id(),
3341                                                         data: "funding tx had wrong script/value".to_owned()
3342                                                 });
3343                                         } else {
3344                                                 if self.channel_outbound {
3345                                                         for input in tx.input.iter() {
3346                                                                 if input.witness.is_empty() {
3347                                                                         // We generated a malleable funding transaction, implying we've
3348                                                                         // just exposed ourselves to funds loss to our counterparty.
3349                                                                         #[cfg(not(feature = "fuzztarget"))]
3350                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3351                                                                 }
3352                                                         }
3353                                                 }
3354                                                 if height > 0xff_ff_ff || (*index_in_block) > 0xff_ff_ff {
3355                                                         panic!("Block was bogus - either height 16 million or had > 16 million transactions");
3356                                                 }
3357                                                 assert!(txo_idx <= 0xffff); // txo_idx is a (u16 as usize), so this is just listed here for completeness
3358                                                 self.funding_tx_confirmations = 1;
3359                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
3360                                                                              ((*index_in_block as u64) << (2*8)) |
3361                                                                              ((txo_idx as u64)         << (0*8)));
3362                                         }
3363                                 }
3364                         }
3365                 }
3366                 if header.bitcoin_hash() != self.last_block_connected {
3367                         self.last_block_connected = header.bitcoin_hash();
3368                         self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3369                         if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3370                                 channel_monitor.last_block_hash = self.last_block_connected;
3371                         }
3372                         if self.funding_tx_confirmations > 0 {
3373                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3374                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3375                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
3376                                                 true
3377                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3378                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3379                                                 self.update_time_counter += 1;
3380                                                 true
3381                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3382                                                 // We got a reorg but not enough to trigger a force close, just update
3383                                                 // funding_tx_confirmed_in and return.
3384                                                 false
3385                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3386                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3387                                         } else {
3388                                                 // We got a reorg but not enough to trigger a force close, just update
3389                                                 // funding_tx_confirmed_in and return.
3390                                                 false
3391                                         };
3392                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3393
3394                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3395                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3396                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3397                                         //a protocol oversight, but I assume I'm just missing something.
3398                                         if need_commitment_update {
3399                                                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3400                                                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3401                                                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
3402                                                         return Ok((Some(msgs::FundingLocked {
3403                                                                 channel_id: self.channel_id,
3404                                                                 next_per_commitment_point: next_per_commitment_point,
3405                                                         }), timed_out_htlcs));
3406                                                 } else {
3407                                                         self.monitor_pending_funding_locked = true;
3408                                                         return Ok((None, timed_out_htlcs));
3409                                                 }
3410                                         }
3411                                 }
3412                         }
3413                 }
3414                 Ok((None, timed_out_htlcs))
3415         }
3416
3417         /// Called by channelmanager based on chain blocks being disconnected.
3418         /// Returns true if we need to close the channel now due to funding transaction
3419         /// unconfirmation/reorg.
3420         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3421                 if self.funding_tx_confirmations > 0 {
3422                         self.funding_tx_confirmations -= 1;
3423                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3424                                 return true;
3425                         }
3426                 }
3427                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3428                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3429                 }
3430                 self.last_block_connected = header.bitcoin_hash();
3431                 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3432                         channel_monitor.last_block_hash = self.last_block_connected;
3433                 }
3434                 false
3435         }
3436
3437         // Methods to get unprompted messages to send to the remote end (or where we already returned
3438         // something in the handler for the message that prompted this message):
3439
3440         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3441                 if !self.channel_outbound {
3442                         panic!("Tried to open a channel for an inbound channel?");
3443                 }
3444                 if self.channel_state != ChannelState::OurInitSent as u32 {
3445                         panic!("Cannot generate an open_channel after we've moved forward");
3446                 }
3447
3448                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3449                         panic!("Tried to send an open_channel for a channel that has already advanced");
3450                 }
3451
3452                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3453                 let local_keys = self.local_keys.pubkeys();
3454
3455                 msgs::OpenChannel {
3456                         chain_hash: chain_hash,
3457                         temporary_channel_id: self.channel_id,
3458                         funding_satoshis: self.channel_value_satoshis,
3459                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3460                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3461                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3462                         channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3463                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3464                         feerate_per_kw: self.feerate_per_kw as u32,
3465                         to_self_delay: self.our_to_self_delay,
3466                         max_accepted_htlcs: OUR_MAX_HTLCS,
3467                         funding_pubkey: local_keys.funding_pubkey,
3468                         revocation_basepoint: local_keys.revocation_basepoint,
3469                         payment_point: local_keys.payment_point,
3470                         delayed_payment_basepoint: local_keys.delayed_payment_basepoint,
3471                         htlc_basepoint: local_keys.htlc_basepoint,
3472                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3473                         channel_flags: if self.config.announced_channel {1} else {0},
3474                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3475                 }
3476         }
3477
3478         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3479                 if self.channel_outbound {
3480                         panic!("Tried to send accept_channel for an outbound channel?");
3481                 }
3482                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3483                         panic!("Tried to send accept_channel after channel had moved forward");
3484                 }
3485                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3486                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3487                 }
3488
3489                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3490                 let local_keys = self.local_keys.pubkeys();
3491
3492                 msgs::AcceptChannel {
3493                         temporary_channel_id: self.channel_id,
3494                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3495                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3496                         channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3497                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3498                         minimum_depth: self.minimum_depth,
3499                         to_self_delay: self.our_to_self_delay,
3500                         max_accepted_htlcs: OUR_MAX_HTLCS,
3501                         funding_pubkey: local_keys.funding_pubkey,
3502                         revocation_basepoint: local_keys.revocation_basepoint,
3503                         payment_point: local_keys.payment_point,
3504                         delayed_payment_basepoint: local_keys.delayed_payment_basepoint,
3505                         htlc_basepoint: local_keys.htlc_basepoint,
3506                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3507                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3508                 }
3509         }
3510
3511         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3512         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3513                 let remote_keys = self.build_remote_transaction_keys()?;
3514                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
3515                 Ok(self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &remote_keys, &Vec::new(), self.our_to_self_delay, &self.secp_ctx)
3516                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0)
3517         }
3518
3519         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3520         /// a funding_created message for the remote peer.
3521         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3522         /// or if called on an inbound channel.
3523         /// Note that channel_id changes during this call!
3524         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3525         /// If an Err is returned, it is a ChannelError::Close.
3526         pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
3527                 if !self.channel_outbound {
3528                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3529                 }
3530                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3531                         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)");
3532                 }
3533                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3534                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3535                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3536                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3537                 }
3538
3539                 self.funding_txo = Some(funding_txo.clone());
3540                 let our_signature = match self.get_outbound_funding_created_signature(logger) {
3541                         Ok(res) => res,
3542                         Err(e) => {
3543                                 log_error!(logger, "Got bad signatures: {:?}!", e);
3544                                 self.funding_txo = None;
3545                                 return Err(e);
3546                         }
3547                 };
3548
3549                 let temporary_channel_id = self.channel_id;
3550
3551                 // Now that we're past error-generating stuff, update our local state:
3552
3553                 self.channel_state = ChannelState::FundingCreated as u32;
3554                 self.channel_id = funding_txo.to_channel_id();
3555
3556                 Ok(msgs::FundingCreated {
3557                         temporary_channel_id,
3558                         funding_txid: funding_txo.txid,
3559                         funding_output_index: funding_txo.index,
3560                         signature: our_signature
3561                 })
3562         }
3563
3564         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3565         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3566         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3567         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3568         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3569         /// closing).
3570         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3571         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3572         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3573                 if !self.config.announced_channel {
3574                         return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3575                 }
3576                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3577                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3578                 }
3579                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3580                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3581                 }
3582
3583                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3584
3585                 let msg = msgs::UnsignedChannelAnnouncement {
3586                         features: ChannelFeatures::known(),
3587                         chain_hash: chain_hash,
3588                         short_channel_id: self.get_short_channel_id().unwrap(),
3589                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3590                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3591                         bitcoin_key_1: if were_node_one { self.local_keys.pubkeys().funding_pubkey } else { self.their_funding_pubkey().clone() },
3592                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { self.local_keys.pubkeys().funding_pubkey },
3593                         excess_data: Vec::new(),
3594                 };
3595
3596                 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3597                         .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement"))?;
3598
3599                 Ok((msg, sig))
3600         }
3601
3602         /// May panic if called on a channel that wasn't immediately-previously
3603         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3604         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3605                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3606                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3607                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3608                 // current to_remote balances. However, it no longer has any use, and thus is now simply
3609                 // set to a dummy (but valid, as required by the spec) public key.
3610                 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3611                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3612                 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3613                 let mut pk = [2; 33]; pk[1] = 0xff;
3614                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3615                 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3616                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3617                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3618                         OptionalField::Present(DataLossProtect {
3619                                 your_last_per_commitment_secret: remote_last_secret,
3620                                 my_current_per_commitment_point: dummy_pubkey
3621                         })
3622                 } else {
3623                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3624                         OptionalField::Present(DataLossProtect {
3625                                 your_last_per_commitment_secret: [0;32],
3626                                 my_current_per_commitment_point: dummy_pubkey,
3627                         })
3628                 };
3629                 msgs::ChannelReestablish {
3630                         channel_id: self.channel_id(),
3631                         // The protocol has two different commitment number concepts - the "commitment
3632                         // transaction number", which starts from 0 and counts up, and the "revocation key
3633                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3634                         // commitment transaction numbers by the index which will be used to reveal the
3635                         // revocation key for that commitment transaction, which means we have to convert them
3636                         // to protocol-level commitment numbers here...
3637
3638                         // next_local_commitment_number is the next commitment_signed number we expect to
3639                         // receive (indicating if they need to resend one that we missed).
3640                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3641                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3642                         // receive, however we track it by the next commitment number for a remote transaction
3643                         // (which is one further, as they always revoke previous commitment transaction, not
3644                         // the one we send) so we have to decrement by 1. Note that if
3645                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3646                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3647                         // overflow here.
3648                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3649                         data_loss_protect,
3650                 }
3651         }
3652
3653
3654         // Send stuff to our remote peers:
3655
3656         /// Adds a pending outbound HTLC to this channel, note that you probably want
3657         /// send_htlc_and_commit instead cause you'll want both messages at once.
3658         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3659         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3660         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3661         /// You MUST call send_commitment prior to any other calls on this Channel
3662         /// If an Err is returned, it's a ChannelError::Ignore!
3663         pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
3664                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3665                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3666                 }
3667
3668                 if amount_msat > self.channel_value_satoshis * 1000 {
3669                         return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3670                 }
3671
3672                 if amount_msat == 0 {
3673                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC"));
3674                 }
3675
3676                 if amount_msat < self.their_htlc_minimum_msat {
3677                         return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3678                 }
3679
3680                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3681                         // Note that this should never really happen, if we're !is_live() on receipt of an
3682                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3683                         // the user to send directly into a !is_live() channel. However, if we
3684                         // disconnected during the time the previous hop was doing the commitment dance we may
3685                         // end up getting here after the forwarding delay. In any case, returning an
3686                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3687                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3688                 }
3689
3690                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3691                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3692                         return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3693                 }
3694                 // Check their_max_htlc_value_in_flight_msat
3695                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3696                         return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
3697                 }
3698
3699                 if !self.channel_outbound {
3700                         // Check that we won't violate the remote channel reserve by adding this HTLC.
3701
3702                         let remote_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
3703                         let remote_chan_reserve_msat = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
3704                         // 1 additional HTLC corresponding to this HTLC.
3705                         let remote_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(1);
3706                         if remote_balance_msat < remote_chan_reserve_msat + remote_commit_tx_fee_msat {
3707                                 return Err(ChannelError::Ignore("Cannot send value that would put them under remote channel reserve value"));
3708                         }
3709                 }
3710
3711                 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
3712                 if pending_value_to_self_msat < amount_msat {
3713                         return Err(ChannelError::Ignore("Cannot send value that would overdraw remaining funds"));
3714                 }
3715
3716                 // The `+1` is for the HTLC currently being added to the commitment tx and
3717                 // the `2 *` and `+1` are for the fee spike buffer.
3718                 let local_commit_tx_fee_msat = if self.channel_outbound {
3719                         2 * self.next_local_commit_tx_fee_msat(1 + 1)
3720                 } else { 0 };
3721                 if pending_value_to_self_msat - amount_msat < local_commit_tx_fee_msat {
3722                         return Err(ChannelError::Ignore("Cannot send value that would not leave enough to pay for fees"));
3723                 }
3724
3725                 // Check self.local_channel_reserve_satoshis (the amount we must keep as
3726                 // reserve for the remote to have something to claim if we misbehave)
3727                 let chan_reserve_msat = self.local_channel_reserve_satoshis * 1000;
3728                 if pending_value_to_self_msat - amount_msat - local_commit_tx_fee_msat < chan_reserve_msat {
3729                         return Err(ChannelError::Ignore("Cannot send value that would put us under local channel reserve value"));
3730                 }
3731
3732                 // Now update local state:
3733                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3734                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3735                                 amount_msat,
3736                                 payment_hash,
3737                                 cltv_expiry,
3738                                 source,
3739                                 onion_routing_packet,
3740                         });
3741                         return Ok(None);
3742                 }
3743
3744                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3745                         htlc_id: self.next_local_htlc_id,
3746                         amount_msat,
3747                         payment_hash: payment_hash.clone(),
3748                         cltv_expiry,
3749                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3750                         source,
3751                 });
3752
3753                 let res = msgs::UpdateAddHTLC {
3754                         channel_id: self.channel_id,
3755                         htlc_id: self.next_local_htlc_id,
3756                         amount_msat,
3757                         payment_hash,
3758                         cltv_expiry,
3759                         onion_routing_packet,
3760                 };
3761                 self.next_local_htlc_id += 1;
3762
3763                 Ok(Some(res))
3764         }
3765
3766         /// Creates a signed commitment transaction to send to the remote peer.
3767         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3768         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3769         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3770         pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3771                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3772                         panic!("Cannot create commitment tx until channel is fully established");
3773                 }
3774                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3775                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3776                 }
3777                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3778                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3779                 }
3780                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3781                         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");
3782                 }
3783                 let mut have_updates = self.pending_update_fee.is_some();
3784                 for htlc in self.pending_outbound_htlcs.iter() {
3785                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3786                                 have_updates = true;
3787                         }
3788                         if have_updates { break; }
3789                 }
3790                 for htlc in self.pending_inbound_htlcs.iter() {
3791                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3792                                 have_updates = true;
3793                         }
3794                         if have_updates { break; }
3795                 }
3796                 if !have_updates {
3797                         panic!("Cannot create commitment tx until we have some updates to send");
3798                 }
3799                 self.send_commitment_no_status_check(logger)
3800         }
3801         /// Only fails in case of bad keys
3802         fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3803                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3804                 // fail to generate this, we still are at least at a position where upgrading their status
3805                 // is acceptable.
3806                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3807                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3808                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3809                         } else { None };
3810                         if let Some(state) = new_state {
3811                                 htlc.state = state;
3812                         }
3813                 }
3814                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3815                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3816                                 Some(fail_reason.take())
3817                         } else { None } {
3818                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3819                         }
3820                 }
3821                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3822
3823                 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update(logger) {
3824                         Ok((res, (remote_commitment_tx, mut htlcs))) => {
3825                                 // Update state now that we've passed all the can-fail calls...
3826                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3827                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3828                                 (res, remote_commitment_tx, htlcs_no_ref)
3829                         },
3830                         Err(e) => return Err(e),
3831                 };
3832
3833                 self.latest_monitor_update_id += 1;
3834                 let monitor_update = ChannelMonitorUpdate {
3835                         update_id: self.latest_monitor_update_id,
3836                         updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3837                                 unsigned_commitment_tx: remote_commitment_tx.clone(),
3838                                 htlc_outputs: htlcs.clone(),
3839                                 commitment_number: self.cur_remote_commitment_transaction_number,
3840                                 their_revocation_point: self.their_cur_commitment_point.unwrap()
3841                         }]
3842                 };
3843                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone(), logger).unwrap();
3844                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3845                 Ok((res, monitor_update))
3846         }
3847
3848         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3849         /// when we shouldn't change HTLC/channel state.
3850         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
3851                 let mut feerate_per_kw = self.feerate_per_kw;
3852                 if let Some(feerate) = self.pending_update_fee {
3853                         if self.channel_outbound {
3854                                 feerate_per_kw = feerate;
3855                         }
3856                 }
3857
3858                 let remote_keys = self.build_remote_transaction_keys()?;
3859                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw, logger);
3860                 let (signature, htlc_signatures);
3861
3862                 {
3863                         let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3864                         for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3865                                 htlcs.push(htlc);
3866                         }
3867
3868                         let res = self.local_keys.sign_remote_commitment(feerate_per_kw, &remote_commitment_tx.0, &remote_keys, &htlcs, self.our_to_self_delay, &self.secp_ctx)
3869                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?;
3870                         signature = res.0;
3871                         htlc_signatures = res.1;
3872
3873                         log_trace!(logger, "Signed remote commitment tx {} with redeemscript {} -> {}",
3874                                 encode::serialize_hex(&remote_commitment_tx.0),
3875                                 encode::serialize_hex(&self.get_funding_redeemscript()),
3876                                 log_bytes!(signature.serialize_compact()[..]));
3877
3878                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3879                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3880                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&remote_commitment_tx.0.txid(), feerate_per_kw, self.our_to_self_delay, htlc, &remote_keys.a_delayed_payment_key, &remote_keys.revocation_key)),
3881                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &remote_keys)),
3882                                         log_bytes!(remote_keys.a_htlc_key.serialize()),
3883                                         log_bytes!(htlc_sig.serialize_compact()[..]));
3884                         }
3885                 }
3886
3887                 Ok((msgs::CommitmentSigned {
3888                         channel_id: self.channel_id,
3889                         signature,
3890                         htlc_signatures,
3891                 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3892         }
3893
3894         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3895         /// to send to the remote peer in one go.
3896         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3897         /// more info.
3898         pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
3899                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3900                         Some(update_add_htlc) => {
3901                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
3902                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3903                         },
3904                         None => Ok(None)
3905                 }
3906         }
3907
3908         /// Begins the shutdown process, getting a message for the remote peer and returning all
3909         /// holding cell HTLCs for payment failure.
3910         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3911                 for htlc in self.pending_outbound_htlcs.iter() {
3912                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3913                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3914                         }
3915                 }
3916                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3917                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3918                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3919                         }
3920                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3921                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3922                         }
3923                 }
3924                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3925                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3926                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3927                 }
3928
3929                 let our_closing_script = self.get_closing_scriptpubkey();
3930
3931                 // From here on out, we may not fail!
3932                 if self.channel_state < ChannelState::FundingSent as u32 {
3933                         self.channel_state = ChannelState::ShutdownComplete as u32;
3934                 } else {
3935                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3936                 }
3937                 self.update_time_counter += 1;
3938
3939                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3940                 // our shutdown until we've committed all of the pending changes.
3941                 self.holding_cell_update_fee = None;
3942                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3943                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3944                         match htlc_update {
3945                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3946                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3947                                         false
3948                                 },
3949                                 _ => true
3950                         }
3951                 });
3952
3953                 Ok((msgs::Shutdown {
3954                         channel_id: self.channel_id,
3955                         scriptpubkey: our_closing_script,
3956                 }, dropped_outbound_htlcs))
3957         }
3958
3959         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3960         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3961         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3962         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3963         /// immediately (others we will have to allow to time out).
3964         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>) {
3965                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3966
3967                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3968                 // return them to fail the payment.
3969                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3970                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3971                         match htlc_update {
3972                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3973                                         dropped_outbound_htlcs.push((source, payment_hash));
3974                                 },
3975                                 _ => {}
3976                         }
3977                 }
3978
3979                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3980                         //TODO: Do something with the remaining HTLCs
3981                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3982                         //which correspond)
3983                 }
3984
3985                 self.channel_state = ChannelState::ShutdownComplete as u32;
3986                 self.update_time_counter += 1;
3987                 self.latest_monitor_update_id += 1;
3988                 (self.funding_txo.clone(), ChannelMonitorUpdate {
3989                         update_id: self.latest_monitor_update_id,
3990                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3991                 }, dropped_outbound_htlcs)
3992         }
3993 }
3994
3995 const SERIALIZATION_VERSION: u8 = 1;
3996 const MIN_SERIALIZATION_VERSION: u8 = 1;
3997
3998 impl Writeable for InboundHTLCRemovalReason {
3999         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4000                 match self {
4001                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
4002                                 0u8.write(writer)?;
4003                                 error_packet.write(writer)?;
4004                         },
4005                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
4006                                 1u8.write(writer)?;
4007                                 onion_hash.write(writer)?;
4008                                 err_code.write(writer)?;
4009                         },
4010                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
4011                                 2u8.write(writer)?;
4012                                 payment_preimage.write(writer)?;
4013                         },
4014                 }
4015                 Ok(())
4016         }
4017 }
4018
4019 impl Readable for InboundHTLCRemovalReason {
4020         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4021                 Ok(match <u8 as Readable>::read(reader)? {
4022                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
4023                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
4024                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
4025                         _ => return Err(DecodeError::InvalidValue),
4026                 })
4027         }
4028 }
4029
4030 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
4031         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4032                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4033                 // called but include holding cell updates (and obviously we don't modify self).
4034
4035                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4036                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4037
4038                 self.user_id.write(writer)?;
4039                 self.config.write(writer)?;
4040
4041                 self.channel_id.write(writer)?;
4042                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4043                 self.channel_outbound.write(writer)?;
4044                 self.channel_value_satoshis.write(writer)?;
4045
4046                 self.latest_monitor_update_id.write(writer)?;
4047
4048                 self.local_keys.write(writer)?;
4049                 self.shutdown_pubkey.write(writer)?;
4050                 self.destination_script.write(writer)?;
4051
4052                 self.cur_local_commitment_transaction_number.write(writer)?;
4053                 self.cur_remote_commitment_transaction_number.write(writer)?;
4054                 self.value_to_self_msat.write(writer)?;
4055
4056                 let mut dropped_inbound_htlcs = 0;
4057                 for htlc in self.pending_inbound_htlcs.iter() {
4058                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4059                                 dropped_inbound_htlcs += 1;
4060                         }
4061                 }
4062                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4063                 for htlc in self.pending_inbound_htlcs.iter() {
4064                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4065                                 continue; // Drop
4066                         }
4067                         htlc.htlc_id.write(writer)?;
4068                         htlc.amount_msat.write(writer)?;
4069                         htlc.cltv_expiry.write(writer)?;
4070                         htlc.payment_hash.write(writer)?;
4071                         match &htlc.state {
4072                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4073                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4074                                         1u8.write(writer)?;
4075                                         htlc_state.write(writer)?;
4076                                 },
4077                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4078                                         2u8.write(writer)?;
4079                                         htlc_state.write(writer)?;
4080                                 },
4081                                 &InboundHTLCState::Committed => {
4082                                         3u8.write(writer)?;
4083                                 },
4084                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4085                                         4u8.write(writer)?;
4086                                         removal_reason.write(writer)?;
4087                                 },
4088                         }
4089                 }
4090
4091                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4092                 for htlc in self.pending_outbound_htlcs.iter() {
4093                         htlc.htlc_id.write(writer)?;
4094                         htlc.amount_msat.write(writer)?;
4095                         htlc.cltv_expiry.write(writer)?;
4096                         htlc.payment_hash.write(writer)?;
4097                         htlc.source.write(writer)?;
4098                         match &htlc.state {
4099                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4100                                         0u8.write(writer)?;
4101                                         onion_packet.write(writer)?;
4102                                 },
4103                                 &OutboundHTLCState::Committed => {
4104                                         1u8.write(writer)?;
4105                                 },
4106                                 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
4107                                         2u8.write(writer)?;
4108                                         fail_reason.write(writer)?;
4109                                 },
4110                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4111                                         3u8.write(writer)?;
4112                                         fail_reason.write(writer)?;
4113                                 },
4114                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4115                                         4u8.write(writer)?;
4116                                         fail_reason.write(writer)?;
4117                                 },
4118                         }
4119                 }
4120
4121                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4122                 for update in self.holding_cell_htlc_updates.iter() {
4123                         match update {
4124                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4125                                         0u8.write(writer)?;
4126                                         amount_msat.write(writer)?;
4127                                         cltv_expiry.write(writer)?;
4128                                         payment_hash.write(writer)?;
4129                                         source.write(writer)?;
4130                                         onion_routing_packet.write(writer)?;
4131                                 },
4132                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4133                                         1u8.write(writer)?;
4134                                         payment_preimage.write(writer)?;
4135                                         htlc_id.write(writer)?;
4136                                 },
4137                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4138                                         2u8.write(writer)?;
4139                                         htlc_id.write(writer)?;
4140                                         err_packet.write(writer)?;
4141                                 }
4142                         }
4143                 }
4144
4145                 match self.resend_order {
4146                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4147                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4148                 }
4149
4150                 self.monitor_pending_funding_locked.write(writer)?;
4151                 self.monitor_pending_revoke_and_ack.write(writer)?;
4152                 self.monitor_pending_commitment_signed.write(writer)?;
4153
4154                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4155                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4156                         pending_forward.write(writer)?;
4157                         htlc_id.write(writer)?;
4158                 }
4159
4160                 (self.monitor_pending_failures.len() as u64).write(writer)?;
4161                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4162                         htlc_source.write(writer)?;
4163                         payment_hash.write(writer)?;
4164                         fail_reason.write(writer)?;
4165                 }
4166
4167                 self.pending_update_fee.write(writer)?;
4168                 self.holding_cell_update_fee.write(writer)?;
4169
4170                 self.next_local_htlc_id.write(writer)?;
4171                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
4172                 self.update_time_counter.write(writer)?;
4173                 self.feerate_per_kw.write(writer)?;
4174
4175                 match self.last_sent_closing_fee {
4176                         Some((feerate, fee, sig)) => {
4177                                 1u8.write(writer)?;
4178                                 feerate.write(writer)?;
4179                                 fee.write(writer)?;
4180                                 sig.write(writer)?;
4181                         },
4182                         None => 0u8.write(writer)?,
4183                 }
4184
4185                 self.funding_txo.write(writer)?;
4186                 self.funding_tx_confirmed_in.write(writer)?;
4187                 self.short_channel_id.write(writer)?;
4188
4189                 self.last_block_connected.write(writer)?;
4190                 self.funding_tx_confirmations.write(writer)?;
4191
4192                 self.their_dust_limit_satoshis.write(writer)?;
4193                 self.our_dust_limit_satoshis.write(writer)?;
4194                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4195                 self.local_channel_reserve_satoshis.write(writer)?;
4196                 self.their_htlc_minimum_msat.write(writer)?;
4197                 self.our_htlc_minimum_msat.write(writer)?;
4198                 self.their_to_self_delay.write(writer)?;
4199                 self.our_to_self_delay.write(writer)?;
4200                 self.their_max_accepted_htlcs.write(writer)?;
4201                 self.minimum_depth.write(writer)?;
4202
4203                 self.their_pubkeys.write(writer)?;
4204                 self.their_cur_commitment_point.write(writer)?;
4205
4206                 self.their_prev_commitment_point.write(writer)?;
4207                 self.their_node_id.write(writer)?;
4208
4209                 self.their_shutdown_scriptpubkey.write(writer)?;
4210
4211                 self.commitment_secrets.write(writer)?;
4212
4213                 self.channel_monitor.as_ref().unwrap().write_for_disk(writer)?;
4214                 Ok(())
4215         }
4216 }
4217
4218 impl<ChanSigner: ChannelKeys + Readable> Readable for Channel<ChanSigner> {
4219         fn read<R : ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4220                 let _ver: u8 = Readable::read(reader)?;
4221                 let min_ver: u8 = Readable::read(reader)?;
4222                 if min_ver > SERIALIZATION_VERSION {
4223                         return Err(DecodeError::UnknownVersion);
4224                 }
4225
4226                 let user_id = Readable::read(reader)?;
4227                 let config: ChannelConfig = Readable::read(reader)?;
4228
4229                 let channel_id = Readable::read(reader)?;
4230                 let channel_state = Readable::read(reader)?;
4231                 let channel_outbound = Readable::read(reader)?;
4232                 let channel_value_satoshis = Readable::read(reader)?;
4233
4234                 let latest_monitor_update_id = Readable::read(reader)?;
4235
4236                 let local_keys = Readable::read(reader)?;
4237                 let shutdown_pubkey = Readable::read(reader)?;
4238                 let destination_script = Readable::read(reader)?;
4239
4240                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4241                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4242                 let value_to_self_msat = Readable::read(reader)?;
4243
4244                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4245                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4246                 for _ in 0..pending_inbound_htlc_count {
4247                         pending_inbound_htlcs.push(InboundHTLCOutput {
4248                                 htlc_id: Readable::read(reader)?,
4249                                 amount_msat: Readable::read(reader)?,
4250                                 cltv_expiry: Readable::read(reader)?,
4251                                 payment_hash: Readable::read(reader)?,
4252                                 state: match <u8 as Readable>::read(reader)? {
4253                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4254                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4255                                         3 => InboundHTLCState::Committed,
4256                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4257                                         _ => return Err(DecodeError::InvalidValue),
4258                                 },
4259                         });
4260                 }
4261
4262                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4263                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4264                 for _ in 0..pending_outbound_htlc_count {
4265                         pending_outbound_htlcs.push(OutboundHTLCOutput {
4266                                 htlc_id: Readable::read(reader)?,
4267                                 amount_msat: Readable::read(reader)?,
4268                                 cltv_expiry: Readable::read(reader)?,
4269                                 payment_hash: Readable::read(reader)?,
4270                                 source: Readable::read(reader)?,
4271                                 state: match <u8 as Readable>::read(reader)? {
4272                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4273                                         1 => OutboundHTLCState::Committed,
4274                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4275                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4276                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4277                                         _ => return Err(DecodeError::InvalidValue),
4278                                 },
4279                         });
4280                 }
4281
4282                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4283                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4284                 for _ in 0..holding_cell_htlc_update_count {
4285                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4286                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
4287                                         amount_msat: Readable::read(reader)?,
4288                                         cltv_expiry: Readable::read(reader)?,
4289                                         payment_hash: Readable::read(reader)?,
4290                                         source: Readable::read(reader)?,
4291                                         onion_routing_packet: Readable::read(reader)?,
4292                                 },
4293                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4294                                         payment_preimage: Readable::read(reader)?,
4295                                         htlc_id: Readable::read(reader)?,
4296                                 },
4297                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
4298                                         htlc_id: Readable::read(reader)?,
4299                                         err_packet: Readable::read(reader)?,
4300                                 },
4301                                 _ => return Err(DecodeError::InvalidValue),
4302                         });
4303                 }
4304
4305                 let resend_order = match <u8 as Readable>::read(reader)? {
4306                         0 => RAACommitmentOrder::CommitmentFirst,
4307                         1 => RAACommitmentOrder::RevokeAndACKFirst,
4308                         _ => return Err(DecodeError::InvalidValue),
4309                 };
4310
4311                 let monitor_pending_funding_locked = Readable::read(reader)?;
4312                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4313                 let monitor_pending_commitment_signed = Readable::read(reader)?;
4314
4315                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4316                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4317                 for _ in 0..monitor_pending_forwards_count {
4318                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4319                 }
4320
4321                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4322                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4323                 for _ in 0..monitor_pending_failures_count {
4324                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4325                 }
4326
4327                 let pending_update_fee = Readable::read(reader)?;
4328                 let holding_cell_update_fee = Readable::read(reader)?;
4329
4330                 let next_local_htlc_id = Readable::read(reader)?;
4331                 let next_remote_htlc_id = Readable::read(reader)?;
4332                 let update_time_counter = Readable::read(reader)?;
4333                 let feerate_per_kw = Readable::read(reader)?;
4334
4335                 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4336                         0 => None,
4337                         1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4338                         _ => return Err(DecodeError::InvalidValue),
4339                 };
4340
4341                 let funding_txo = Readable::read(reader)?;
4342                 let funding_tx_confirmed_in = Readable::read(reader)?;
4343                 let short_channel_id = Readable::read(reader)?;
4344
4345                 let last_block_connected = Readable::read(reader)?;
4346                 let funding_tx_confirmations = Readable::read(reader)?;
4347
4348                 let their_dust_limit_satoshis = Readable::read(reader)?;
4349                 let our_dust_limit_satoshis = Readable::read(reader)?;
4350                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4351                 let local_channel_reserve_satoshis = Readable::read(reader)?;
4352                 let their_htlc_minimum_msat = Readable::read(reader)?;
4353                 let our_htlc_minimum_msat = Readable::read(reader)?;
4354                 let their_to_self_delay = Readable::read(reader)?;
4355                 let our_to_self_delay = Readable::read(reader)?;
4356                 let their_max_accepted_htlcs = Readable::read(reader)?;
4357                 let minimum_depth = Readable::read(reader)?;
4358
4359                 let their_pubkeys = Readable::read(reader)?;
4360                 let their_cur_commitment_point = Readable::read(reader)?;
4361
4362                 let their_prev_commitment_point = Readable::read(reader)?;
4363                 let their_node_id = Readable::read(reader)?;
4364
4365                 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4366                 let commitment_secrets = Readable::read(reader)?;
4367
4368                 let (monitor_last_block, channel_monitor) = Readable::read(reader)?;
4369                 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
4370                 // doing full block connection operations on the internal ChannelMonitor copies
4371                 if monitor_last_block != last_block_connected {
4372                         return Err(DecodeError::InvalidValue);
4373                 }
4374
4375                 Ok(Channel {
4376                         user_id,
4377
4378                         config,
4379                         channel_id,
4380                         channel_state,
4381                         channel_outbound,
4382                         secp_ctx: Secp256k1::new(),
4383                         channel_value_satoshis,
4384
4385                         latest_monitor_update_id,
4386
4387                         local_keys,
4388                         shutdown_pubkey,
4389                         destination_script,
4390
4391                         cur_local_commitment_transaction_number,
4392                         cur_remote_commitment_transaction_number,
4393                         value_to_self_msat,
4394
4395                         pending_inbound_htlcs,
4396                         pending_outbound_htlcs,
4397                         holding_cell_htlc_updates,
4398
4399                         resend_order,
4400
4401                         monitor_pending_funding_locked,
4402                         monitor_pending_revoke_and_ack,
4403                         monitor_pending_commitment_signed,
4404                         monitor_pending_forwards,
4405                         monitor_pending_failures,
4406
4407                         pending_update_fee,
4408                         holding_cell_update_fee,
4409                         next_local_htlc_id,
4410                         next_remote_htlc_id,
4411                         update_time_counter,
4412                         feerate_per_kw,
4413
4414                         #[cfg(debug_assertions)]
4415                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4416                         #[cfg(debug_assertions)]
4417                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4418
4419                         last_sent_closing_fee,
4420
4421                         funding_txo,
4422                         funding_tx_confirmed_in,
4423                         short_channel_id,
4424                         last_block_connected,
4425                         funding_tx_confirmations,
4426
4427                         their_dust_limit_satoshis,
4428                         our_dust_limit_satoshis,
4429                         their_max_htlc_value_in_flight_msat,
4430                         local_channel_reserve_satoshis,
4431                         their_htlc_minimum_msat,
4432                         our_htlc_minimum_msat,
4433                         their_to_self_delay,
4434                         our_to_self_delay,
4435                         their_max_accepted_htlcs,
4436                         minimum_depth,
4437
4438                         their_pubkeys,
4439                         their_cur_commitment_point,
4440
4441                         their_prev_commitment_point,
4442                         their_node_id,
4443
4444                         their_shutdown_scriptpubkey,
4445
4446                         channel_monitor: Some(channel_monitor),
4447                         commitment_secrets,
4448
4449                         network_sync: UpdateStatus::Fresh,
4450                 })
4451         }
4452 }
4453
4454 #[cfg(test)]
4455 mod tests {
4456         use bitcoin::BitcoinHash;
4457         use bitcoin::util::bip143;
4458         use bitcoin::consensus::encode::serialize;
4459         use bitcoin::blockdata::script::{Script, Builder};
4460         use bitcoin::blockdata::transaction::{Transaction, TxOut};
4461         use bitcoin::blockdata::constants::genesis_block;
4462         use bitcoin::blockdata::opcodes;
4463         use bitcoin::network::constants::Network;
4464         use bitcoin::hashes::hex::FromHex;
4465         use hex;
4466         use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4467         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4468         use ln::channel::MAX_FUNDING_SATOSHIS;
4469         use ln::features::InitFeatures;
4470         use ln::msgs::{OptionalField, DataLossProtect};
4471         use ln::chan_utils;
4472         use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4473         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4474         use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4475         use chain::transaction::OutPoint;
4476         use util::config::UserConfig;
4477         use util::enforcing_trait_impls::EnforcingChannelKeys;
4478         use util::test_utils;
4479         use util::logger::Logger;
4480         use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4481         use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4482         use bitcoin::hashes::sha256::Hash as Sha256;
4483         use bitcoin::hashes::Hash;
4484         use bitcoin::hash_types::{Txid, WPubkeyHash};
4485         use std::sync::Arc;
4486
4487         struct TestFeeEstimator {
4488                 fee_est: u32
4489         }
4490         impl FeeEstimator for TestFeeEstimator {
4491                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
4492                         self.fee_est
4493                 }
4494         }
4495
4496         #[test]
4497         fn test_max_funding_satoshis() {
4498                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4499                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4500         }
4501
4502         struct Keys {
4503                 chan_keys: InMemoryChannelKeys,
4504         }
4505         impl KeysInterface for Keys {
4506                 type ChanKeySigner = InMemoryChannelKeys;
4507
4508                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4509                 fn get_destination_script(&self) -> Script {
4510                         let secp_ctx = Secp256k1::signing_only();
4511                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4512                         let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4513                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4514                 }
4515
4516                 fn get_shutdown_pubkey(&self) -> PublicKey {
4517                         let secp_ctx = Secp256k1::signing_only();
4518                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4519                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4520                 }
4521
4522                 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4523                         self.chan_keys.clone()
4524                 }
4525                 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) { panic!(); }
4526                 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4527         }
4528
4529         fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4530                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4531         }
4532
4533         // Check that, during channel creation, we use the same feerate in the open channel message
4534         // as we do in the Channel object creation itself.
4535         #[test]
4536         fn test_open_channel_msg_fee() {
4537                 let original_fee = 253;
4538                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
4539                 let secp_ctx = Secp256k1::new();
4540                 let seed = [42; 32];
4541                 let network = Network::Testnet;
4542                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4543
4544                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4545                 let config = UserConfig::default();
4546                 let node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4547
4548                 // Now change the fee so we can check that the fee in the open_channel message is the
4549                 // same as the old fee.
4550                 fee_est.fee_est = 500;
4551                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash());
4552                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
4553         }
4554
4555         #[test]
4556         fn channel_reestablish_no_updates() {
4557                 let feeest = TestFeeEstimator{fee_est: 15000};
4558                 let logger = test_utils::TestLogger::new();
4559                 let secp_ctx = Secp256k1::new();
4560                 let seed = [42; 32];
4561                 let network = Network::Testnet;
4562                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4563
4564                 // Go through the flow of opening a channel between two nodes.
4565
4566                 // Create Node A's channel
4567                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4568                 let config = UserConfig::default();
4569                 let mut node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&feeest, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4570
4571                 // Create Node B's channel by receiving Node A's open_channel message
4572                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash());
4573                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4574                 let mut node_b_chan = Channel::<EnforcingChannelKeys>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
4575
4576                 // Node B --> Node A: accept channel
4577                 let accept_channel_msg = node_b_chan.get_accept_channel();
4578                 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4579
4580                 // Node A --> Node B: funding created
4581                 let output_script = node_a_chan.get_funding_redeemscript();
4582                 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4583                         value: 10000000, script_pubkey: output_script.clone(),
4584                 }]};
4585                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
4586                 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap();
4587                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, &&logger).unwrap();
4588
4589                 // Node B --> Node A: funding signed
4590                 let _ = node_a_chan.funding_signed(&funding_signed_msg, &&logger);
4591
4592                 // Now disconnect the two nodes and check that the commitment point in
4593                 // Node B's channel_reestablish message is sane.
4594                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4595                 let msg = node_b_chan.get_channel_reestablish(&&logger);
4596                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4597                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4598                 match msg.data_loss_protect {
4599                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4600                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4601                         },
4602                         _ => panic!()
4603                 }
4604
4605                 // Check that the commitment point in Node A's channel_reestablish message
4606                 // is sane.
4607                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4608                 let msg = node_a_chan.get_channel_reestablish(&&logger);
4609                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4610                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4611                 match msg.data_loss_protect {
4612                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4613                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4614                         },
4615                         _ => panic!()
4616                 }
4617         }
4618
4619         #[test]
4620         fn outbound_commitment_test() {
4621                 // Test vectors from BOLT 3 Appendix C:
4622                 let feeest = TestFeeEstimator{fee_est: 15000};
4623                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4624                 let secp_ctx = Secp256k1::new();
4625
4626                 let mut chan_keys = InMemoryChannelKeys::new(
4627                         &secp_ctx,
4628                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4629                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4630                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4631                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4632                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4633
4634                         // These aren't set in the test vectors:
4635                         [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],
4636                         10_000_000,
4637                         (0, 0)
4638                 );
4639
4640                 assert_eq!(chan_keys.pubkeys().funding_pubkey.serialize()[..],
4641                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4642                 let keys_provider = Keys { chan_keys: chan_keys.clone() };
4643
4644                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4645                 let mut config = UserConfig::default();
4646                 config.channel_options.announced_channel = false;
4647                 let mut chan = Channel::<InMemoryChannelKeys>::new_outbound(&&feeest, &&keys_provider, their_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
4648                 chan.their_to_self_delay = 144;
4649                 chan.our_dust_limit_satoshis = 546;
4650
4651                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
4652                 chan.funding_txo = Some(funding_info);
4653
4654                 let their_pubkeys = ChannelPublicKeys {
4655                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4656                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4657                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4658                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4659                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4660                 };
4661                 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
4662
4663                 assert_eq!(their_pubkeys.payment_point.serialize()[..],
4664                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4665
4666                 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4667                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4668
4669                 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4670                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4671
4672                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4673                 // derived from a commitment_seed, so instead we copy it here and call
4674                 // build_commitment_transaction.
4675                 let delayed_payment_base = &chan.local_keys.pubkeys().delayed_payment_basepoint;
4676                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4677                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4678                 let htlc_basepoint = &chan.local_keys.pubkeys().htlc_basepoint;
4679                 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint).unwrap();
4680
4681                 chan.their_pubkeys = Some(their_pubkeys);
4682
4683                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4684
4685                 let mut localtx;
4686                 macro_rules! test_commitment {
4687                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr, {
4688                                 $( { $htlc_idx: expr, $their_htlc_sig_hex: expr, $our_htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
4689                         } ) => { {
4690                                 unsigned_tx = {
4691                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
4692                                         let htlcs = res.2.drain(..)
4693                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4694                                                 .collect();
4695                                         (res.0, htlcs)
4696                                 };
4697                                 let redeemscript = chan.get_funding_redeemscript();
4698                                 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4699                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4700                                 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4701
4702                                 let mut per_htlc = Vec::new();
4703                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
4704                                 $({
4705                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4706                                         per_htlc.push((unsigned_tx.1[$htlc_idx].clone(), Some(remote_signature)));
4707                                 })*
4708                                 assert_eq!(unsigned_tx.1.len(), per_htlc.len());
4709
4710                                 localtx = LocalCommitmentTransaction::new_missing_local_sig(unsigned_tx.0.clone(), their_signature.clone(), &chan_keys.pubkeys().funding_pubkey, chan.their_funding_pubkey(), keys.clone(), chan.feerate_per_kw, per_htlc);
4711                                 let local_sig = chan_keys.sign_local_commitment(&localtx, &chan.secp_ctx).unwrap();
4712                                 assert_eq!(Signature::from_der(&hex::decode($our_sig_hex).unwrap()[..]).unwrap(), local_sig);
4713
4714                                 assert_eq!(serialize(&localtx.add_local_sig(&redeemscript, local_sig))[..],
4715                                                 hex::decode($tx_hex).unwrap()[..]);
4716
4717                                 let htlc_sigs = chan_keys.sign_local_commitment_htlc_transactions(&localtx, chan.their_to_self_delay, &chan.secp_ctx).unwrap();
4718                                 let mut htlc_sig_iter = localtx.per_htlc.iter().zip(htlc_sigs.iter().enumerate());
4719
4720                                 $({
4721                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4722
4723                                         let ref htlc = unsigned_tx.1[$htlc_idx];
4724                                         let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4725                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4726                                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4727                                         secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4728
4729                                         let mut preimage: Option<PaymentPreimage> = None;
4730                                         if !htlc.offered {
4731                                                 for i in 0..5 {
4732                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4733                                                         if out == htlc.payment_hash {
4734                                                                 preimage = Some(PaymentPreimage([i; 32]));
4735                                                         }
4736                                                 }
4737
4738                                                 assert!(preimage.is_some());
4739                                         }
4740
4741                                         let mut htlc_sig = htlc_sig_iter.next().unwrap();
4742                                         while (htlc_sig.1).1.is_none() { htlc_sig = htlc_sig_iter.next().unwrap(); }
4743                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx));
4744
4745                                         let our_signature = Signature::from_der(&hex::decode($our_htlc_sig_hex).unwrap()[..]).unwrap();
4746                                         assert_eq!(Some(our_signature), *(htlc_sig.1).1);
4747                                         assert_eq!(serialize(&localtx.get_signed_htlc_tx((htlc_sig.1).0, &(htlc_sig.1).1.unwrap(), &preimage, chan.their_to_self_delay))[..],
4748                                                         hex::decode($htlc_tx_hex).unwrap()[..]);
4749                                 })*
4750                                 loop {
4751                                         let htlc_sig = htlc_sig_iter.next();
4752                                         if htlc_sig.is_none() { break; }
4753                                         assert!((htlc_sig.unwrap().1).1.is_none());
4754                                 }
4755                         } }
4756                 }
4757
4758                 // simple commitment tx with no HTLCs
4759                 chan.value_to_self_msat = 7000000000;
4760
4761                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
4762                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
4763                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4764
4765                 chan.pending_inbound_htlcs.push({
4766                         let mut out = InboundHTLCOutput{
4767                                 htlc_id: 0,
4768                                 amount_msat: 1000000,
4769                                 cltv_expiry: 500,
4770                                 payment_hash: PaymentHash([0; 32]),
4771                                 state: InboundHTLCState::Committed,
4772                         };
4773                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4774                         out
4775                 });
4776                 chan.pending_inbound_htlcs.push({
4777                         let mut out = InboundHTLCOutput{
4778                                 htlc_id: 1,
4779                                 amount_msat: 2000000,
4780                                 cltv_expiry: 501,
4781                                 payment_hash: PaymentHash([0; 32]),
4782                                 state: InboundHTLCState::Committed,
4783                         };
4784                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4785                         out
4786                 });
4787                 chan.pending_outbound_htlcs.push({
4788                         let mut out = OutboundHTLCOutput{
4789                                 htlc_id: 2,
4790                                 amount_msat: 2000000,
4791                                 cltv_expiry: 502,
4792                                 payment_hash: PaymentHash([0; 32]),
4793                                 state: OutboundHTLCState::Committed,
4794                                 source: HTLCSource::dummy(),
4795                         };
4796                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4797                         out
4798                 });
4799                 chan.pending_outbound_htlcs.push({
4800                         let mut out = OutboundHTLCOutput{
4801                                 htlc_id: 3,
4802                                 amount_msat: 3000000,
4803                                 cltv_expiry: 503,
4804                                 payment_hash: PaymentHash([0; 32]),
4805                                 state: OutboundHTLCState::Committed,
4806                                 source: HTLCSource::dummy(),
4807                         };
4808                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4809                         out
4810                 });
4811                 chan.pending_inbound_htlcs.push({
4812                         let mut out = InboundHTLCOutput{
4813                                 htlc_id: 4,
4814                                 amount_msat: 4000000,
4815                                 cltv_expiry: 504,
4816                                 payment_hash: PaymentHash([0; 32]),
4817                                 state: InboundHTLCState::Committed,
4818                         };
4819                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4820                         out
4821                 });
4822
4823                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4824                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4825                 chan.feerate_per_kw = 0;
4826
4827                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
4828                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
4829                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4830
4831                                   { 0,
4832                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
4833                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
4834                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4835
4836                                   { 1,
4837                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
4838                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
4839                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4840
4841                                   { 2,
4842                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
4843                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
4844                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4845
4846                                   { 3,
4847                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
4848                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
4849                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4850
4851                                   { 4,
4852                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
4853                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
4854                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4855                 } );
4856
4857                 // commitment tx with seven outputs untrimmed (maximum feerate)
4858                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4859                 chan.feerate_per_kw = 647;
4860
4861                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
4862                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
4863                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4864
4865                                   { 0,
4866                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
4867                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
4868                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4869
4870                                   { 1,
4871                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
4872                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
4873                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4874
4875                                   { 2,
4876                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
4877                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
4878                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4879
4880                                   { 3,
4881                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
4882                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
4883                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4884
4885                                   { 4,
4886                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
4887                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
4888                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4889                 } );
4890
4891                 // commitment tx with six outputs untrimmed (minimum feerate)
4892                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4893                 chan.feerate_per_kw = 648;
4894
4895                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
4896                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
4897                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4898
4899                                   { 0,
4900                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
4901                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
4902                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4903
4904                                   { 1,
4905                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
4906                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
4907                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4908
4909                                   { 2,
4910                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
4911                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
4912                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4913
4914                                   { 3,
4915                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
4916                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
4917                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4918                 } );
4919
4920                 // commitment tx with six outputs untrimmed (maximum feerate)
4921                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4922                 chan.feerate_per_kw = 2069;
4923
4924                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
4925                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
4926                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4927
4928                                   { 0,
4929                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
4930                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
4931                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4932
4933                                   { 1,
4934                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
4935                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
4936                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4937
4938                                   { 2,
4939                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
4940                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
4941                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4942
4943                                   { 3,
4944                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
4945                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
4946                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4947                 } );
4948
4949                 // commitment tx with five outputs untrimmed (minimum feerate)
4950                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4951                 chan.feerate_per_kw = 2070;
4952
4953                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
4954                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
4955                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4956
4957                                   { 0,
4958                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
4959                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
4960                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4961
4962                                   { 1,
4963                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
4964                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
4965                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4966
4967                                   { 2,
4968                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
4969                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
4970                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4971                 } );
4972
4973                 // commitment tx with five outputs untrimmed (maximum feerate)
4974                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4975                 chan.feerate_per_kw = 2194;
4976
4977                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
4978                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
4979                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4980
4981                                   { 0,
4982                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
4983                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
4984                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4985
4986                                   { 1,
4987                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
4988                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
4989                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4990
4991                                   { 2,
4992                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
4993                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
4994                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4995                 } );
4996
4997                 // commitment tx with four outputs untrimmed (minimum feerate)
4998                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4999                 chan.feerate_per_kw = 2195;
5000
5001                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5002                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5003                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5004
5005                                   { 0,
5006                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5007                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5008                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5009
5010                                   { 1,
5011                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5012                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5013                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5014                 } );
5015
5016                 // commitment tx with four outputs untrimmed (maximum feerate)
5017                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5018                 chan.feerate_per_kw = 3702;
5019
5020                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5021                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5022                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5023
5024                                   { 0,
5025                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5026                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5027                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5028
5029                                   { 1,
5030                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5031                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5032                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5033                 } );
5034
5035                 // commitment tx with three outputs untrimmed (minimum feerate)
5036                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5037                 chan.feerate_per_kw = 3703;
5038
5039                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5040                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5041                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5042
5043                                   { 0,
5044                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5045                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5046                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5047                 } );
5048
5049                 // commitment tx with three outputs untrimmed (maximum feerate)
5050                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5051                 chan.feerate_per_kw = 4914;
5052
5053                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5054                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5055                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5056
5057                                   { 0,
5058                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5059                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5060                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5061                 } );
5062
5063                 // commitment tx with two outputs untrimmed (minimum feerate)
5064                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5065                 chan.feerate_per_kw = 4915;
5066
5067                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5068                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5069                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5070
5071                 // commitment tx with two outputs untrimmed (maximum feerate)
5072                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5073                 chan.feerate_per_kw = 9651180;
5074
5075                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5076                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5077                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5078
5079                 // commitment tx with one output untrimmed (minimum feerate)
5080                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5081                 chan.feerate_per_kw = 9651181;
5082
5083                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5084                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5085                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5086
5087                 // commitment tx with fee greater than funder amount
5088                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5089                 chan.feerate_per_kw = 9651936;
5090
5091                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5092                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5093                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5094         }
5095
5096         #[test]
5097         fn test_per_commitment_secret_gen() {
5098                 // Test vectors from BOLT 3 Appendix D:
5099
5100                 let mut seed = [0; 32];
5101                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5102                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5103                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5104
5105                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5106                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5107                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5108
5109                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5110                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5111
5112                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5113                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5114
5115                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5116                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5117                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5118         }
5119
5120         #[test]
5121         fn test_key_derivation() {
5122                 // Test vectors from BOLT 3 Appendix E:
5123                 let secp_ctx = Secp256k1::new();
5124
5125                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5126                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5127
5128                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5129                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5130
5131                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5132                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5133
5134                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5135                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5136
5137                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5138                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
5139
5140                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5141                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
5142
5143                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
5144                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
5145         }
5146 }