git.bitcoin.ninja 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::serialize::BitcoinHash;
   8
   9 use secp256k1::key::{PublicKey,SecretKey};
  10 use secp256k1::{Secp256k1,Message,Signature};
  11 use secp256k1;
  12
  13 use crypto::digest::Digest;
  14 use crypto::hkdf::{hkdf_extract,hkdf_expand};
  15
  16 use ln::msgs;
  17 use ln::msgs::{ErrorAction, HandleError, MsgEncodable};
  18 use ln::channelmonitor::ChannelMonitor;
  19 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, PendingForwardHTLCInfo, HTLCFailReason, HTLCFailureMsg};
  20 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
  21 use ln::chan_utils;
  22 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
  23 use chain::transaction::OutPoint;
  24 use util::{transaction_utils,rng};
  25 use util::sha2::Sha256;
  26 use util::logger::Logger;
  27 use util::errors::APIError;
  28
  29 use std;
  30 use std::default::Default;
  31 use std::{cmp,mem};
  32 use std::time::Instant;
  33 use std::sync::{Arc};
  34
  35 pub struct ChannelKeys {
  36         pub funding_key: SecretKey,
  37         pub revocation_base_key: SecretKey,
  38         pub payment_base_key: SecretKey,
  39         pub delayed_payment_base_key: SecretKey,
  40         pub htlc_base_key: SecretKey,
  41         pub channel_close_key: SecretKey,
  42         pub channel_monitor_claim_key: SecretKey,
  43         pub commitment_seed: [u8; 32],
  44 }
  45
  46 impl ChannelKeys {
  47         pub fn new_from_seed(seed: &[u8; 32]) -> Result<ChannelKeys, secp256k1::Error> {
  48                 let mut prk = [0; 32];
  49                 hkdf_extract(Sha256::new(), b"rust-lightning key gen salt", seed, &mut prk);
  50                 let secp_ctx = Secp256k1::without_caps();
  51
  52                 let mut okm = [0; 32];
  53                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning funding key info", &mut okm);
  54                 let funding_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  55
  56                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning revocation base key info", &mut okm);
  57                 let revocation_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  58
  59                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning payment base key info", &mut okm);
  60                 let payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  61
  62                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning delayed payment base key info", &mut okm);
  63                 let delayed_payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  64
  65                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning htlc base key info", &mut okm);
  66                 let htlc_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  67
  68                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel close key info", &mut okm);
  69                 let channel_close_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  70
  71                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel monitor claim key info", &mut okm);
  72                 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &okm)?;
  73
  74                 hkdf_expand(Sha256::new(), &prk, b"rust-lightning local commitment seed info", &mut okm);
  75
  76                 Ok(ChannelKeys {
  77                         funding_key: funding_key,
  78                         revocation_base_key: revocation_base_key,
  79                         payment_base_key: payment_base_key,
  80                         delayed_payment_base_key: delayed_payment_base_key,
  81                         htlc_base_key: htlc_base_key,
  82                         channel_close_key: channel_close_key,
  83                         channel_monitor_claim_key: channel_monitor_claim_key,
  84                         commitment_seed: okm
  85                 })
  86         }
  87 }
  88
  89 #[derive(PartialEq)]
  90 enum InboundHTLCState {
  91         /// Added by remote, to be included in next local commitment tx.
  92         RemoteAnnounced,
  93         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
  94         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
  95         /// accept this HTLC. Implies AwaitingRemoteRevoke.
  96         /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
  97         /// a remote revoke_and_ack on a previous state before we can do so.
  98         AwaitingRemoteRevokeToAnnounce,
  99         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
 100         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 101         /// accept this HTLC. Implies AwaitingRemoteRevoke.
 102         /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
 103         /// revoke_and_ack.
 104         AwaitingAnnouncedRemoteRevoke,
 105         Committed,
 106         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
 107         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
 108         /// we'll drop it.
 109         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
 110         /// commitment transaction without it as otherwise we'll have to force-close the channel to
 111         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
 112         /// anyway). That said, ChannelMonitor does this for us (see
 113         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
 114         /// local state before then, once we're sure that the next commitment_signed and
 115         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
 116         LocalRemoved,
 117 }
 118
 119 struct InboundHTLCOutput {
 120         htlc_id: u64,
 121         amount_msat: u64,
 122         cltv_expiry: u32,
 123         payment_hash: [u8; 32],
 124         state: InboundHTLCState,
 125         /// If we're in LocalRemoved, set to true if we fulfilled the HTLC, and can claim money
 126         local_removed_fulfilled: bool,
 127         /// state pre-Committed implies pending_forward_state, otherwise it must be None
 128         pending_forward_state: Option<PendingHTLCStatus>,
 129 }
 130
 131 #[derive(PartialEq)]
 132 enum OutboundHTLCState {
 133         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
 134         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
 135         /// we will promote to Committed (note that they may not accept it until the next time we
 136         /// revoke, but we dont really care about that:
 137         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
 138         ///    money back (though we wont), and,
 139         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
 140         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
 141         ///    doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
 142         ///    we'll never get out of sync).
 143         LocalAnnounced,
 144         Committed,
 145         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
 146         /// the change (though they'll need to revoke before we fail the payment).
 147         RemoteRemoved,
 148         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 149         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 150         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 151         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
 152         /// remote revoke_and_ack on a previous state before we can do so.
 153         AwaitingRemoteRevokeToRemove,
 154         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 155         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 156         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 157         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
 158         /// revoke_and_ack to drop completely.
 159         AwaitingRemovedRemoteRevoke,
 160 }
 161
 162 struct OutboundHTLCOutput {
 163         htlc_id: u64,
 164         amount_msat: u64,
 165         cltv_expiry: u32,
 166         payment_hash: [u8; 32],
 167         state: OutboundHTLCState,
 168         source: HTLCSource,
 169         /// If we're in a removed state, set if they failed, otherwise None
 170         fail_reason: Option<HTLCFailReason>,
 171 }
 172
 173 macro_rules! get_htlc_in_commitment {
 174         ($htlc: expr, $offered: expr) => {
 175                 HTLCOutputInCommitment {
 176                         offered: $offered,
 177                         amount_msat: $htlc.amount_msat,
 178                         cltv_expiry: $htlc.cltv_expiry,
 179                         payment_hash: $htlc.payment_hash,
 180                         transaction_output_index: 0
 181                 }
 182         }
 183 }
 184
 185 /// See AwaitingRemoteRevoke ChannelState for more info
 186 enum HTLCUpdateAwaitingACK {
 187         AddHTLC {
 188                 // always outbound
 189                 amount_msat: u64,
 190                 cltv_expiry: u32,
 191                 payment_hash: [u8; 32],
 192                 source: HTLCSource,
 193                 onion_routing_packet: msgs::OnionPacket,
 194                 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
 195         },
 196         ClaimHTLC {
 197                 payment_preimage: [u8; 32],
 198                 htlc_id: u64,
 199         },
 200         FailHTLC {
 201                 htlc_id: u64,
 202                 err_packet: msgs::OnionErrorPacket,
 203         },
 204 }
 205
 206 /// There are a few "states" and then a number of flags which can be applied:
 207 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
 208 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
 209 /// move on to ChannelFunded.
 210 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
 211 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
 212 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
 213 enum ChannelState {
 214         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
 215         OurInitSent = (1 << 0),
 216         /// Implies we have received their open_channel/accept_channel message
 217         TheirInitSent = (1 << 1),
 218         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
 219         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
 220         /// upon receipt of funding_created, so simply skip this state.
 221         FundingCreated = 4,
 222         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
 223         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
 224         /// and our counterparty consider the funding transaction confirmed.
 225         FundingSent = 8,
 226         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
 227         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 228         TheirFundingLocked = (1 << 4),
 229         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
 230         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 231         OurFundingLocked = (1 << 5),
 232         ChannelFunded = 64,
 233         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
 234         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
 235         /// dance.
 236         PeerDisconnected = (1 << 7),
 237         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
 238         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
 239         /// messages as then we will be unable to determine which HTLCs they included in their
 240         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
 241         /// later.
 242         /// Flag is set on ChannelFunded.
 243         AwaitingRemoteRevoke = (1 << 8),
 244         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
 245         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
 246         /// to respond with our own shutdown message when possible.
 247         RemoteShutdownSent = (1 << 9),
 248         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
 249         /// point, we may not add any new HTLCs to the channel.
 250         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
 251         /// us their shutdown.
 252         LocalShutdownSent = (1 << 10),
 253         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
 254         /// to drop us, but we store this anyway.
 255         ShutdownComplete = 2048,
 256 }
 257 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
 258
 259 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
 260
 261 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
 262 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
 263 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
 264 // inbound channel.
 265 pub struct Channel {
 266         user_id: u64,
 267
 268         channel_id: [u8; 32],
 269         channel_state: u32,
 270         channel_outbound: bool,
 271         secp_ctx: Secp256k1<secp256k1::All>,
 272         announce_publicly: bool,
 273         channel_value_satoshis: u64,
 274
 275         local_keys: ChannelKeys,
 276
 277         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
 278         // generation start at 0 and count up...this simplifies some parts of implementation at the
 279         // cost of others, but should really just be changed.
 280
 281         cur_local_commitment_transaction_number: u64,
 282         cur_remote_commitment_transaction_number: u64,
 283         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
 284         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
 285         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
 286         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
 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(test)]
 293         // Used in ChannelManager's tests to send a revoked transaction
 294         pub last_local_commitment_txn: Vec<Transaction>,
 295         #[cfg(not(test))]
 296         last_local_commitment_txn: Vec<Transaction>,
 297
 298         last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
 299
 300         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
 301         /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
 302         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
 303         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
 304         funding_tx_confirmed_in: Option<Sha256dHash>,
 305         short_channel_id: Option<u64>,
 306         /// Used to deduplicate block_connected callbacks
 307         last_block_connected: Sha256dHash,
 308         funding_tx_confirmations: u64,
 309
 310         their_dust_limit_satoshis: u64,
 311         our_dust_limit_satoshis: u64,
 312         their_max_htlc_value_in_flight_msat: u64,
 313         //get_our_max_htlc_value_in_flight_msat(): u64,
 314         their_channel_reserve_satoshis: u64,
 315         //get_our_channel_reserve_satoshis(): u64,
 316         their_htlc_minimum_msat: u64,
 317         our_htlc_minimum_msat: u64,
 318         their_to_self_delay: u16,
 319         //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
 320         their_max_accepted_htlcs: u16,
 321         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
 322
 323         their_funding_pubkey: Option<PublicKey>,
 324         their_revocation_basepoint: Option<PublicKey>,
 325         their_payment_basepoint: Option<PublicKey>,
 326         their_delayed_payment_basepoint: Option<PublicKey>,
 327         their_htlc_basepoint: Option<PublicKey>,
 328         their_cur_commitment_point: Option<PublicKey>,
 329
 330         their_prev_commitment_point: Option<PublicKey>,
 331         their_node_id: PublicKey,
 332
 333         their_shutdown_scriptpubkey: Option<Script>,
 334
 335         channel_monitor: ChannelMonitor,
 336
 337         logger: Arc<Logger>,
 338 }
 339
 340 const OUR_MAX_HTLCS: u16 = 5; //TODO
 341 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
 342 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
 343 /// really allow for this, so instead we're stuck closing it out at that point.
 344 const UNCONF_THRESHOLD: u32 = 6;
 345 /// The amount of time we require our counterparty wait to claim their money (ie time between when
 346 /// we, or our watchtower, must check for them having broadcast a theft transaction).
 347 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
 348 /// The amount of time we're willing to wait to claim money back to us
 349 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
 350 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 351 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 352 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
 353 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?)
 354 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
 355 /// it's 2^24.
 356 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
 357
 358 macro_rules! secp_call {
 359         ( $res: expr, $err: expr, $chan_id: expr ) => {
 360                 match $res {
 361                         Ok(key) => key,
 362                         Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
 363                 }
 364         };
 365 }
 366
 367 macro_rules! secp_derived_key {
 368         ( $res: expr, $chan_id: expr ) => {
 369                 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
 370         }
 371 }
 372 impl Channel {
 373         // Convert constants + channel value to limits:
 374         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
 375                 channel_value_satoshis * 1000 / 10 //TODO
 376         }
 377
 378         /// Guaranteed to return a value no larger than channel_value_satoshis
 379         fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
 380                 let (q, _) = channel_value_satoshis.overflowing_div(100);
 381                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
 382         }
 383
 384         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
 385                 at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000 //TODO
 386         }
 387
 388         fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
 389                 1000 // TODO
 390         }
 391
 392         fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
 393                 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
 394                 // be at least 6.
 395                 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
 396                 CONF_TARGET
 397         }
 398
 399         fn derive_maximum_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
 400                 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
 401                 CONF_TARGET * 2
 402         }
 403
 404         // Constructors:
 405         pub fn new_outbound(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, announce_publicly: bool, user_id: u64, logger: Arc<Logger>) -> Result<Channel, APIError> {
 406                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
 407                         return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
 408                 }
 409
 410                 if push_msat > channel_value_satoshis * 1000 {
 411                         return Err(APIError::APIMisuseError{err: "push value > channel value"});
 412                 }
 413
 414
 415                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 416                 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
 417                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
 418                 }
 419
 420                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
 421
 422                 let secp_ctx = Secp256k1::new();
 423                 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
 424                 let our_channel_monitor_claim_script = Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script();
 425                 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
 426                                                           &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
 427                                                           &chan_keys.htlc_base_key,
 428                                                           BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
 429
 430                 Ok(Channel {
 431                         user_id: user_id,
 432
 433                         channel_id: rng::rand_u832(),
 434                         channel_state: ChannelState::OurInitSent as u32,
 435                         channel_outbound: true,
 436                         secp_ctx: secp_ctx,
 437                         announce_publicly: announce_publicly,
 438                         channel_value_satoshis: channel_value_satoshis,
 439
 440                         local_keys: chan_keys,
 441                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 442                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 443                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
 444                         pending_inbound_htlcs: Vec::new(),
 445                         pending_outbound_htlcs: Vec::new(),
 446                         holding_cell_htlc_updates: Vec::new(),
 447                         next_local_htlc_id: 0,
 448                         next_remote_htlc_id: 0,
 449                         channel_update_count: 1,
 450
 451                         last_local_commitment_txn: Vec::new(),
 452
 453                         last_sent_closing_fee: None,
 454
 455                         funding_tx_confirmed_in: None,
 456                         short_channel_id: None,
 457                         last_block_connected: Default::default(),
 458                         funding_tx_confirmations: 0,
 459
 460                         feerate_per_kw: feerate,
 461                         their_dust_limit_satoshis: 0,
 462                         our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
 463                         their_max_htlc_value_in_flight_msat: 0,
 464                         their_channel_reserve_satoshis: 0,
 465                         their_htlc_minimum_msat: 0,
 466                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
 467                         their_to_self_delay: 0,
 468                         their_max_accepted_htlcs: 0,
 469
 470                         their_funding_pubkey: None,
 471                         their_revocation_basepoint: None,
 472                         their_payment_basepoint: None,
 473                         their_delayed_payment_basepoint: None,
 474                         their_htlc_basepoint: None,
 475                         their_cur_commitment_point: None,
 476
 477                         their_prev_commitment_point: None,
 478                         their_node_id: their_node_id,
 479
 480                         their_shutdown_scriptpubkey: None,
 481
 482                         channel_monitor: channel_monitor,
 483
 484                         logger,
 485                 })
 486         }
 487
 488         fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), HandleError> {
 489                 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
 490                         return Err(HandleError{err: "Peer's feerate much too low", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
 491                 }
 492                 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
 493                         return Err(HandleError{err: "Peer's feerate much too high", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
 494                 }
 495                 Ok(())
 496         }
 497
 498         /// Creates a new channel from a remote sides' request for one.
 499         /// Assumes chain_hash has already been checked and corresponds with what we expect!
 500         /// Generally prefers to take the DisconnectPeer action on failure, as a notice to the sender
 501         /// that we're rejecting the new channel.
 502         pub fn new_from_req(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, require_announce: bool, allow_announce: bool, logger: Arc<Logger>) -> Result<Channel, HandleError> {
 503                 macro_rules! return_error_message {
 504                         ( $msg: expr ) => {
 505                                 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
 506                         }
 507                 }
 508
 509                 // Check sanity of message fields:
 510                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
 511                         return_error_message!("funding value > 2^24");
 512                 }
 513                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
 514                         return_error_message!("Bogus channel_reserve_satoshis");
 515                 }
 516                 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
 517                         return_error_message!("push_msat larger than funding value");
 518                 }
 519                 if msg.dust_limit_satoshis > msg.funding_satoshis {
 520                         return_error_message!("Peer never wants payout outputs?");
 521                 }
 522                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
 523                         return_error_message!("Bogus; channel reserve is less than dust limit");
 524                 }
 525                 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
 526                         return_error_message!("Miminum htlc value is full channel value");
 527                 }
 528                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw).map_err(|e|
 529                         HandleError{err: e.err, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: e.err.to_string() }})}
 530                 )?;
 531
 532                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
 533                         return_error_message!("They wanted our payments to be delayed by a needlessly long period");
 534                 }
 535                 if msg.max_accepted_htlcs < 1 {
 536                         return_error_message!("0 max_accpted_htlcs makes for a useless channel");
 537                 }
 538                 if msg.max_accepted_htlcs > 483 {
 539                         return_error_message!("max_accpted_htlcs > 483");
 540                 }
 541
 542                 // Convert things into internal flags and prep our state:
 543
 544                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
 545                 if require_announce && !their_announce {
 546                         return_error_message!("Peer tried to open unannounced channel, but we require public ones");
 547                 }
 548                 if !allow_announce && their_announce {
 549                         return_error_message!("Peer tried to open announced channel, but we require private ones");
 550                 }
 551
 552                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 553
 554                 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
 555                 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
 556                 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
 557                         return_error_message!("Suitalbe channel reserve not found. aborting");
 558                 }
 559                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
 560                         return_error_message!("channel_reserve_satoshis too small");
 561                 }
 562                 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
 563                         return_error_message!("Dust limit too high for our channel reserve");
 564                 }
 565
 566                 // check if the funder's amount for the initial commitment tx is sufficient
 567                 // for full fee payment
 568                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
 569                 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
 570                         return_error_message!("Insufficient funding amount for initial commitment");
 571                 }
 572
 573                 let to_local_msat = msg.push_msat;
 574                 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
 575                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
 576                         return_error_message!("Insufficient funding amount for initial commitment");
 577                 }
 578
 579                 let secp_ctx = Secp256k1::new();
 580                 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
 581                 let our_channel_monitor_claim_script = Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script();
 582                 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
 583                                                               &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
 584                                                               &chan_keys.htlc_base_key,
 585                                                               BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
 586                 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
 587                 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
 588
 589                 let mut chan = Channel {
 590                         user_id: user_id,
 591
 592                         channel_id: msg.temporary_channel_id,
 593                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
 594                         channel_outbound: false,
 595                         secp_ctx: secp_ctx,
 596                         announce_publicly: their_announce,
 597
 598                         local_keys: chan_keys,
 599                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 600                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 601                         value_to_self_msat: msg.push_msat,
 602                         pending_inbound_htlcs: Vec::new(),
 603                         pending_outbound_htlcs: Vec::new(),
 604                         holding_cell_htlc_updates: Vec::new(),
 605                         next_local_htlc_id: 0,
 606                         next_remote_htlc_id: 0,
 607                         channel_update_count: 1,
 608
 609                         last_local_commitment_txn: Vec::new(),
 610
 611                         last_sent_closing_fee: None,
 612
 613                         funding_tx_confirmed_in: None,
 614                         short_channel_id: None,
 615                         last_block_connected: Default::default(),
 616                         funding_tx_confirmations: 0,
 617
 618                         feerate_per_kw: msg.feerate_per_kw as u64,
 619                         channel_value_satoshis: msg.funding_satoshis,
 620                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
 621                         our_dust_limit_satoshis: our_dust_limit_satoshis,
 622                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
 623                         their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
 624                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
 625                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
 626                         their_to_self_delay: msg.to_self_delay,
 627                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
 628
 629                         their_funding_pubkey: Some(msg.funding_pubkey),
 630                         their_revocation_basepoint: Some(msg.revocation_basepoint),
 631                         their_payment_basepoint: Some(msg.payment_basepoint),
 632                         their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
 633                         their_htlc_basepoint: Some(msg.htlc_basepoint),
 634                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
 635
 636                         their_prev_commitment_point: None,
 637                         their_node_id: their_node_id,
 638
 639                         their_shutdown_scriptpubkey: None,
 640
 641                         channel_monitor: channel_monitor,
 642
 643                         logger,
 644                 };
 645
 646                 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
 647                 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
 648
 649                 Ok(chan)
 650         }
 651
 652         // Utilities to derive keys:
 653
 654         fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
 655                 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
 656                 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
 657         }
 658
 659         // Utilities to build transactions:
 660
 661         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
 662                 let mut sha = Sha256::new();
 663                 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
 664
 665                 if self.channel_outbound {
 666                         sha.input(&our_payment_basepoint.serialize());
 667                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
 668                 } else {
 669                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
 670                         sha.input(&our_payment_basepoint.serialize());
 671                 }
 672                 let mut res = [0; 32];
 673                 sha.result(&mut res);
 674
 675                 ((res[26] as u64) << 5*8) |
 676                 ((res[27] as u64) << 4*8) |
 677                 ((res[28] as u64) << 3*8) |
 678                 ((res[29] as u64) << 2*8) |
 679                 ((res[30] as u64) << 1*8) |
 680                 ((res[31] as u64) << 0*8)
 681         }
 682
 683         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
 684         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
 685         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
 686         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
 687         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
 688         /// an HTLC to a).
 689         /// @local is used only to convert relevant internal structures which refer to remote vs local
 690         /// to decide value of outputs and direction of HTLCs.
 691         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
 692         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
 693         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
 694         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
 695         /// which peer generated this transaction and "to whom" this transaction flows.
 696         #[inline]
 697         fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool) -> (Transaction, Vec<HTLCOutputInCommitment>) {
 698                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
 699
 700                 let txins = {
 701                         let mut ins: Vec<TxIn> = Vec::new();
 702                         ins.push(TxIn {
 703                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
 704                                 script_sig: Script::new(),
 705                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
 706                                 witness: Vec::new(),
 707                         });
 708                         ins
 709                 };
 710
 711                 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
 712
 713                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
 714                 let mut remote_htlc_total_msat = 0;
 715                 let mut local_htlc_total_msat = 0;
 716                 let mut value_to_self_msat_offset = 0;
 717
 718                 macro_rules! add_htlc_output {
 719                         ($htlc: expr, $outbound: expr) => {
 720                                 if $outbound == local { // "offered HTLC output"
 721                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
 722                                                 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
 723                                                 txouts.push((TxOut {
 724                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 725                                                         value: $htlc.amount_msat / 1000
 726                                                 }, Some(htlc_in_tx)));
 727                                         }
 728                                 } else {
 729                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
 730                                                 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
 731                                                 txouts.push((TxOut { // "received HTLC output"
 732                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 733                                                         value: $htlc.amount_msat / 1000
 734                                                 }, Some(htlc_in_tx)));
 735                                         }
 736                                 }
 737                         }
 738                 }
 739
 740                 for ref htlc in self.pending_inbound_htlcs.iter() {
 741                         let include = match htlc.state {
 742                                 InboundHTLCState::RemoteAnnounced => !generated_by_local,
 743                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce => !generated_by_local,
 744                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke => true,
 745                                 InboundHTLCState::Committed => true,
 746                                 InboundHTLCState::LocalRemoved => !generated_by_local,
 747                         };
 748
 749                         if include {
 750                                 add_htlc_output!(htlc, false);
 751                                 remote_htlc_total_msat += htlc.amount_msat;
 752                         } else {
 753                                 match htlc.state {
 754                                         InboundHTLCState::LocalRemoved => {
 755                                                 if generated_by_local && htlc.local_removed_fulfilled {
 756                                                         value_to_self_msat_offset += htlc.amount_msat as i64;
 757                                                 }
 758                                         },
 759                                         _ => {},
 760                                 }
 761                         }
 762                 }
 763
 764                 for ref htlc in self.pending_outbound_htlcs.iter() {
 765                         let include = match htlc.state {
 766                                 OutboundHTLCState::LocalAnnounced => generated_by_local,
 767                                 OutboundHTLCState::Committed => true,
 768                                 OutboundHTLCState::RemoteRemoved => generated_by_local,
 769                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
 770                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
 771                         };
 772
 773                         if include {
 774                                 add_htlc_output!(htlc, true);
 775                                 local_htlc_total_msat += htlc.amount_msat;
 776                         } else {
 777                                 match htlc.state {
 778                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
 779                                                 if htlc.fail_reason.is_none() {
 780                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
 781                                                 }
 782                                         },
 783                                         OutboundHTLCState::RemoteRemoved => {
 784                                                 if !generated_by_local && htlc.fail_reason.is_none() {
 785                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
 786                                                 }
 787                                         },
 788                                         _ => {},
 789                                 }
 790                         }
 791                 }
 792
 793                 let total_fee: u64 = self.feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 794                 let value_to_self: i64 = ((self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset) / 1000 - if self.channel_outbound { total_fee as i64 } else { 0 };
 795                 let value_to_remote: i64 = (((self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset) / 1000) - if self.channel_outbound { 0 } else { total_fee as i64 };
 796
 797                 let value_to_a = if local { value_to_self } else { value_to_remote };
 798                 let value_to_b = if local { value_to_remote } else { value_to_self };
 799
 800                 if value_to_a >= (dust_limit_satoshis as i64) {
 801                         txouts.push((TxOut {
 802                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
 803                                                                                        if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
 804                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
 805                                 value: value_to_a as u64
 806                         }, None));
 807                 }
 808
 809                 if value_to_b >= (dust_limit_satoshis as i64) {
 810                         txouts.push((TxOut {
 811                                 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
 812                                                              .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
 813                                                              .into_script(),
 814                                 value: value_to_b as u64
 815                         }, None));
 816                 }
 817
 818                 transaction_utils::sort_outputs(&mut txouts);
 819
 820                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
 821                 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
 822                 for (idx, out) in txouts.drain(..).enumerate() {
 823                         outputs.push(out.0);
 824                         if let Some(out_htlc) = out.1 {
 825                                 htlcs_used.push(out_htlc);
 826                                 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
 827                         }
 828                 }
 829
 830                 (Transaction {
 831                         version: 2,
 832                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
 833                         input: txins,
 834                         output: outputs,
 835                 }, htlcs_used)
 836         }
 837
 838         #[inline]
 839         fn get_closing_scriptpubkey(&self) -> Script {
 840                 let our_channel_close_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.channel_close_key).serialize());
 841                 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
 842         }
 843
 844         #[inline]
 845         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
 846                 (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)
 847         }
 848
 849         #[inline]
 850         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
 851                 let txins = {
 852                         let mut ins: Vec<TxIn> = Vec::new();
 853                         ins.push(TxIn {
 854                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
 855                                 script_sig: Script::new(),
 856                                 sequence: 0xffffffff,
 857                                 witness: Vec::new(),
 858                         });
 859                         ins
 860                 };
 861
 862                 assert!(self.pending_inbound_htlcs.is_empty());
 863                 assert!(self.pending_outbound_htlcs.is_empty());
 864                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
 865
 866                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
 867                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
 868                 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 };
 869
 870                 if value_to_self < 0 {
 871                         assert!(self.channel_outbound);
 872                         total_fee_satoshis += (-value_to_self) as u64;
 873                 } else if value_to_remote < 0 {
 874                         assert!(!self.channel_outbound);
 875                         total_fee_satoshis += (-value_to_remote) as u64;
 876                 }
 877
 878                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
 879                         txouts.push((TxOut {
 880                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
 881                                 value: value_to_remote as u64
 882                         }, ()));
 883                 }
 884
 885                 if value_to_self as u64 > self.our_dust_limit_satoshis {
 886                         txouts.push((TxOut {
 887                                 script_pubkey: self.get_closing_scriptpubkey(),
 888                                 value: value_to_self as u64
 889                         }, ()));
 890                 }
 891
 892                 transaction_utils::sort_outputs(&mut txouts);
 893
 894                 let mut outputs: Vec<TxOut> = Vec::new();
 895                 for out in txouts.drain(..) {
 896                         outputs.push(out.0);
 897                 }
 898
 899                 (Transaction {
 900                         version: 2,
 901                         lock_time: 0,
 902                         input: txins,
 903                         output: outputs,
 904                 }, total_fee_satoshis)
 905         }
 906
 907         #[inline]
 908         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
 909         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
 910         /// our counterparty!)
 911         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
 912         /// TODO Some magic rust shit to compile-time check this?
 913         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
 914                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
 915                 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
 916                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
 917
 918                 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()))
 919         }
 920
 921         #[inline]
 922         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
 923         /// will sign and send to our counterparty.
 924         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
 925                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
 926                 //may see payments to it!
 927                 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
 928                 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
 929                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
 930
 931                 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()))
 932         }
 933
 934         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
 935         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
 936         /// Panics if called before accept_channel/new_from_req
 937         pub fn get_funding_redeemscript(&self) -> Script {
 938                 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
 939                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
 940                 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
 941                 if our_funding_key[..] < their_funding_key[..] {
 942                         builder.push_slice(&our_funding_key)
 943                                 .push_slice(&their_funding_key)
 944                 } else {
 945                         builder.push_slice(&their_funding_key)
 946                                 .push_slice(&our_funding_key)
 947                 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
 948         }
 949
 950         fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
 951                 if tx.input.len() != 1 {
 952                         panic!("Tried to sign commitment transaction that had input count != 1!");
 953                 }
 954                 if tx.input[0].witness.len() != 0 {
 955                         panic!("Tried to re-sign commitment transaction");
 956                 }
 957
 958                 let funding_redeemscript = self.get_funding_redeemscript();
 959
 960                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
 961                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
 962
 963                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
 964
 965                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
 966                 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
 967                 if our_funding_key[..] < their_funding_key[..] {
 968                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
 969                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
 970                 } else {
 971                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
 972                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
 973                 }
 974                 tx.input[0].witness[1].push(SigHashType::All as u8);
 975                 tx.input[0].witness[2].push(SigHashType::All as u8);
 976
 977                 tx.input[0].witness.push(funding_redeemscript.into_bytes());
 978
 979                 our_sig
 980         }
 981
 982         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
 983         /// @local is used only to convert relevant internal structures which refer to remote vs local
 984         /// to decide value of outputs and direction of HTLCs.
 985         fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys) -> Transaction {
 986                 chan_utils::build_htlc_transaction(prev_hash, self.feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
 987         }
 988
 989         fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
 990                 if tx.input.len() != 1 {
 991                         panic!("Tried to sign HTLC transaction that had input count != 1!");
 992                 }
 993
 994                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
 995
 996                 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());
 997                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
 998                 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
 999                 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1000         }
