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