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