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

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