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