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