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

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