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

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