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

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