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