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

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