1001
1002         /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1003         /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1004         fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1005                 if tx.input.len() != 1 {
1006                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1007                 }
1008                 if tx.input[0].witness.len() != 0 {
1009                         panic!("Tried to re-sign HTLC transaction");
1010                 }
1011
1012                 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1013
1014                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1015
1016                 if local_tx { // b, then a
1017                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1018                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1019                 } else {
1020                         tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1021                         tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1022                 }
1023                 tx.input[0].witness[1].push(SigHashType::All as u8);
1024                 tx.input[0].witness[2].push(SigHashType::All as u8);
1025
1026                 if htlc.offered {
1027                         tx.input[0].witness.push(Vec::new());
1028                 } else {
1029                         tx.input[0].witness.push(preimage.unwrap().to_vec());
1030                 }
1031
1032                 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1033
1034                 Ok(our_sig)
1035         }
1036
1037         /// May return an IgnoreError, but should not, and will always return Ok(_) when
1038         /// debug_assertions are turned on
1039         fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1040                 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1041                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1042                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1043                 // either.
1044                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1045                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1046                 }
1047                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1048
1049                 let mut sha = Sha256::new();
1050                 sha.input(&payment_preimage_arg);
1051                 let mut payment_hash_calc = [0; 32];
1052                 sha.result(&mut payment_hash_calc);
1053
1054                 let mut pending_idx = std::usize::MAX;
1055                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1056                         if htlc.htlc_id == htlc_id_arg {
1057                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1058                                 if htlc.state != InboundHTLCState::Committed {
1059                                         debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1060                                         // Don't return in release mode here so that we can update channel_monitor
1061                                 }
1062                                 pending_idx = idx;
1063                                 break;
1064                         }
1065                 }
1066                 if pending_idx == std::usize::MAX {
1067                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1068                         return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1069                 }
1070
1071                 // Now update local state:
1072                 //
1073                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1074                 // can claim it even if the channel hits the chain before we see their next commitment.
1075                 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1076
1077                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1078                         for pending_update in self.holding_cell_htlc_updates.iter() {
1079                                 match pending_update {
1080                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1081                                                 if htlc_id_arg == htlc_id {
1082                                                         debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1083                                                         return Ok((None, None));
1084                                                 }
1085                                         },
1086                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1087                                                 if htlc_id_arg == htlc_id {
1088                                                         debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1089                                                         return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1090                                                 }
1091                                         },
1092                                         _ => {}
1093                                 }
1094                         }
1095                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1096                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1097                         });
1098                         return Ok((None, Some(self.channel_monitor.clone())));
1099                 }
1100
1101                 {
1102                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1103                         if htlc.state != InboundHTLCState::Committed {
1104                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1105                                 return Ok((None, Some(self.channel_monitor.clone())));
1106                         }
1107                         htlc.state = InboundHTLCState::LocalRemoved;
1108                         htlc.local_removed_fulfilled = true;
1109                 }
1110
1111                 Ok((Some(msgs::UpdateFulfillHTLC {
1112                         channel_id: self.channel_id(),
1113                         htlc_id: htlc_id_arg,
1114                         payment_preimage: payment_preimage_arg,
1115                 }), Some(self.channel_monitor.clone())))
1116         }
1117
1118         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> {
1119                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1120                         (Some(update_fulfill_htlc), _) => {
1121                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1122                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1123                         },
1124                         (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1125                         (None, None) => Ok((None, None))
1126                 }
1127         }
1128
1129         /// May return an IgnoreError, but should not, and will always return Ok(_) when
1130         /// debug_assertions are turned on
1131         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1132                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1133                         panic!("Was asked to fail 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 pending_idx = std::usize::MAX;
1138                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1139                         if htlc.htlc_id == htlc_id_arg {
1140                                 if htlc.state != InboundHTLCState::Committed {
1141                                         debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1142                                         return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1143                                 }
1144                                 pending_idx = idx;
1145                         }
1146                 }
1147                 if pending_idx == std::usize::MAX {
1148                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1149                         return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1150                 }
1151
1152                 // Now update local state:
1153                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1154                         for pending_update in self.holding_cell_htlc_updates.iter() {
1155                                 match pending_update {
1156                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1157                                                 if htlc_id_arg == htlc_id {
1158                                                         debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1159                                                         return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1160                                                 }
1161                                         },
1162                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1163                                                 if htlc_id_arg == htlc_id {
1164                                                         debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1165                                                         return Ok(None);
1166                                                 }
1167                                         },
1168                                         _ => {}
1169                                 }
1170                         }
1171                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1172                                 htlc_id: htlc_id_arg,
1173                                 err_packet,
1174                         });
1175                         return Ok(None);
1176                 }
1177
1178                 {
1179                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1180                         htlc.state = InboundHTLCState::LocalRemoved;
1181                         htlc.local_removed_fulfilled = false;
1182                 }
1183
1184                 Ok(Some(msgs::UpdateFailHTLC {
1185                         channel_id: self.channel_id(),
1186                         htlc_id: htlc_id_arg,
1187                         reason: err_packet
1188                 }))
1189         }
1190
1191         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> {
1192                 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1193                         Some(update_fail_htlc) => {
1194                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1195                                 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1196                         },
1197                         None => Ok(None)
1198                 }
1199         }
1200
1201         // Message handlers:
1202
1203         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1204                 macro_rules! return_error_message {
1205                         ( $msg: expr ) => {
1206                                 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
1207                         }
1208                 }
1209                 // Check sanity of message fields:
1210                 if !self.channel_outbound {
1211                         return_error_message!("Got an accept_channel message from an inbound peer");
1212                 }
1213                 if self.channel_state != ChannelState::OurInitSent as u32 {
1214                         return_error_message!("Got an accept_channel message at a strange time");
1215                 }
1216                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1217                         return_error_message!("Peer never wants payout outputs?");
1218                 }
1219                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1220                         return_error_message!("Bogus channel_reserve_satoshis");
1221                 }
1222                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1223                         return_error_message!("Bogus channel_reserve and dust_limit");
1224                 }
1225                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1226                         return_error_message!("Peer never wants payout outputs?");
1227                 }
1228                 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1229                         return_error_message!("Dust limit is bigger than our channel reverse");
1230                 }
1231                 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1232                         return_error_message!("Minimum htlc value is full channel value");
1233                 }
1234                 if msg.minimum_depth > Channel::derive_maximum_minimum_depth(self.channel_value_satoshis*1000,  self.value_to_self_msat) {
1235                         return_error_message!("minimum_depth too large");
1236                 }
1237                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1238                         return_error_message!("They wanted our payments to be delayed by a needlessly long period");
1239                 }
1240                 if msg.max_accepted_htlcs < 1 {
1241                         return_error_message!("0 max_accpted_htlcs makes for a useless channel");
1242                 }
1243                 if msg.max_accepted_htlcs > 483 {
1244                         return_error_message!("max_accpted_htlcs > 483");
1245                 }
1246
1247                 // TODO: Optional additional constraints mentioned in the spec
1248                 // MAY fail the channel if
1249                 // funding_satoshi is too small
1250                 // htlc_minimum_msat too large
1251                 // max_htlc_value_in_flight_msat too small
1252                 // channel_reserve_satoshis too large
1253                 // max_accepted_htlcs too small
1254                 // dust_limit_satoshis too small
1255
1256                 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1257
1258                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1259                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1260                 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1261                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1262                 self.their_to_self_delay = msg.to_self_delay;
1263                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1264                 self.their_funding_pubkey = Some(msg.funding_pubkey);
1265                 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1266                 self.their_payment_basepoint = Some(msg.payment_basepoint);
1267                 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1268                 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1269                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1270
1271                 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1272                 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1273                 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1274
1275                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1276
1277                 Ok(())
1278         }
1279
1280         fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1281                 let funding_script = self.get_funding_redeemscript();
1282
1283                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1284                 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1285                 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();
1286
1287                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1288                 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1289
1290                 let remote_keys = self.build_remote_transaction_keys()?;
1291                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
1292                 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();
1293
1294                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1295                 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key)))
1296         }
1297
1298         pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1299                 if self.channel_outbound {
1300                         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()}})});
1301                 }
1302                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1303                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1304                         // remember the channel, so its safe to just send an error_message here and drop the
1305                         // channel.
1306                         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()}})});
1307                 }
1308                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1309                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1310                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1311                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1312                 }
1313
1314                 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1315                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1316                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1317
1318                 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1319                         Ok(res) => res,
1320                         Err(e) => {
1321                                 self.channel_monitor.unset_funding_info();
1322                                 return Err(e);
1323                         }
1324                 };
1325
1326                 // Now that we're past error-generating stuff, update our local state:
1327
1328                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1329                 self.channel_state = ChannelState::FundingSent as u32;
1330                 self.channel_id = funding_txo.to_channel_id();
1331                 self.cur_remote_commitment_transaction_number -= 1;
1332                 self.cur_local_commitment_transaction_number -= 1;
1333
1334                 Ok((msgs::FundingSigned {
1335                         channel_id: self.channel_id,
1336                         signature: our_signature
1337                 }, self.channel_monitor.clone()))
1338         }
1339
1340         /// Handles a funding_signed message from the remote end.
1341         /// If this call is successful, broadcast the funding transaction (and not before!)
1342         pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1343                 if !self.channel_outbound {
1344                         return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1345                 }
1346                 if self.channel_state != ChannelState::FundingCreated as u32 {
1347                         return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1348                 }
1349                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1350                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1351                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1352                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1353                 }
1354
1355                 let funding_script = self.get_funding_redeemscript();
1356
1357                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1358                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1359                 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();
1360
1361                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1362                 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1363
1364                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1365                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1366                 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1367                 self.channel_state = ChannelState::FundingSent as u32;
1368                 self.cur_local_commitment_transaction_number -= 1;
1369
1370                 Ok(self.channel_monitor.clone())
1371         }
1372
1373         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
1374                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1375                         return Err(HandleError{err: "Peer sent funding_locked when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent funding_locked when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1376                 }
1377                 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
1378                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1379                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1380                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1381                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
1382                         self.channel_update_count += 1;
1383                 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1384                                 // Note that funding_signed/funding_created will have decremented both by 1!
1385                                 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1386                                 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1387                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1388                                 return Err(HandleError{err: "Peer sent a reconnect funding_locked with a different point", action: None});
1389                         }
1390                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1391                         return Ok(());
1392                 } else {
1393                         return Err(HandleError{err: "Peer sent a funding_locked at a strange time", action: None});
1394                 }
1395
1396                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1397                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1398                 Ok(())
1399         }
1400
1401         /// Returns (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1402         /// If its for a remote update check, we need to be more lax about checking against messages we
1403         /// sent but they may not have received/processed before they sent this message. Further, for
1404         /// our own sends, we're more conservative and even consider things they've removed against
1405         /// totals, though there is little reason to outside of further avoiding any race condition
1406         /// issues.
1407         fn get_pending_htlc_stats(&self, for_remote_update_check: bool) -> (u32, u32, u64, u64) {
1408                 //TODO: Can probably split this into inbound/outbound
1409                 let mut inbound_htlc_count: u32 = 0;
1410                 let mut outbound_htlc_count: u32 = 0;
1411                 let mut htlc_outbound_value_msat = 0;
1412                 let mut htlc_inbound_value_msat = 0;
1413                 for ref htlc in self.pending_inbound_htlcs.iter() {
1414                         match htlc.state {
1415                                 InboundHTLCState::RemoteAnnounced => {},
1416                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce => {},
1417                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke => {},
1418                                 InboundHTLCState::Committed => {},
1419                                 InboundHTLCState::LocalRemoved => {},
1420                         }
1421                         inbound_htlc_count += 1;
1422                         htlc_inbound_value_msat += htlc.amount_msat;
1423                 }
1424                 for ref htlc in self.pending_outbound_htlcs.iter() {
1425                         match htlc.state {
1426                                 OutboundHTLCState::LocalAnnounced => { if for_remote_update_check { continue; } },
1427                                 OutboundHTLCState::Committed => {},
1428                                 OutboundHTLCState::RemoteRemoved => { if for_remote_update_check { continue; } },
1429                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove => { if for_remote_update_check { continue; } },
1430                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke => { if for_remote_update_check { continue; } },
1431                         }
1432                         outbound_htlc_count += 1;
1433                         htlc_outbound_value_msat += htlc.amount_msat;
1434                 }
1435
1436                 (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1437         }
1438
1439         pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1440                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1441                         return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1442                 }
1443                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1444                         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}})});
1445                 }
1446                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1447                         return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1448                 }
1449                 if msg.amount_msat < self.our_htlc_minimum_msat {
1450                         return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1451                 }
1452
1453                 let (inbound_htlc_count, _, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(true);
1454                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1455                         return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1456                 }
1457                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1458                 // Check our_max_htlc_value_in_flight_msat
1459                 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1460                         return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1461                 }
1462                 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1463                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1464                 // something if we punish them for broadcasting an old state).
1465                 if htlc_inbound_value_msat + htlc_outbound_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 {
1466                         return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1467                 }
1468                 if self.next_remote_htlc_id != msg.htlc_id {
1469                         return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1470                 }
1471                 if msg.cltv_expiry >= 500000000 {
1472                         return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1473                 }
1474
1475                 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1476
1477                 // Now update local state:
1478                 self.next_remote_htlc_id += 1;
1479                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1480                         htlc_id: msg.htlc_id,
1481                         amount_msat: msg.amount_msat,
1482                         payment_hash: msg.payment_hash,
1483                         cltv_expiry: msg.cltv_expiry,
1484                         state: InboundHTLCState::RemoteAnnounced,
1485                         local_removed_fulfilled: false,
1486                         pending_forward_state: Some(pending_forward_state),
1487                 });
1488
1489                 Ok(())
1490         }
1491
1492         /// Removes an outbound HTLC which has been commitment_signed by the remote end
1493         #[inline]
1494         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, HandleError> {
1495                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1496                         if htlc.htlc_id == htlc_id {
1497                                 match check_preimage {
1498                                         None => {},
1499                                         Some(payment_hash) =>
1500                                                 if payment_hash != htlc.payment_hash {
1501                                                         return Err(HandleError{err: "Remote tried to fulfill HTLC with an incorrect preimage", action: None});
1502                                                 }
1503                                 };
1504                                 match htlc.state {
1505                                         OutboundHTLCState::LocalAnnounced =>
1506                                                 return Err(HandleError{err: "Remote tried to fulfill HTLC before it had been committed", action: None}),
1507                                         OutboundHTLCState::Committed => {
1508                                                 htlc.state = OutboundHTLCState::RemoteRemoved;
1509                                                 htlc.fail_reason = fail_reason;
1510                                         },
1511                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1512                                                 return Err(HandleError{err: "Remote tried to fulfill HTLC that they'd already fulfilled", action: None}),
1513                                 }
1514                                 return Ok(&htlc.source);
1515                         }
1516                 }
1517                 Err(HandleError{err: "Remote tried to fulfill/fail an HTLC we couldn't find", action: None})
1518         }
1519
1520         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, HandleError> {
1521                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1522                         return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1523                 }
1524                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1525                         return Err(HandleError{err: "Peer sent update_fulfill_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1526                 }
1527
1528                 let mut sha = Sha256::new();
1529                 sha.input(&msg.payment_preimage);
1530                 let mut payment_hash = [0; 32];
1531                 sha.result(&mut payment_hash);
1532
1533                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1534         }
1535
1536         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, HandleError> {
1537                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1538                         return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1539                 }
1540                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1541                         return Err(HandleError{err: "Peer sent update_fail_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fail_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1542                 }
1543
1544                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1545         }
1546
1547         pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, HandleError> {
1548                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1549                         return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1550                 }
1551                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1552                         return Err(HandleError{err: "Peer sent update_fail_malformed_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1553                 }
1554
1555                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1556         }
1557
1558         pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1559                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1560                         return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1561                 }
1562                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1563                         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}})});
1564                 }
1565
1566                 let funding_script = self.get_funding_redeemscript();
1567
1568                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1569                 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false);
1570                 let local_commitment_txid = local_commitment_tx.0.txid();
1571                 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();
1572                 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1573
1574                 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1575                         return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1576                 }
1577
1578                 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1579                 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1580                 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1581
1582                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1583                 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1584                         let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys);
1585                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1586                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1587                         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());
1588                         let htlc_sig = if htlc.offered {
1589                                 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1590                                 new_local_commitment_txn.push(htlc_tx);
1591                                 htlc_sig
1592                         } else {
1593                                 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1594                         };
1595                         htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1596                 }
1597
1598                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1599                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1600
1601                 // Update state now that we've passed all the can-fail calls...
1602                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1603
1604                 let mut need_our_commitment = false;
1605                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1606                         if htlc.state == InboundHTLCState::RemoteAnnounced {
1607                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce;
1608                                 need_our_commitment = true;
1609                         }
1610                 }
1611                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1612                         if htlc.state == OutboundHTLCState::RemoteRemoved {
1613                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1614                                 need_our_commitment = true;
1615                         }
1616                 }
1617
1618                 self.cur_local_commitment_transaction_number -= 1;
1619                 self.last_local_commitment_txn = new_local_commitment_txn;
1620
1621                 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1622                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1623                         // we'll send one right away when we get the revoke_and_ack when we
1624                         // free_holding_cell_htlcs().
1625                         let (msg, monitor) = self.send_commitment_no_status_check()?;
1626                         (Some(msg), monitor)
1627                 } else { (None, self.channel_monitor.clone()) };
1628
1629                 Ok((msgs::RevokeAndACK {
1630                         channel_id: self.channel_id,
1631                         per_commitment_secret: per_commitment_secret,
1632                         next_per_commitment_point: next_per_commitment_point,
1633                 }, our_commitment_signed, monitor_update))
1634         }
1635
1636         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1637         /// fulfilling or failing the last pending HTLC)
1638         fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1639                 if self.holding_cell_htlc_updates.len() != 0 {
1640                         let mut htlc_updates = Vec::new();
1641                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1642                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1643                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1644                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1645                         let mut err = None;
1646                         for htlc_update in htlc_updates.drain(..) {
1647                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
1648                                 // fee races with adding too many outputs which push our total payments just over
1649                                 // the limit. In case its less rare than I anticipate, we may want to revisit
1650                                 // handling this case better and maybe fufilling some of the HTLCs while attempting
1651                                 // to rebalance channels.
1652                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1653                                         self.holding_cell_htlc_updates.push(htlc_update);
1654                                 } else {
1655                                         match &htlc_update {
1656                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1657                                                         match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1658                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1659                                                                 Err(e) => {
1660                                                                         err = Some(e);
1661                                                                 }
1662                                                         }
1663                                                 },
1664                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1665                                                         match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1666                                                                 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1667                                                                 Err(e) => {
1668                                                                         if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1669                                                                         else {
1670                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1671                                                                         }
1672                                                                 }
1673                                                         }
1674                                                 },
1675                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1676                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1677                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1678                                                                 Err(e) => {
1679                                                                         if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1680                                                                         else {
1681                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1682                                                                         }
1683                                                                 }
1684                                                         }
1685                                                 },
1686                                         }
1687                                         if err.is_some() {
1688                                                 self.holding_cell_htlc_updates.push(htlc_update);
1689                                         }
1690                                 }
1691                         }
1692                         //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1693                         //fail it back the route, if its a temporary issue we can ignore it...
1694                         match err {
1695                                 None => {
1696                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() {
1697                                                 // This should never actually happen and indicates we got some Errs back
1698                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1699                                                 // case there is some strange way to hit duplicate HTLC removes.
1700                                                 return Ok(None);
1701                                         }
1702                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1703                                         Ok(Some((msgs::CommitmentUpdate {
1704                                                 update_add_htlcs,
1705                                                 update_fulfill_htlcs,
1706                                                 update_fail_htlcs,
1707                                                 update_fail_malformed_htlcs: Vec::new(),
1708                                                 commitment_signed,
1709                                         }, monitor_update)))
1710                                 },
1711                                 Some(e) => Err(e)
1712                         }
1713                 } else {
1714                         Ok(None)
1715                 }
1716         }
1717
1718         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1719         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1720         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1721         /// generating an appropriate error *after* the channel state has been updated based on the
1722         /// revoke_and_ack message.
1723         pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1724                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1725                         return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1726                 }
1727                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1728                         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}})});
1729                 }
1730                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1731                         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 {
1732                                 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1733                         }
1734                 }
1735                 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)))?;
1736
1737                 // Update state now that we've passed all the can-fail calls...
1738                 // (note that we may still fail to generate the new commitment_signed message, but that's
1739                 // OK, we step the channel here and *then* if the new generation fails we can fail the
1740                 // channel based on that, but stepping stuff here should be safe either way.
1741                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1742                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1743                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1744                 self.cur_remote_commitment_transaction_number -= 1;
1745
1746                 let mut to_forward_infos = Vec::new();
1747                 let mut revoked_htlcs = Vec::new();
1748                 let mut update_fail_htlcs = Vec::new();
1749                 let mut update_fail_malformed_htlcs = Vec::new();
1750                 let mut require_commitment = false;
1751                 let mut value_to_self_msat_diff: i64 = 0;
1752                 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1753                 self.pending_inbound_htlcs.retain(|htlc| {
1754                         if htlc.state == InboundHTLCState::LocalRemoved {
1755                                 if htlc.local_removed_fulfilled {
1756                                         value_to_self_msat_diff += htlc.amount_msat as i64;
1757                                 }
1758                                 false
1759                         } else { true }
1760                 });
1761                 self.pending_outbound_htlcs.retain(|htlc| {
1762                         if htlc.state == OutboundHTLCState::AwaitingRemovedRemoteRevoke {
1763                                 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1764                                         revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1765                                 } else {
1766                                         // They fulfilled, so we sent them money
1767                                         value_to_self_msat_diff -= htlc.amount_msat as i64;
1768                                 }
1769                                 false
1770                         } else { true }
1771                 });
1772                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1773                         if htlc.state == InboundHTLCState::AwaitingRemoteRevokeToAnnounce {
1774                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke;
1775                                 require_commitment = true;
1776                         } else if htlc.state == InboundHTLCState::AwaitingAnnouncedRemoteRevoke {
1777                                 match htlc.pending_forward_state.take().unwrap() {
1778                                         PendingHTLCStatus::Fail(fail_msg) => {
1779                                                 htlc.state = InboundHTLCState::LocalRemoved;
1780                                                 require_commitment = true;
1781                                                 match fail_msg {
1782                                                         HTLCFailureMsg::Relay(msg) => update_fail_htlcs.push(msg),
1783                                                         HTLCFailureMsg::Malformed(msg) => update_fail_malformed_htlcs.push(msg),
1784                                                 }
1785                                         },
1786                                         PendingHTLCStatus::Forward(forward_info) => {
1787                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
1788                                                 htlc.state = InboundHTLCState::Committed;
1789                                         }
1790                                 }
1791                         }
1792                 }
1793                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1794                         if htlc.state == OutboundHTLCState::LocalAnnounced {
1795                                 htlc.state = OutboundHTLCState::Committed;
1796                         } else if htlc.state == OutboundHTLCState::AwaitingRemoteRevokeToRemove {
1797                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1798                                 require_commitment = true;
1799                         }
1800                 }
1801                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1802
1803                 match self.free_holding_cell_htlcs()? {
1804                         Some(mut commitment_update) => {
1805                                 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
1806                                 for fail_msg in update_fail_htlcs.drain(..) {
1807                                         commitment_update.0.update_fail_htlcs.push(fail_msg);
1808                                 }
1809                                 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
1810                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
1811                                         commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
1812                                 }
1813                                 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
1814                         },
1815                         None => {
1816                                 if require_commitment {
1817                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1818                                         Ok((Some(msgs::CommitmentUpdate {
1819                                                 update_add_htlcs: Vec::new(),
1820                                                 update_fulfill_htlcs: Vec::new(),
1821                                                 update_fail_htlcs,
1822                                                 update_fail_malformed_htlcs,
1823                                                 commitment_signed
1824                                         }), to_forward_infos, revoked_htlcs, monitor_update))
1825                                 } else {
1826                                         Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
1827                                 }
1828                         }
1829                 }
1830         }
1831
1832         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
1833         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
1834         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
1835         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
1836         /// No further message handling calls may be made until a channel_reestablish dance has
1837         /// completed.
1838         pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
1839                 let mut outbound_drops = Vec::new();
1840
1841                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1842                 if self.channel_state < ChannelState::FundingSent as u32 {
1843                         self.channel_state = ChannelState::ShutdownComplete as u32;
1844                         return outbound_drops;
1845                 }
1846
1847                 let mut inbound_drop_count = 0;
1848                 self.pending_inbound_htlcs.retain(|htlc| {
1849                         match htlc.state {
1850                                 InboundHTLCState::RemoteAnnounced => {
1851                                         // They sent us an update_add_htlc but we never got the commitment_signed.
1852                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
1853                                         // this HTLC accordingly
1854                                         inbound_drop_count += 1;
1855                                         false
1856                                 },
1857                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce|InboundHTLCState::AwaitingAnnouncedRemoteRevoke => {
1858                                         // Same goes for AwaitingRemoteRevokeToRemove and AwaitingRemovedRemoteRevoke
1859                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
1860                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
1861                                         // in response to it yet, so don't touch it.
1862                                         true
1863                                 },
1864                                 InboundHTLCState::Committed => true,
1865                                 InboundHTLCState::LocalRemoved => { // Same goes for LocalAnnounced
1866                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
1867                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
1868                                         // (that we missed). Keep this around for now and if they tell us they missed
1869                                         // the commitment_signed we can re-transmit the update then.
1870                                         true
1871                                 },
1872                         }
1873                 });
1874
1875                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1876                         if htlc.state == OutboundHTLCState::RemoteRemoved {
1877                                 // They sent us an update to remove this but haven't yet sent the corresponding
1878                                 // commitment_signed, we need to move it back to Committed and they can re-send
1879                                 // the update upon reconnection.
1880                                 htlc.state = OutboundHTLCState::Committed;
1881                         }
1882                 }
1883
1884                 self.holding_cell_htlc_updates.retain(|htlc_update| {
1885                         match htlc_update {
1886                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
1887                                         outbound_drops.push((source.clone(), payment_hash.clone()));
1888                                         false
1889                                 },
1890                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
1891                         }
1892                 });
1893                 self.channel_state |= ChannelState::PeerDisconnected as u32;
1894                 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()));
1895                 outbound_drops
1896         }
1897
1898         pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1899                 if self.channel_outbound {
1900                         return Err(HandleError{err: "Non-funding remote tried to update channel fee", action: None});
1901                 }
1902                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1903                         return Err(HandleError{err: "Peer sent update_fee when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fee when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1904                 }
1905                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
1906                 self.channel_update_count += 1;
1907                 self.feerate_per_kw = msg.feerate_per_kw as u64;
1908                 Ok(())
1909         }
1910
1911         /// May panic if some calls other than message-handling calls (which will all Err immediately)
1912         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
1913         pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>), HandleError> {
1914                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
1915                         return Err(HandleError{err: "Peer sent a loose channel_reestablish not after reconnect", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent a loose channel_reestablish not after reconnect".to_string(), channel_id: msg.channel_id}})});
1916                 }
1917
1918                 if msg.next_local_commitment_number == 0 || msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
1919                                 msg.next_remote_commitment_number == 0 || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
1920                         return Err(HandleError{err: "Peer send garbage channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer send garbage channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1921                 }
1922
1923                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
1924                 // remaining cases either succeed or ErrorMessage-fail).
1925                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
1926
1927                 let mut required_revoke = None;
1928                 if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
1929                         // Remote isn't waiting on any RevokeAndACK from us!
1930                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
1931                 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
1932                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
1933                         let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
1934                         required_revoke = Some(msgs::RevokeAndACK {
1935                                 channel_id: self.channel_id,
1936                                 per_commitment_secret,
1937                                 next_per_commitment_point,
1938                         });
1939                 } else {
1940                         return Err(HandleError{err: "Peer attempted to reestablish channel with a very old local commitment transaction", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer attempted to reestablish channel with a very old remote commitment transaction".to_string(), channel_id: msg.channel_id}})});
1941                 }
1942
1943                 if msg.next_local_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number {
1944                         if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
1945                                 log_debug!(self, "Reconnected channel {} with no lost commitment txn", log_bytes!(self.channel_id()));
1946                                 if msg.next_local_commitment_number == 1 && msg.next_remote_commitment_number == 1 {
1947                                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
1948                                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
1949                                         return Ok((Some(msgs::FundingLocked {
1950                                                 channel_id: self.channel_id(),
1951                                                 next_per_commitment_point: next_per_commitment_point,
1952                                         }), None, None, None));
1953                                 }
1954                         }
1955
1956                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1957                                 // We're up-to-date and not waiting on a remote revoke (if we are our
1958                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
1959                                 // have received some updates while we were disconnected. Free the holding cell
1960                                 // now!
1961                                 match self.free_holding_cell_htlcs() {
1962                                         Err(e) => {
1963                                                 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
1964                                                 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
1965                                                 } else {
1966                                                         panic!("Got non-channel-failing result from free_holding_cell_htlcs");
1967                                                 }
1968                                                 return Err(e);
1969                                         },
1970                                         Ok(Some((commitment_update, channel_monitor))) => return Ok((None, required_revoke, Some(commitment_update), Some(channel_monitor))),
1971                                         Ok(None) => return Ok((None, required_revoke, None, None)),
1972                                 }
1973                         } else {
1974                                 return Ok((None, required_revoke, None, None));
1975                         }
1976                 } else if msg.next_local_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_remote_commitment_transaction_number {
1977                         return Ok((None, required_revoke,
1978                                         Some(msgs::CommitmentUpdate {
1979                                                 update_add_htlcs: Vec::new(),
1980                                                 update_fulfill_htlcs: Vec::new(),
1981                                                 update_fail_htlcs: Vec::new(),
1982                                                 update_fail_malformed_htlcs: Vec::new(),
1983                                                 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,
1984                                         }), None));
1985                 } else {
1986                         return Err(HandleError{err: "Peer attempted to reestablish channel with a very old remote commitment transaction", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer attempted to reestablish channel with a very old remote commitment transaction".to_string(), channel_id: msg.channel_id}})});
1987                 }
1988         }
1989
1990         pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), HandleError> {
1991                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1992                         return Err(HandleError{err: "Peer sent shutdown when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent shutdown when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1993                 }
1994                 if self.channel_state < ChannelState::FundingSent as u32 {
1995                         self.channel_state = ChannelState::ShutdownComplete as u32;
1996                         self.channel_update_count += 1;
1997                         return Ok((None, None, Vec::new()));
1998                 }
1999                 for htlc in self.pending_inbound_htlcs.iter() {
2000                         if htlc.state == InboundHTLCState::RemoteAnnounced {
2001                                 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
2002                         }
2003                 }
2004                 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
2005                         return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
2006                 }
2007                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2008
2009                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2010                 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2011                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2012                         return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
2013                 }
2014                 //TODO: Check shutdown_scriptpubkey form as BOLT says we must? WHYYY
2015
2016                 if self.their_shutdown_scriptpubkey.is_some() {
2017                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2018                                 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
2019                         }
2020                 } else {
2021                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2022                 }
2023
2024                 let our_closing_script = self.get_closing_scriptpubkey();
2025
2026                 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() {
2027                         let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2028                         if self.feerate_per_kw > proposed_feerate {
2029                                 proposed_feerate = self.feerate_per_kw;
2030                         }
2031                         let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
2032                         let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2033
2034                         let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2035                         let funding_redeemscript = self.get_funding_redeemscript();
2036                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2037
2038                         (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key)))
2039                 } else { (None, None, None) };
2040
2041                 // From here on out, we may not fail!
2042
2043                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2044                 self.channel_update_count += 1;
2045
2046                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2047                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2048                 // cell HTLCs and return them to fail the payment.
2049                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2050                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2051                         match htlc_update {
2052                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2053                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2054                                         false
2055                                 },
2056                                 _ => true
2057                         }
2058                 });
2059                 for htlc in self.pending_outbound_htlcs.iter() {
2060                         if htlc.state == OutboundHTLCState::LocalAnnounced {
2061                                 return Ok((None, None, dropped_outbound_htlcs));
2062                         }
2063                 }
2064
2065                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2066                         None
2067                 } else {
2068                         Some(msgs::Shutdown {
2069                                 channel_id: self.channel_id,
2070                                 scriptpubkey: our_closing_script,
2071                         })
2072                 };
2073
2074                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2075                 self.channel_update_count += 1;
2076                 if self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() && self.channel_outbound {
2077                         // There are no more HTLCs and we're the funder, this means we start the closing_signed
2078                         // dance with an initial fee proposal!
2079                         self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
2080                         Ok((our_shutdown, Some(msgs::ClosingSigned {
2081                                 channel_id: self.channel_id,
2082                                 fee_satoshis: proposed_fee.unwrap(),
2083                                 signature: our_sig.unwrap(),
2084                         }), dropped_outbound_htlcs))
2085                 } else {
2086                         Ok((our_shutdown, None, dropped_outbound_htlcs))
2087                 }
2088         }
2089
2090         pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2091                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2092                         return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2093                 }
2094                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2095                         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}})});
2096                 }
2097                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2098                         return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2099                 }
2100                 if msg.fee_satoshis > 21000000 * 10000000 {
2101                         return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2102                 }
2103
2104                 let funding_redeemscript = self.get_funding_redeemscript();
2105                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2106                 if used_total_fee != msg.fee_satoshis {
2107                         return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2108                 }
2109                 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2110
2111                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2112                         Ok(_) => {},
2113                         Err(_e) => {
2114                                 // The remote end may have decided to revoke their output due to inconsistent dust
2115                                 // limits, so check for that case by re-checking the signature here.
2116                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2117                                 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2118                                 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2119                         },
2120                 };
2121
2122                 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2123                         if last_fee == msg.fee_satoshis {
2124                                 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2125                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2126                                 self.channel_update_count += 1;
2127                                 return Ok((None, Some(closing_tx)));
2128                         }
2129                 }
2130
2131                 macro_rules! propose_new_feerate {
2132                         ($new_feerate: expr) => {
2133                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2134                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2135                                 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2136                                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2137                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2138                                 return Ok((Some(msgs::ClosingSigned {
2139                                         channel_id: self.channel_id,
2140                                         fee_satoshis: used_total_fee,
2141                                         signature: our_sig,
2142                                 }), None))
2143                         }
2144                 }
2145
2146                 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2147                 if self.channel_outbound {
2148                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2149                         if proposed_sat_per_kw > our_max_feerate {
2150                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2151                                         if our_max_feerate <= last_feerate {
2152                                                 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2153                                         }
2154                                 }
2155                                 propose_new_feerate!(our_max_feerate);
2156                         }
2157                 } else {
2158                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2159                         if proposed_sat_per_kw < our_min_feerate {
2160                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2161                                         if our_min_feerate >= last_feerate {
2162                                                 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2163                                         }
2164                                 }
2165                                 propose_new_feerate!(our_min_feerate);
2166                         }
2167                 }
2168
2169                 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2170                 self.channel_state = ChannelState::ShutdownComplete as u32;
2171                 self.channel_update_count += 1;
2172
2173                 Ok((Some(msgs::ClosingSigned {
2174                         channel_id: self.channel_id,
2175                         fee_satoshis: msg.fee_satoshis,
2176                         signature: our_sig,
2177                 }), Some(closing_tx)))
2178         }
2179
2180         // Public utilities:
2181
2182         pub fn channel_id(&self) -> [u8; 32] {
2183                 self.channel_id
2184         }
2185
2186         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2187         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2188         pub fn get_user_id(&self) -> u64 {
2189                 self.user_id
2190         }
2191
2192         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2193         pub fn channel_monitor(&self) -> ChannelMonitor {
2194                 if self.channel_state < ChannelState::FundingCreated as u32 {
2195                         panic!("Can't get a channel monitor until funding has been created");
2196                 }
2197                 self.channel_monitor.clone()
2198         }
2199
2200         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2201         /// is_usable() returns true).
2202         /// Allowed in any state (including after shutdown)
2203         pub fn get_short_channel_id(&self) -> Option<u64> {
2204                 self.short_channel_id
2205         }
2206
2207         /// Returns the funding_txo we either got from our peer, or were given by
2208         /// get_outbound_funding_created.
2209         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2210                 self.channel_monitor.get_funding_txo()
2211         }
2212
2213         /// Allowed in any state (including after shutdown)
2214         pub fn get_their_node_id(&self) -> PublicKey {
2215                 self.their_node_id
2216         }
2217
2218         /// Allowed in any state (including after shutdown)
2219         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2220                 self.our_htlc_minimum_msat
2221         }
2222
2223         pub fn get_value_satoshis(&self) -> u64 {
2224                 self.channel_value_satoshis
2225         }
2226
2227         //TODO: Testing purpose only, should be changed in another way after #81
2228         #[cfg(test)]
2229         pub fn get_local_keys(&self) -> &ChannelKeys {
2230                 &self.local_keys
2231         }
2232
2233         /// Allowed in any state (including after shutdown)
2234         pub fn get_channel_update_count(&self) -> u32 {
2235                 self.channel_update_count
2236         }
2237
2238         pub fn should_announce(&self) -> bool {
2239                 self.announce_publicly
2240         }
2241
2242         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2243         /// Allowed in any state (including after shutdown)
2244         pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2245                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2246                 // output value back into a transaction with the regular channel output:
2247
2248                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2249                 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2250
2251                 if self.channel_outbound {
2252                         // + the marginal fee increase cost to us in the commitment transaction:
2253                         res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2254                 }
2255
2256                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2257                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2258
2259                 res as u32
2260         }
2261
2262         /// Returns true if we've ever received a message from the remote end for this Channel
2263         pub fn have_received_message(&self) -> bool {
2264                 self.channel_state > (ChannelState::OurInitSent as u32)
2265         }
2266
2267         /// Returns true if this channel is fully established and not known to be closing.
2268         /// Allowed in any state (including after shutdown)
2269         pub fn is_usable(&self) -> bool {
2270                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2271                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2272         }
2273
2274         /// Returns true if this channel is currently available for use. This is a superset of
2275         /// is_usable() and considers things like the channel being temporarily disabled.
2276         /// Allowed in any state (including after shutdown)
2277         pub fn is_live(&self) -> bool {
2278                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
2279         }
2280
2281         /// Returns true if funding_created was sent/received.
2282         pub fn is_funding_initiated(&self) -> bool {
2283                 self.channel_state >= ChannelState::FundingCreated as u32
2284         }
2285
2286         /// Returns true if this channel is fully shut down. True here implies that no further actions
2287         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2288         /// will be handled appropriately by the chain monitor.
2289         pub fn is_shutdown(&self) -> bool {
2290                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
2291                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2292                         true
2293                 } else { false }
2294         }
2295
2296         /// Called by channelmanager based on chain blocks being connected.
2297         /// Note that we only need to use this to detect funding_signed, anything else is handled by
2298         /// the channel_monitor.
2299         /// In case of Err, the channel may have been closed, at which point the standard requirements
2300         /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2301         /// Only returns an ErrorAction of DisconnectPeer, if Err.
2302         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2303                 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
2304                 if self.funding_tx_confirmations > 0 {
2305                         if header.bitcoin_hash() != self.last_block_connected {
2306                                 self.last_block_connected = header.bitcoin_hash();
2307                                 self.funding_tx_confirmations += 1;
2308                                 if self.funding_tx_confirmations == Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 {
2309                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2310                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
2311                                                 true
2312                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2313                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
2314                                                 self.channel_update_count += 1;
2315                                                 true
2316                                         } else if self.channel_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2317                                                 // We got a reorg but not enough to trigger a force close, just update
2318                                                 // funding_tx_confirmed_in and return.
2319                                                 false
2320                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2321                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2322                                         } else {
2323                                                 // We got a reorg but not enough to trigger a force close, just update
2324                                                 // funding_tx_confirmed_in and return.
2325                                                 false
2326                                         };
2327                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2328
2329                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2330                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2331                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2332                                         //a protocol oversight, but I assume I'm just missing something.
2333                                         if need_commitment_update {
2334                                                 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2335                                                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2336                                                 return Ok(Some(msgs::FundingLocked {
2337                                                         channel_id: self.channel_id,
2338                                                         next_per_commitment_point: next_per_commitment_point,
2339                                                 }));
2340                                         }
2341                                 }
2342                         }
2343                 }
2344                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2345                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2346                                 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2347                                         let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2348                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2349                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
2350                                                 if self.channel_outbound {
2351                                                         // If we generated the funding transaction and it doesn't match what it
2352                                                         // should, the client is really broken and we should just panic and
2353                                                         // tell them off. That said, because hash collisions happen with high
2354                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
2355                                                         // channel and move on.
2356                                                         #[cfg(not(feature = "fuzztarget"))]
2357                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2358                                                 }
2359                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2360                                                 self.channel_update_count += 1;
2361                                                 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2362                                         } else {
2363                                                 self.funding_tx_confirmations = 1;
2364                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
2365                                                                              ((*index_in_block as u64) << (2*8)) |
2366                                                                              ((txo_idx as u64)         << (0*8)));
2367                                         }
2368                                 }
2369                         }
2370                 }
2371                 Ok(None)
2372         }
2373
2374         /// Called by channelmanager based on chain blocks being disconnected.
2375         /// Returns true if we need to close the channel now due to funding transaction
2376         /// unconfirmation/reorg.
2377         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2378                 if self.funding_tx_confirmations > 0 {
2379                         self.funding_tx_confirmations -= 1;
2380                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2381                                 return true;
2382                         }
2383                 }
2384                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2385                         self.funding_tx_confirmations = Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 - 1;
2386                 }
2387                 false
2388         }
2389
2390         // Methods to get unprompted messages to send to the remote end (or where we already returned
2391         // something in the handler for the message that prompted this message):
2392
2393         pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2394                 if !self.channel_outbound {
2395                         panic!("Tried to open a channel for an inbound channel?");
2396                 }
2397                 if self.channel_state != ChannelState::OurInitSent as u32 {
2398                         panic!("Cannot generate an open_channel after we've moved forward");
2399                 }
2400
2401                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2402                         panic!("Tried to send an open_channel for a channel that has already advanced");
2403                 }
2404
2405                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2406
2407                 msgs::OpenChannel {
2408                         chain_hash: chain_hash,
2409                         temporary_channel_id: self.channel_id,
2410                         funding_satoshis: self.channel_value_satoshis,
2411                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2412                         dust_limit_satoshis: self.our_dust_limit_satoshis,
2413                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2414                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2415                         htlc_minimum_msat: self.our_htlc_minimum_msat,
2416                         feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2417                         to_self_delay: BREAKDOWN_TIMEOUT,
2418                         max_accepted_htlcs: OUR_MAX_HTLCS,
2419                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2420                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2421                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2422                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2423                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2424                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2425                         channel_flags: if self.announce_publicly {1} else {0},
2426                         shutdown_scriptpubkey: None,
2427                 }
2428         }
2429
2430         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2431                 if self.channel_outbound {
2432                         panic!("Tried to send accept_channel for an outbound channel?");
2433                 }
2434                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2435                         panic!("Tried to send accept_channel after channel had moved forward");
2436                 }
2437                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2438                         panic!("Tried to send an accept_channel for a channel that has already advanced");
2439                 }
2440
2441                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2442
2443                 msgs::AcceptChannel {
2444                         temporary_channel_id: self.channel_id,
2445                         dust_limit_satoshis: self.our_dust_limit_satoshis,
2446                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2447                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2448                         htlc_minimum_msat: self.our_htlc_minimum_msat,
2449                         minimum_depth: Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat),
2450                         to_self_delay: BREAKDOWN_TIMEOUT,
2451                         max_accepted_htlcs: OUR_MAX_HTLCS,
2452                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2453                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2454                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2455                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2456                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2457                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2458                         shutdown_scriptpubkey: None,
2459                 }
2460         }
2461
2462         fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2463                 let funding_script = self.get_funding_redeemscript();
2464
2465                 let remote_keys = self.build_remote_transaction_keys()?;
2466                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
2467                 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();
2468
2469                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2470                 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2471         }
2472
2473         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2474         /// a funding_created message for the remote peer.
2475         /// Panics if called at some time other than immediately after initial handshake, if called twice,
2476         /// or if called on an inbound channel.
2477         /// Note that channel_id changes during this call!
2478         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2479         pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2480                 if !self.channel_outbound {
2481                         panic!("Tried to create outbound funding_created message on an inbound channel!");
2482                 }
2483                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2484                         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)");
2485                 }
2486                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2487                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2488                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2489                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2490                 }
2491
2492                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2493                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2494
2495                 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2496                         Ok(res) => res,
2497                         Err(e) => {
2498                                 log_error!(self, "Got bad signatures: {}!", e.err);
2499                                 self.channel_monitor.unset_funding_info();
2500                                 return Err(e);
2501                         }
2502                 };
2503
2504                 let temporary_channel_id = self.channel_id;
2505
2506                 // Now that we're past error-generating stuff, update our local state:
2507                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2508                 self.channel_state = ChannelState::FundingCreated as u32;
2509                 self.channel_id = funding_txo.to_channel_id();
2510                 self.cur_remote_commitment_transaction_number -= 1;
2511
2512                 Ok((msgs::FundingCreated {
2513                         temporary_channel_id: temporary_channel_id,
2514                         funding_txid: funding_txo.txid,
2515                         funding_output_index: funding_txo.index,
2516                         signature: our_signature
2517                 }, self.channel_monitor.clone()))
2518         }
2519
2520         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2521         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2522         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
2523         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2524         /// Will only fail if we're not in a state where channel_announcement may be sent (including
2525         /// closing).
2526         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
2527         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
2528         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), HandleError> {
2529                 if !self.announce_publicly {
2530                         return Err(HandleError{err: "Channel is not available for public announcements", action: Some(msgs::ErrorAction::IgnoreError)});
2531                 }
2532                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
2533                         return Err(HandleError{err: "Cannot get a ChannelAnnouncement until the channel funding has been locked", action: Some(msgs::ErrorAction::IgnoreError)});
2534                 }
2535                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
2536                         return Err(HandleError{err: "Cannot get a ChannelAnnouncement once the channel is closing", action: Some(msgs::ErrorAction::IgnoreError)});
2537                 }
2538
2539                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2540                 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
2541
2542                 let msg = msgs::UnsignedChannelAnnouncement {
2543                         features: msgs::GlobalFeatures::new(),
2544                         chain_hash: chain_hash,
2545                         short_channel_id: self.get_short_channel_id().unwrap(),
2546                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2547                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2548                         bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
2549                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
2550                         excess_data: Vec::new(),
2551                 };
2552
2553                 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2554                 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
2555
2556                 Ok((msg, sig))
2557         }
2558
2559         /// May panic if called on a channel that wasn't immediately-previously
2560         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
2561         pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
2562                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
2563                 msgs::ChannelReestablish {
2564                         channel_id: self.channel_id(),
2565                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
2566                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number,
2567                         data_loss_protect: None,
2568                 }
2569         }
2570
2571
2572         // Send stuff to our remote peers:
2573
2574         /// Adds a pending outbound HTLC to this channel, note that you probably want
2575         /// send_htlc_and_commit instead cause you'll want both messages at once.
2576         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2577         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
2578         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
2579         /// You MUST call send_commitment prior to any other calls on this Channel
2580         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> {
2581                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
2582                         return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
2583                 }
2584
2585                 if amount_msat > self.channel_value_satoshis * 1000 {
2586                         return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
2587                 }
2588                 if amount_msat < self.their_htlc_minimum_msat {
2589                         return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
2590                 }
2591
2592                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2593                         // Note that this should never really happen, if we're !is_live() on receipt of an
2594                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
2595                         // the user to send directly into a !is_live() channel. However, if we
2596                         // disconnected during the time the previous hop was doing the commitment dance we may
2597                         // end up getting here after the forwarding delay. In any case, returning an
2598                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
2599                         return Err(HandleError{err: "Cannot send an HTLC while disconnected", action: Some(ErrorAction::IgnoreError)});
2600                 }
2601
2602                 let (_, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(false);
2603                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
2604                         return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
2605                 }
2606                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
2607                 // Check their_max_htlc_value_in_flight_msat
2608                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
2609                         return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
2610                 }
2611                 // Check their_channel_reserve_satoshis:
2612                 if htlc_inbound_value_msat + htlc_outbound_value_msat + amount_msat + (self.channel_value_satoshis * 1000 - self.value_to_self_msat) > (self.channel_value_satoshis - self.their_channel_reserve_satoshis) * 1000 {
2613                         return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
2614                 }
2615
2616                 //TODO: Check cltv_expiry? Do this in channel manager?
2617
2618                 // Now update local state:
2619                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2620                         //TODO: Check the limits *including* other pending holding cell HTLCs!
2621                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
2622                                 amount_msat: amount_msat,
2623                                 payment_hash: payment_hash,
2624                                 cltv_expiry: cltv_expiry,
2625                                 source,
2626                                 onion_routing_packet: onion_routing_packet,
2627                                 time_created: Instant::now(),
2628                         });
2629                         return Ok(None);
2630                 }
2631
2632                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
2633                         htlc_id: self.next_local_htlc_id,
2634                         amount_msat: amount_msat,
2635                         payment_hash: payment_hash.clone(),
2636                         cltv_expiry: cltv_expiry,
2637                         state: OutboundHTLCState::LocalAnnounced,
2638                         source,
2639                         fail_reason: None,
2640                 });
2641
2642                 let res = msgs::UpdateAddHTLC {
2643                         channel_id: self.channel_id,
2644                         htlc_id: self.next_local_htlc_id,
2645                         amount_msat: amount_msat,
2646                         payment_hash: payment_hash,
2647                         cltv_expiry: cltv_expiry,
2648                         onion_routing_packet: onion_routing_packet,
2649                 };
2650                 self.next_local_htlc_id += 1;
2651
2652                 Ok(Some(res))
2653         }
2654
2655         /// Creates a signed commitment transaction to send to the remote peer.
2656         /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
2657         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
2658         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
2659         pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2660                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2661                         panic!("Cannot create commitment tx until channel is fully established");
2662                 }
2663                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2664                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
2665                 }
2666                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2667                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
2668                 }
2669                 let mut have_updates = false; // TODO initialize with "have we sent a fee update?"
2670                 for htlc in self.pending_outbound_htlcs.iter() {
2671                         if htlc.state == OutboundHTLCState::LocalAnnounced {
2672                                 have_updates = true;
2673                         }
2674                         if have_updates { break; }
2675                 }
2676                 if !have_updates {
2677                         panic!("Cannot create commitment tx until we have some updates to send");
2678                 }
2679                 self.send_commitment_no_status_check()
2680         }
2681         /// Only fails in case of bad keys
2682         fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2683                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
2684                 // fail to generate this, we still are at least at a position where upgrading their status
2685                 // is acceptable.
2686                 for htlc in self.pending_inbound_htlcs.iter_mut() {
2687                         if htlc.state == InboundHTLCState::AwaitingRemoteRevokeToAnnounce {
2688                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke;
2689                         }
2690                 }
2691                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2692                         if htlc.state == OutboundHTLCState::AwaitingRemoteRevokeToRemove {
2693                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
2694                         }
2695                 }
2696
2697                 match self.send_commitment_no_state_update() {
2698                         Ok((res, remote_commitment_tx)) => {
2699                                 // Update state now that we've passed all the can-fail calls...
2700                                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
2701                                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
2702                                 Ok((res, self.channel_monitor.clone()))
2703                         },
2704                         Err(e) => Err(e),
2705                 }
2706         }
2707
2708         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
2709         /// when we shouldn't change HTLC/channel state.
2710         fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
2711                 let funding_script = self.get_funding_redeemscript();
2712
2713                 let remote_keys = self.build_remote_transaction_keys()?;
2714                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true);
2715                 let remote_commitment_txid = remote_commitment_tx.0.txid();
2716                 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();
2717                 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
2718
2719                 let mut htlc_sigs = Vec::new();
2720
2721                 for ref htlc in remote_commitment_tx.1.iter() {
2722                         let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys);
2723                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
2724                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2725                         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());
2726                         htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
2727                 }
2728
2729                 Ok((msgs::CommitmentSigned {
2730                         channel_id: self.channel_id,
2731                         signature: our_sig,
2732                         htlc_signatures: htlc_sigs,
2733                 }, remote_commitment_tx))
2734         }
2735
2736         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
2737         /// to send to the remote peer in one go.
2738         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
2739         /// more info.
2740         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> {
2741                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
2742                         Some(update_add_htlc) => {
2743                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2744                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
2745                         },
2746                         None => Ok(None)
2747                 }
2748         }
2749
2750         /// Begins the shutdown process, getting a message for the remote peer and returning all
2751         /// holding cell HTLCs for payment failure.
2752         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), HandleError> {
2753                 for htlc in self.pending_outbound_htlcs.iter() {
2754                         if htlc.state == OutboundHTLCState::LocalAnnounced {
2755                                 return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", action: None});
2756                         }
2757                 }
2758                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
2759                         return Err(HandleError{err: "Shutdown already in progress", action: None});
2760                 }
2761                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2762                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2763                         return Err(HandleError{err: "Cannot begin shutdown while peer is disconnected, maybe force-close instead?", action: None});
2764                 }
2765
2766                 let our_closing_script = self.get_closing_scriptpubkey();
2767
2768                 // From here on out, we may not fail!
2769                 if self.channel_state < ChannelState::FundingSent as u32 {
2770                         self.channel_state = ChannelState::ShutdownComplete as u32;
2771                 } else {
2772                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
2773                 }
2774                 self.channel_update_count += 1;
2775
2776                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2777                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2778                 // cell HTLCs and return them to fail the payment.
2779                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2780                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2781                         match htlc_update {
2782                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2783                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2784                                         false
2785                                 },
2786                                 _ => true
2787                         }
2788                 });
2789
2790                 Ok((msgs::Shutdown {
2791                         channel_id: self.channel_id,
2792                         scriptpubkey: our_closing_script,
2793                 }, dropped_outbound_htlcs))
2794         }
2795
2796         /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
2797         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
2798         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
2799         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
2800         /// immediately (others we will have to allow to time out).
2801         pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
2802                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
2803
2804                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
2805                 // return them to fail the payment.
2806                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2807                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
2808                         match htlc_update {
2809                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
2810                                         dropped_outbound_htlcs.push((source, payment_hash));
2811                                 },
2812                                 _ => {}
2813                         }
2814                 }
2815
2816                 for _htlc in self.pending_outbound_htlcs.drain(..) {
2817                         //TODO: Do something with the remaining HTLCs
2818                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
2819                         //which correspond)
2820                 }
2821
2822                 self.channel_state = ChannelState::ShutdownComplete as u32;
2823                 self.channel_update_count += 1;
2824                 let mut res = Vec::new();
2825                 mem::swap(&mut res, &mut self.last_local_commitment_txn);
2826                 (res, dropped_outbound_htlcs)
2827         }
2828 }
2829
2830 #[cfg(test)]
2831 mod tests {
2832         use bitcoin::util::hash::Sha256dHash;
2833         use bitcoin::util::bip143;
2834         use bitcoin::network::serialize::serialize;
2835         use bitcoin::blockdata::script::Script;
2836         use bitcoin::blockdata::transaction::Transaction;
2837         use hex;
2838         use ln::channelmanager::HTLCSource;
2839         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
2840         use ln::channel::MAX_FUNDING_SATOSHIS;
2841         use ln::chan_utils;
2842         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
2843         use chain::transaction::OutPoint;
2844         use util::test_utils;
2845         use util::logger::Logger;
2846         use secp256k1::{Secp256k1,Message,Signature};
2847         use secp256k1::key::{SecretKey,PublicKey};
2848         use crypto::sha2::Sha256;
2849         use crypto::digest::Digest;
2850         use std::sync::Arc;
2851
2852         struct TestFeeEstimator {
2853                 fee_est: u64
2854         }
2855         impl FeeEstimator for TestFeeEstimator {
2856                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
2857                         self.fee_est
2858                 }
2859         }
2860
2861         #[test]
2862         fn test_max_funding_satoshis() {
2863                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
2864                         "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
2865         }
2866
2867         #[test]
2868         fn outbound_commitment_test() {
2869                 // Test vectors from BOLT 3 Appendix C:
2870                 let feeest = TestFeeEstimator{fee_est: 15000};
2871                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2872                 let secp_ctx = Secp256k1::new();
2873
2874                 let chan_keys = ChannelKeys {
2875                         funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
2876                         payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2877                         delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
2878                         htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2879
2880                         // These aren't set in the test vectors:
2881                         revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2882                         channel_close_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2883                         channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2884                         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],
2885                 };
2886                 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
2887                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
2888
2889                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
2890                 let mut chan = Channel::new_outbound(&feeest, chan_keys, their_node_id, 10000000, 100000, false, 42, Arc::clone(&logger)).unwrap(); // Nothing uses their network key in this test
2891                 chan.their_to_self_delay = 144;
2892                 chan.our_dust_limit_satoshis = 546;
2893
2894                 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
2895                 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
2896
2897                 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
2898                 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
2899                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2900
2901                 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
2902                 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
2903                                 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
2904
2905                 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
2906                 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
2907                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2908
2909                 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
2910
2911                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
2912                 // derived from a commitment_seed, so instead we copy it here and call
2913                 // build_commitment_transaction.
2914                 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
2915                 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
2916                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
2917                 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
2918                 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();
2919
2920                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
2921
2922                 macro_rules! test_commitment {
2923                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
2924                                 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false);
2925                                 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2926                                 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();
2927                                 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
2928
2929                                 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
2930
2931                                 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
2932                                                 hex::decode($tx_hex).unwrap()[..]);
2933                         };
2934                 }
2935
2936                 macro_rules! test_htlc_output {
2937                         ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
2938                                 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2939
2940                                 let ref htlc = unsigned_tx.1[$htlc_idx];
2941                                 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys);
2942                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2943                                 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2944                                 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
2945
2946                                 let mut preimage: Option<[u8; 32]> = None;
2947                                 if !htlc.offered {
2948                                         for i in 0..5 {
2949                                                 let mut sha = Sha256::new();
2950                                                 sha.input(&[i; 32]);
2951
2952                                                 let mut out = [0; 32];
2953                                                 sha.result(&mut out);
2954
2955                                                 if out == htlc.payment_hash {
2956                                                         preimage = Some([i; 32]);
2957                                                 }
2958                                         }
2959
2960                                         assert!(preimage.is_some());
2961                                 }
2962
2963                                 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
2964                                 assert_eq!(serialize(&htlc_tx).unwrap()[..],
2965                                                 hex::decode($tx_hex).unwrap()[..]);
2966                         };
2967                 }
2968
2969                 {
2970                         // simple commitment tx with no HTLCs
2971                         chan.value_to_self_msat = 7000000000;
2972
2973                         test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
2974                                          "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
2975                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2976                 }
2977
2978                 chan.pending_inbound_htlcs.push({
2979                         let mut out = InboundHTLCOutput{
2980                                 htlc_id: 0,
2981                                 amount_msat: 1000000,
2982                                 cltv_expiry: 500,
2983                                 payment_hash: [0; 32],
2984                                 state: InboundHTLCState::Committed,
2985                                 local_removed_fulfilled: false,
2986                                 pending_forward_state: None,
2987                         };
2988                         let mut sha = Sha256::new();
2989                         sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
2990                         sha.result(&mut out.payment_hash);
2991                         out
2992                 });
2993                 chan.pending_inbound_htlcs.push({
2994                         let mut out = InboundHTLCOutput{
2995                                 htlc_id: 1,
2996                                 amount_msat: 2000000,
2997                                 cltv_expiry: 501,
2998                                 payment_hash: [0; 32],
2999                                 state: InboundHTLCState::Committed,
3000                                 local_removed_fulfilled: false,
3001                                 pending_forward_state: None,
3002                         };
3003                         let mut sha = Sha256::new();
3004                         sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3005                         sha.result(&mut out.payment_hash);
3006                         out
3007                 });
3008                 chan.pending_outbound_htlcs.push({
3009                         let mut out = OutboundHTLCOutput{
3010                                 htlc_id: 2,
3011                                 amount_msat: 2000000,
3012                                 cltv_expiry: 502,
3013                                 payment_hash: [0; 32],
3014                                 state: OutboundHTLCState::Committed,
3015                                 source: HTLCSource::dummy(),
3016                                 fail_reason: None,
3017                         };
3018                         let mut sha = Sha256::new();
3019                         sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3020                         sha.result(&mut out.payment_hash);
3021                         out
3022                 });
3023                 chan.pending_outbound_htlcs.push({
3024                         let mut out = OutboundHTLCOutput{
3025                                 htlc_id: 3,
3026                                 amount_msat: 3000000,
3027                                 cltv_expiry: 503,
3028                                 payment_hash: [0; 32],
3029                                 state: OutboundHTLCState::Committed,
3030                                 source: HTLCSource::dummy(),
3031                                 fail_reason: None,
3032                         };
3033                         let mut sha = Sha256::new();
3034                         sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
3035                         sha.result(&mut out.payment_hash);
3036                         out
3037                 });
3038                 chan.pending_inbound_htlcs.push({
3039                         let mut out = InboundHTLCOutput{
3040                                 htlc_id: 4,
3041                                 amount_msat: 4000000,
3042                                 cltv_expiry: 504,
3043                                 payment_hash: [0; 32],
3044                                 state: InboundHTLCState::Committed,
3045                                 local_removed_fulfilled: false,
3046                                 pending_forward_state: None,
3047                         };
3048                         let mut sha = Sha256::new();
3049                         sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
3050                         sha.result(&mut out.payment_hash);
3051                         out
3052                 });
3053
3054                 {
3055                         // commitment tx with all five HTLCs untrimmed (minimum feerate)
3056                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3057                         chan.feerate_per_kw = 0;
3058
3059                         test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
3060                                          "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
3061                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3062
3063                         assert_eq!(unsigned_tx.1.len(), 5);
3064
3065                         test_htlc_output!(0,
3066                                           "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
3067                                           "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
3068                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3069
3070                         test_htlc_output!(1,
3071                                           "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
3072                                           "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
3073                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3074
3075                         test_htlc_output!(2,
3076                                           "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
3077                                           "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
3078                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3079
3080                         test_htlc_output!(3,
3081                                           "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
3082                                           "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
3083                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3084
3085                         test_htlc_output!(4,
3086                                           "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
3087                                           "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
3088                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3089                 }
3090
3091                 {
3092                         // commitment tx with seven outputs untrimmed (maximum feerate)
3093                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3094                         chan.feerate_per_kw = 647;
3095
3096                         test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
3097                                          "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
3098                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3099
3100                         assert_eq!(unsigned_tx.1.len(), 5);
3101
3102                         test_htlc_output!(0,
3103                                           "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
3104                                           "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
3105                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3106
3107                         test_htlc_output!(1,
3108                                           "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
3109                                           "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
3110                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3111
3112                         test_htlc_output!(2,
3113                                           "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
3114                                           "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
3115                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3116
3117                         test_htlc_output!(3,
3118                                           "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
3119                                           "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
3120                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3121
3122                         test_htlc_output!(4,
3123                                           "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
3124                                           "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
3125                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3126                 }
3127
3128                 {
3129                         // commitment tx with six outputs untrimmed (minimum feerate)
3130                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3131                         chan.feerate_per_kw = 648;
3132
3133                         test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
3134                                          "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
3135                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3136
3137                         assert_eq!(unsigned_tx.1.len(), 4);
3138
3139                         test_htlc_output!(0,
3140                                           "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
3141                                           "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
3142                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3143
3144                         test_htlc_output!(1,
3145                                           "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
3146                                           "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
3147                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3148
3149                         test_htlc_output!(2,
3150                                           "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
3151                                           "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
3152                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3153
3154                         test_htlc_output!(3,
3155                                           "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
3156                                           "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
3157                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3158                 }
3159
3160                 {
3161                         // commitment tx with six outputs untrimmed (maximum feerate)
3162                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3163                         chan.feerate_per_kw = 2069;
3164
3165                         test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
3166                                          "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
3167                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3168
3169                         assert_eq!(unsigned_tx.1.len(), 4);
3170
3171                         test_htlc_output!(0,
3172                                           "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
3173                                           "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
3174                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3175
3176                         test_htlc_output!(1,
3177                                           "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
3178                                           "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
3179                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3180
3181                         test_htlc_output!(2,
3182                                           "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
3183                                           "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
3184                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3185
3186                         test_htlc_output!(3,
3187                                           "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
3188                                           "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
3189                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3190                 }
3191
3192                 {
3193                         // commitment tx with five outputs untrimmed (minimum feerate)
3194                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3195                         chan.feerate_per_kw = 2070;
3196
3197                         test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
3198                                          "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
3199                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3200
3201                         assert_eq!(unsigned_tx.1.len(), 3);
3202
3203                         test_htlc_output!(0,
3204                                           "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
3205                                           "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
3206                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3207
3208                         test_htlc_output!(1,
3209                                           "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
3210                                           "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
3211                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3212
3213                         test_htlc_output!(2,
3214                                           "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
3215                                           "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
3216                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3217                 }
3218
3219                 {
3220                         // commitment tx with five outputs untrimmed (maximum feerate)
3221                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3222                         chan.feerate_per_kw = 2194;
3223
3224                         test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
3225                                          "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
3226                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3227
3228                         assert_eq!(unsigned_tx.1.len(), 3);
3229
3230                         test_htlc_output!(0,
3231                                           "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
3232                                           "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
3233                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3234
3235                         test_htlc_output!(1,
3236                                           "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
3237                                           "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
3238                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3239
3240                         test_htlc_output!(2,
3241                                           "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
3242                                           "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
3243                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3244                 }
3245
3246                 {
3247                         // commitment tx with four outputs untrimmed (minimum feerate)
3248                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3249                         chan.feerate_per_kw = 2195;
3250
3251                         test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
3252                                          "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
3253                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3254
3255                         assert_eq!(unsigned_tx.1.len(), 2);
3256
3257                         test_htlc_output!(0,
3258                                           "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
3259                                           "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
3260                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3261
3262                         test_htlc_output!(1,
3263                                           "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
3264                                           "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
3265                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3266                 }
3267
3268                 {
3269                         // commitment tx with four outputs untrimmed (maximum feerate)
3270                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3271                         chan.feerate_per_kw = 3702;
3272
3273                         test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
3274                                          "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
3275                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3276
3277                         assert_eq!(unsigned_tx.1.len(), 2);
3278
3279                         test_htlc_output!(0,
3280                                           "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
3281                                           "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
3282                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3283
3284                         test_htlc_output!(1,
3285                                           "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
3286                                           "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
3287                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3288                 }
3289
3290                 {
3291                         // commitment tx with three outputs untrimmed (minimum feerate)
3292                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3293                         chan.feerate_per_kw = 3703;
3294
3295                         test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
3296                                          "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
3297                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3298
3299                         assert_eq!(unsigned_tx.1.len(), 1);
3300
3301                         test_htlc_output!(0,
3302                                           "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
3303                                           "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
3304                                           "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3305                 }
3306
3307                 {
3308                         // commitment tx with three outputs untrimmed (maximum feerate)
3309                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3310                         chan.feerate_per_kw = 4914;
3311
3312                         test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
3313                                          "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
3314                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3315
3316                         assert_eq!(unsigned_tx.1.len(), 1);
3317
3318                         test_htlc_output!(0,
3319                                           "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
3320                                           "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
3321                                           "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3322                 }
3323
3324                 {
3325                         // commitment tx with two outputs untrimmed (minimum feerate)
3326                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3327                         chan.feerate_per_kw = 4915;
3328
3329                         test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
3330                                          "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
3331                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3332
3333                         assert_eq!(unsigned_tx.1.len(), 0);
3334                 }
3335
3336                 {
3337                         // commitment tx with two outputs untrimmed (maximum feerate)
3338                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3339                         chan.feerate_per_kw = 9651180;
3340
3341                         test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
3342                                          "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
3343                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3344
3345                         assert_eq!(unsigned_tx.1.len(), 0);
3346                 }
3347
3348                 {
3349                         // commitment tx with one output untrimmed (minimum feerate)
3350                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3351                         chan.feerate_per_kw = 9651181;
3352
3353                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3354                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3355                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3356
3357                         assert_eq!(unsigned_tx.1.len(), 0);
3358                 }
3359
3360                 {
3361                         // commitment tx with fee greater than funder amount
3362                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3363                         chan.feerate_per_kw = 9651936;
3364
3365                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3366                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3367                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3368
3369                         assert_eq!(unsigned_tx.1.len(), 0);
3370                 }
3371         }
3372
3373         #[test]
3374         fn test_per_commitment_secret_gen() {
3375                 // Test vectors from BOLT 3 Appendix D:
3376
3377                 let mut seed = [0; 32];
3378                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3379                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3380                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
3381
3382                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
3383                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3384                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
3385
3386                 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
3387                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
3388
3389                 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
3390                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
3391
3392                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3393                 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
3394                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
3395         }
3396
3397         #[test]
3398         fn test_key_derivation() {
3399                 // Test vectors from BOLT 3 Appendix E:
3400                 let secp_ctx = Secp256k1::new();
3401
3402                 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
3403                 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3404
3405                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
3406                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
3407
3408                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3409                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
3410
3411                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3412                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
3413
3414                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
3415                                 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
3416
3417                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3418                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
3419
3420                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
3421                                 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
3422         }
3423 }