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