git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/chain/package.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! Various utilities to assemble claimable outpoints in package of one or more transactions. Those
  11 //! packages are attached metadata, guiding their aggregable or fee-bumping re-schedule. This file
  12 //! also includes witness weight computation and fee computation methods.
  13
  14
  15 use bitcoin::{Sequence, Witness};
  16 use bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
  17 use bitcoin::blockdata::locktime::absolute::LockTime;
  18 use bitcoin::blockdata::transaction::{TxOut,TxIn, Transaction};
  19 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
  20 use bitcoin::blockdata::script::{Script, ScriptBuf};
  21 use bitcoin::hash_types::Txid;
  22 use bitcoin::secp256k1::{SecretKey,PublicKey};
  23 use bitcoin::sighash::EcdsaSighashType;
  24
  25 use crate::ln::PaymentPreimage;
  26 use crate::ln::chan_utils::{self, TxCreationKeys, HTLCOutputInCommitment};
  27 use crate::ln::features::ChannelTypeFeatures;
  28 use crate::ln::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint};
  29 use crate::ln::msgs::DecodeError;
  30 use crate::chain::chaininterface::{FeeEstimator, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT, compute_feerate_sat_per_1000_weight, FEERATE_FLOOR_SATS_PER_KW};
  31 use crate::chain::transaction::MaybeSignedTransaction;
  32 use crate::sign::ecdsa::WriteableEcdsaChannelSigner;
  33 use crate::chain::onchaintx::{FeerateStrategy, ExternalHTLCClaim, OnchainTxHandler};
  34 use crate::util::logger::Logger;
  35 use crate::util::ser::{Readable, Writer, Writeable, RequiredWrapper};
  36
  37 use crate::io;
  38 use core::cmp;
  39 use core::mem;
  40 use core::ops::Deref;
  41
  42 #[allow(unused_imports)]
  43 use crate::prelude::*;
  44
  45 use super::chaininterface::LowerBoundedFeeEstimator;
  46
  47 const MAX_ALLOC_SIZE: usize = 64*1024;
  48
  49
  50 pub(crate) fn weight_revoked_offered_htlc(channel_type_features: &ChannelTypeFeatures) -> u64 {
  51         // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
  52         const WEIGHT_REVOKED_OFFERED_HTLC: u64 = 1 + 1 + 73 + 1 + 33 + 1 + 133;
  53         const WEIGHT_REVOKED_OFFERED_HTLC_ANCHORS: u64 = WEIGHT_REVOKED_OFFERED_HTLC + 3; // + OP_1 + OP_CSV + OP_DROP
  54         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { WEIGHT_REVOKED_OFFERED_HTLC_ANCHORS } else { WEIGHT_REVOKED_OFFERED_HTLC }
  55 }
  56
  57 pub(crate) fn weight_revoked_received_htlc(channel_type_features: &ChannelTypeFeatures) -> u64 {
  58         // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
  59         const WEIGHT_REVOKED_RECEIVED_HTLC: u64 = 1 + 1 + 73 + 1 + 33 + 1 +  139;
  60         const WEIGHT_REVOKED_RECEIVED_HTLC_ANCHORS: u64 = WEIGHT_REVOKED_RECEIVED_HTLC + 3; // + OP_1 + OP_CSV + OP_DROP
  61         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { WEIGHT_REVOKED_RECEIVED_HTLC_ANCHORS } else { WEIGHT_REVOKED_RECEIVED_HTLC }
  62 }
  63
  64 pub(crate) fn weight_offered_htlc(channel_type_features: &ChannelTypeFeatures) -> u64 {
  65         // number_of_witness_elements + sig_length + counterpartyhtlc_sig  + preimage_length + preimage + witness_script_length + witness_script
  66         const WEIGHT_OFFERED_HTLC: u64 = 1 + 1 + 73 + 1 + 32 + 1 + 133;
  67         const WEIGHT_OFFERED_HTLC_ANCHORS: u64 = WEIGHT_OFFERED_HTLC + 3; // + OP_1 + OP_CSV + OP_DROP
  68         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { WEIGHT_OFFERED_HTLC_ANCHORS } else { WEIGHT_OFFERED_HTLC }
  69 }
  70
  71 pub(crate) fn weight_received_htlc(channel_type_features: &ChannelTypeFeatures) -> u64 {
  72         // number_of_witness_elements + sig_length + counterpartyhtlc_sig + empty_vec_length + empty_vec + witness_script_length + witness_script
  73         const WEIGHT_RECEIVED_HTLC: u64 = 1 + 1 + 73 + 1 + 1 + 1 + 139;
  74         const WEIGHT_RECEIVED_HTLC_ANCHORS: u64 = WEIGHT_RECEIVED_HTLC + 3; // + OP_1 + OP_CSV + OP_DROP
  75         if channel_type_features.supports_anchors_zero_fee_htlc_tx() { WEIGHT_RECEIVED_HTLC_ANCHORS } else { WEIGHT_RECEIVED_HTLC }
  76 }
  77
  78 /// Verifies deserializable channel type features
  79 pub(crate) fn verify_channel_type_features(channel_type_features: &Option<ChannelTypeFeatures>, additional_permitted_features: Option<&ChannelTypeFeatures>) -> Result<(), DecodeError> {
  80         if let Some(features) = channel_type_features.as_ref() {
  81                 if features.requires_unknown_bits() {
  82                         return Err(DecodeError::UnknownRequiredFeature);
  83                 }
  84
  85                 let mut supported_feature_set = ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies();
  86                 supported_feature_set.set_scid_privacy_required();
  87                 supported_feature_set.set_zero_conf_required();
  88
  89                 // allow the passing of an additional necessary permitted flag
  90                 if let Some(additional_permitted_features) = additional_permitted_features {
  91                         supported_feature_set |= additional_permitted_features;
  92                 }
  93
  94                 if !features.is_subset(&supported_feature_set) {
  95                         return Err(DecodeError::UnknownRequiredFeature);
  96                 }
  97         }
  98
  99         Ok(())
 100 }
 101
 102 // number_of_witness_elements + sig_length + revocation_sig + true_length + op_true + witness_script_length + witness_script
 103 pub(crate) const WEIGHT_REVOKED_OUTPUT: u64 = 1 + 1 + 73 + 1 + 1 + 1 + 77;
 104
 105 /// Height delay at which transactions are fee-bumped/rebroadcasted with a low priority.
 106 const LOW_FREQUENCY_BUMP_INTERVAL: u32 = 15;
 107 /// Height delay at which transactions are fee-bumped/rebroadcasted with a middle priority.
 108 const MIDDLE_FREQUENCY_BUMP_INTERVAL: u32 = 3;
 109 /// Height delay at which transactions are fee-bumped/rebroadcasted with a high priority.
 110 const HIGH_FREQUENCY_BUMP_INTERVAL: u32 = 1;
 111
 112 /// A struct to describe a revoked output and corresponding information to generate a solving
 113 /// witness spending a commitment `to_local` output or a second-stage HTLC transaction output.
 114 ///
 115 /// CSV and pubkeys are used as part of a witnessScript redeeming a balance output, amount is used
 116 /// as part of the signature hash and revocation secret to generate a satisfying witness.
 117 #[derive(Clone, PartialEq, Eq)]
 118 pub(crate) struct RevokedOutput {
 119         per_commitment_point: PublicKey,
 120         counterparty_delayed_payment_base_key: DelayedPaymentBasepoint,
 121         counterparty_htlc_base_key: HtlcBasepoint,
 122         per_commitment_key: SecretKey,
 123         weight: u64,
 124         amount: u64,
 125         on_counterparty_tx_csv: u16,
 126         is_counterparty_balance_on_anchors: Option<()>,
 127 }
 128
 129 impl RevokedOutput {
 130         pub(crate) fn build(per_commitment_point: PublicKey, counterparty_delayed_payment_base_key: DelayedPaymentBasepoint, counterparty_htlc_base_key: HtlcBasepoint, per_commitment_key: SecretKey, amount: u64, on_counterparty_tx_csv: u16, is_counterparty_balance_on_anchors: bool) -> Self {
 131                 RevokedOutput {
 132                         per_commitment_point,
 133                         counterparty_delayed_payment_base_key,
 134                         counterparty_htlc_base_key,
 135                         per_commitment_key,
 136                         weight: WEIGHT_REVOKED_OUTPUT,
 137                         amount,
 138                         on_counterparty_tx_csv,
 139                         is_counterparty_balance_on_anchors: if is_counterparty_balance_on_anchors { Some(()) } else { None }
 140                 }
 141         }
 142 }
 143
 144 impl_writeable_tlv_based!(RevokedOutput, {
 145         (0, per_commitment_point, required),
 146         (2, counterparty_delayed_payment_base_key, required),
 147         (4, counterparty_htlc_base_key, required),
 148         (6, per_commitment_key, required),
 149         (8, weight, required),
 150         (10, amount, required),
 151         (12, on_counterparty_tx_csv, required),
 152         (14, is_counterparty_balance_on_anchors, option)
 153 });
 154
 155 /// A struct to describe a revoked offered output and corresponding information to generate a
 156 /// solving witness.
 157 ///
 158 /// HTLCOuputInCommitment (hash timelock, direction) and pubkeys are used to generate a suitable
 159 /// witnessScript.
 160 ///
 161 /// CSV is used as part of a witnessScript redeeming a balance output, amount is used as part
 162 /// of the signature hash and revocation secret to generate a satisfying witness.
 163 #[derive(Clone, PartialEq, Eq)]
 164 pub(crate) struct RevokedHTLCOutput {
 165         per_commitment_point: PublicKey,
 166         counterparty_delayed_payment_base_key: DelayedPaymentBasepoint,
 167         counterparty_htlc_base_key: HtlcBasepoint,
 168         per_commitment_key: SecretKey,
 169         weight: u64,
 170         amount: u64,
 171         htlc: HTLCOutputInCommitment,
 172 }
 173
 174 impl RevokedHTLCOutput {
 175         pub(crate) fn build(per_commitment_point: PublicKey, counterparty_delayed_payment_base_key: DelayedPaymentBasepoint, counterparty_htlc_base_key: HtlcBasepoint, per_commitment_key: SecretKey, amount: u64, htlc: HTLCOutputInCommitment, channel_type_features: &ChannelTypeFeatures) -> Self {
 176                 let weight = if htlc.offered { weight_revoked_offered_htlc(channel_type_features) } else { weight_revoked_received_htlc(channel_type_features) };
 177                 RevokedHTLCOutput {
 178                         per_commitment_point,
 179                         counterparty_delayed_payment_base_key,
 180                         counterparty_htlc_base_key,
 181                         per_commitment_key,
 182                         weight,
 183                         amount,
 184                         htlc
 185                 }
 186         }
 187 }
 188
 189 impl_writeable_tlv_based!(RevokedHTLCOutput, {
 190         (0, per_commitment_point, required),
 191         (2, counterparty_delayed_payment_base_key, required),
 192         (4, counterparty_htlc_base_key, required),
 193         (6, per_commitment_key, required),
 194         (8, weight, required),
 195         (10, amount, required),
 196         (12, htlc, required),
 197 });
 198
 199 /// A struct to describe a HTLC output on a counterparty commitment transaction.
 200 ///
 201 /// HTLCOutputInCommitment (hash, timelock, directon) and pubkeys are used to generate a suitable
 202 /// witnessScript.
 203 ///
 204 /// The preimage is used as part of the witness.
 205 ///
 206 /// Note that on upgrades, some features of existing outputs may be missed.
 207 #[derive(Clone, PartialEq, Eq)]
 208 pub(crate) struct CounterpartyOfferedHTLCOutput {
 209         per_commitment_point: PublicKey,
 210         counterparty_delayed_payment_base_key: DelayedPaymentBasepoint,
 211         counterparty_htlc_base_key: HtlcBasepoint,
 212         preimage: PaymentPreimage,
 213         htlc: HTLCOutputInCommitment,
 214         channel_type_features: ChannelTypeFeatures,
 215 }
 216
 217 impl CounterpartyOfferedHTLCOutput {
 218         pub(crate) fn build(per_commitment_point: PublicKey, counterparty_delayed_payment_base_key: DelayedPaymentBasepoint, counterparty_htlc_base_key: HtlcBasepoint, preimage: PaymentPreimage, htlc: HTLCOutputInCommitment, channel_type_features: ChannelTypeFeatures) -> Self {
 219                 CounterpartyOfferedHTLCOutput {
 220                         per_commitment_point,
 221                         counterparty_delayed_payment_base_key,
 222                         counterparty_htlc_base_key,
 223                         preimage,
 224                         htlc,
 225                         channel_type_features,
 226                 }
 227         }
 228 }
 229
 230 impl Writeable for CounterpartyOfferedHTLCOutput {
 231         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 232                 let legacy_deserialization_prevention_marker = chan_utils::legacy_deserialization_prevention_marker_for_channel_type_features(&self.channel_type_features);
 233                 write_tlv_fields!(writer, {
 234                         (0, self.per_commitment_point, required),
 235                         (2, self.counterparty_delayed_payment_base_key, required),
 236                         (4, self.counterparty_htlc_base_key, required),
 237                         (6, self.preimage, required),
 238                         (8, self.htlc, required),
 239                         (10, legacy_deserialization_prevention_marker, option),
 240                         (11, self.channel_type_features, required),
 241                 });
 242                 Ok(())
 243         }
 244 }
 245
 246 impl Readable for CounterpartyOfferedHTLCOutput {
 247         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 248                 let mut per_commitment_point = RequiredWrapper(None);
 249                 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
 250                 let mut counterparty_htlc_base_key = RequiredWrapper(None);
 251                 let mut preimage = RequiredWrapper(None);
 252                 let mut htlc = RequiredWrapper(None);
 253                 let mut _legacy_deserialization_prevention_marker: Option<()> = None;
 254                 let mut channel_type_features = None;
 255
 256                 read_tlv_fields!(reader, {
 257                         (0, per_commitment_point, required),
 258                         (2, counterparty_delayed_payment_base_key, required),
 259                         (4, counterparty_htlc_base_key, required),
 260                         (6, preimage, required),
 261                         (8, htlc, required),
 262                         (10, _legacy_deserialization_prevention_marker, option),
 263                         (11, channel_type_features, option),
 264                 });
 265
 266                 verify_channel_type_features(&channel_type_features, None)?;
 267
 268                 Ok(Self {
 269                         per_commitment_point: per_commitment_point.0.unwrap(),
 270                         counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
 271                         counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
 272                         preimage: preimage.0.unwrap(),
 273                         htlc: htlc.0.unwrap(),
 274                         channel_type_features: channel_type_features.unwrap_or(ChannelTypeFeatures::only_static_remote_key())
 275                 })
 276         }
 277 }
 278
 279 /// A struct to describe a HTLC output on a counterparty commitment transaction.
 280 ///
 281 /// HTLCOutputInCommitment (hash, timelock, directon) and pubkeys are used to generate a suitable
 282 /// witnessScript.
 283 ///
 284 /// Note that on upgrades, some features of existing outputs may be missed.
 285 #[derive(Clone, PartialEq, Eq)]
 286 pub(crate) struct CounterpartyReceivedHTLCOutput {
 287         per_commitment_point: PublicKey,
 288         counterparty_delayed_payment_base_key: DelayedPaymentBasepoint,
 289         counterparty_htlc_base_key: HtlcBasepoint,
 290         htlc: HTLCOutputInCommitment,
 291         channel_type_features: ChannelTypeFeatures,
 292 }
 293
 294 impl CounterpartyReceivedHTLCOutput {
 295         pub(crate) fn build(per_commitment_point: PublicKey, counterparty_delayed_payment_base_key: DelayedPaymentBasepoint, counterparty_htlc_base_key: HtlcBasepoint, htlc: HTLCOutputInCommitment, channel_type_features: ChannelTypeFeatures) -> Self {
 296                 CounterpartyReceivedHTLCOutput {
 297                         per_commitment_point,
 298                         counterparty_delayed_payment_base_key,
 299                         counterparty_htlc_base_key,
 300                         htlc,
 301                         channel_type_features
 302                 }
 303         }
 304 }
 305
 306 impl Writeable for CounterpartyReceivedHTLCOutput {
 307         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 308                 let legacy_deserialization_prevention_marker = chan_utils::legacy_deserialization_prevention_marker_for_channel_type_features(&self.channel_type_features);
 309                 write_tlv_fields!(writer, {
 310                         (0, self.per_commitment_point, required),
 311                         (2, self.counterparty_delayed_payment_base_key, required),
 312                         (4, self.counterparty_htlc_base_key, required),
 313                         (6, self.htlc, required),
 314                         (8, legacy_deserialization_prevention_marker, option),
 315                         (9, self.channel_type_features, required),
 316                 });
 317                 Ok(())
 318         }
 319 }
 320
 321 impl Readable for CounterpartyReceivedHTLCOutput {
 322         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 323                 let mut per_commitment_point = RequiredWrapper(None);
 324                 let mut counterparty_delayed_payment_base_key = RequiredWrapper(None);
 325                 let mut counterparty_htlc_base_key = RequiredWrapper(None);
 326                 let mut htlc = RequiredWrapper(None);
 327                 let mut _legacy_deserialization_prevention_marker: Option<()> = None;
 328                 let mut channel_type_features = None;
 329
 330                 read_tlv_fields!(reader, {
 331                         (0, per_commitment_point, required),
 332                         (2, counterparty_delayed_payment_base_key, required),
 333                         (4, counterparty_htlc_base_key, required),
 334                         (6, htlc, required),
 335                         (8, _legacy_deserialization_prevention_marker, option),
 336                         (9, channel_type_features, option),
 337                 });
 338
 339                 verify_channel_type_features(&channel_type_features, None)?;
 340
 341                 Ok(Self {
 342                         per_commitment_point: per_commitment_point.0.unwrap(),
 343                         counterparty_delayed_payment_base_key: counterparty_delayed_payment_base_key.0.unwrap(),
 344                         counterparty_htlc_base_key: counterparty_htlc_base_key.0.unwrap(),
 345                         htlc: htlc.0.unwrap(),
 346                         channel_type_features: channel_type_features.unwrap_or(ChannelTypeFeatures::only_static_remote_key())
 347                 })
 348         }
 349 }
 350
 351 /// A struct to describe a HTLC output on holder commitment transaction.
 352 ///
 353 /// Either offered or received, the amount is always used as part of the bip143 sighash.
 354 /// Preimage is only included as part of the witness in former case.
 355 ///
 356 /// Note that on upgrades, some features of existing outputs may be missed.
 357 #[derive(Clone, PartialEq, Eq)]
 358 pub(crate) struct HolderHTLCOutput {
 359         preimage: Option<PaymentPreimage>,
 360         amount_msat: u64,
 361         /// Defaults to 0 for HTLC-Success transactions, which have no expiry
 362         cltv_expiry: u32,
 363         channel_type_features: ChannelTypeFeatures,
 364 }
 365
 366 impl HolderHTLCOutput {
 367         pub(crate) fn build_offered(amount_msat: u64, cltv_expiry: u32, channel_type_features: ChannelTypeFeatures) -> Self {
 368                 HolderHTLCOutput {
 369                         preimage: None,
 370                         amount_msat,
 371                         cltv_expiry,
 372                         channel_type_features,
 373                 }
 374         }
 375
 376         pub(crate) fn build_accepted(preimage: PaymentPreimage, amount_msat: u64, channel_type_features: ChannelTypeFeatures) -> Self {
 377                 HolderHTLCOutput {
 378                         preimage: Some(preimage),
 379                         amount_msat,
 380                         cltv_expiry: 0,
 381                         channel_type_features,
 382                 }
 383         }
 384 }
 385
 386 impl Writeable for HolderHTLCOutput {
 387         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 388                 let legacy_deserialization_prevention_marker = chan_utils::legacy_deserialization_prevention_marker_for_channel_type_features(&self.channel_type_features);
 389                 write_tlv_fields!(writer, {
 390                         (0, self.amount_msat, required),
 391                         (2, self.cltv_expiry, required),
 392                         (4, self.preimage, option),
 393                         (6, legacy_deserialization_prevention_marker, option),
 394                         (7, self.channel_type_features, required),
 395                 });
 396                 Ok(())
 397         }
 398 }
 399
 400 impl Readable for HolderHTLCOutput {
 401         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 402                 let mut amount_msat = RequiredWrapper(None);
 403                 let mut cltv_expiry = RequiredWrapper(None);
 404                 let mut preimage = None;
 405                 let mut _legacy_deserialization_prevention_marker: Option<()> = None;
 406                 let mut channel_type_features = None;
 407
 408                 read_tlv_fields!(reader, {
 409                         (0, amount_msat, required),
 410                         (2, cltv_expiry, required),
 411                         (4, preimage, option),
 412                         (6, _legacy_deserialization_prevention_marker, option),
 413                         (7, channel_type_features, option),
 414                 });
 415
 416                 verify_channel_type_features(&channel_type_features, None)?;
 417
 418                 Ok(Self {
 419                         amount_msat: amount_msat.0.unwrap(),
 420                         cltv_expiry: cltv_expiry.0.unwrap(),
 421                         preimage,
 422                         channel_type_features: channel_type_features.unwrap_or(ChannelTypeFeatures::only_static_remote_key())
 423                 })
 424         }
 425 }
 426
 427 /// A struct to describe the channel output on the funding transaction.
 428 ///
 429 /// witnessScript is used as part of the witness redeeming the funding utxo.
 430 ///
 431 /// Note that on upgrades, some features of existing outputs may be missed.
 432 #[derive(Clone, PartialEq, Eq)]
 433 pub(crate) struct HolderFundingOutput {
 434         funding_redeemscript: ScriptBuf,
 435         pub(crate) funding_amount: Option<u64>,
 436         channel_type_features: ChannelTypeFeatures,
 437 }
 438
 439
 440 impl HolderFundingOutput {
 441         pub(crate) fn build(funding_redeemscript: ScriptBuf, funding_amount: u64, channel_type_features: ChannelTypeFeatures) -> Self {
 442                 HolderFundingOutput {
 443                         funding_redeemscript,
 444                         funding_amount: Some(funding_amount),
 445                         channel_type_features,
 446                 }
 447         }
 448 }
 449
 450 impl Writeable for HolderFundingOutput {
 451         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
 452                 let legacy_deserialization_prevention_marker = chan_utils::legacy_deserialization_prevention_marker_for_channel_type_features(&self.channel_type_features);
 453                 write_tlv_fields!(writer, {
 454                         (0, self.funding_redeemscript, required),
 455                         (1, self.channel_type_features, required),
 456                         (2, legacy_deserialization_prevention_marker, option),
 457                         (3, self.funding_amount, option),
 458                 });
 459                 Ok(())
 460         }
 461 }
 462
 463 impl Readable for HolderFundingOutput {
 464         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 465                 let mut funding_redeemscript = RequiredWrapper(None);
 466                 let mut _legacy_deserialization_prevention_marker: Option<()> = None;
 467                 let mut channel_type_features = None;
 468                 let mut funding_amount = None;
 469
 470                 read_tlv_fields!(reader, {
 471                         (0, funding_redeemscript, required),
 472                         (1, channel_type_features, option),
 473                         (2, _legacy_deserialization_prevention_marker, option),
 474                         (3, funding_amount, option)
 475                 });
 476
 477                 verify_channel_type_features(&channel_type_features, None)?;
 478
 479                 Ok(Self {
 480                         funding_redeemscript: funding_redeemscript.0.unwrap(),
 481                         channel_type_features: channel_type_features.unwrap_or(ChannelTypeFeatures::only_static_remote_key()),
 482                         funding_amount
 483                 })
 484         }
 485 }
 486
 487 /// A wrapper encapsulating all in-protocol differing outputs types.
 488 ///
 489 /// The generic API offers access to an outputs common attributes or allow transformation such as
 490 /// finalizing an input claiming the output.
 491 #[derive(Clone, PartialEq, Eq)]
 492 pub(crate) enum PackageSolvingData {
 493         RevokedOutput(RevokedOutput),
 494         RevokedHTLCOutput(RevokedHTLCOutput),
 495         CounterpartyOfferedHTLCOutput(CounterpartyOfferedHTLCOutput),
 496         CounterpartyReceivedHTLCOutput(CounterpartyReceivedHTLCOutput),
 497         HolderHTLCOutput(HolderHTLCOutput),
 498         HolderFundingOutput(HolderFundingOutput),
 499 }
 500
 501 impl PackageSolvingData {
 502         fn amount(&self) -> u64 {
 503                 let amt = match self {
 504                         PackageSolvingData::RevokedOutput(ref outp) => outp.amount,
 505                         PackageSolvingData::RevokedHTLCOutput(ref outp) => outp.amount,
 506                         PackageSolvingData::CounterpartyOfferedHTLCOutput(ref outp) => outp.htlc.amount_msat / 1000,
 507                         PackageSolvingData::CounterpartyReceivedHTLCOutput(ref outp) => outp.htlc.amount_msat / 1000,
 508                         PackageSolvingData::HolderHTLCOutput(ref outp) => {
 509                                 debug_assert!(outp.channel_type_features.supports_anchors_zero_fee_htlc_tx());
 510                                 outp.amount_msat / 1000
 511                         },
 512                         PackageSolvingData::HolderFundingOutput(ref outp) => {
 513                                 debug_assert!(outp.channel_type_features.supports_anchors_zero_fee_htlc_tx());
 514                                 outp.funding_amount.unwrap()
 515                         }
 516                 };
 517                 amt
 518         }
 519         fn weight(&self) -> usize {
 520                 match self {
 521                         PackageSolvingData::RevokedOutput(ref outp) => outp.weight as usize,
 522                         PackageSolvingData::RevokedHTLCOutput(ref outp) => outp.weight as usize,
 523                         PackageSolvingData::CounterpartyOfferedHTLCOutput(ref outp) => weight_offered_htlc(&outp.channel_type_features) as usize,
 524                         PackageSolvingData::CounterpartyReceivedHTLCOutput(ref outp) => weight_received_htlc(&outp.channel_type_features) as usize,
 525                         PackageSolvingData::HolderHTLCOutput(ref outp) => {
 526                                 debug_assert!(outp.channel_type_features.supports_anchors_zero_fee_htlc_tx());
 527                                 if outp.preimage.is_none() {
 528                                         weight_offered_htlc(&outp.channel_type_features) as usize
 529                                 } else {
 530                                         weight_received_htlc(&outp.channel_type_features) as usize
 531                                 }
 532                         },
 533                         // Since HolderFundingOutput maps to an untractable package that is already signed, its
 534                         // weight can be determined from the transaction itself.
 535                         PackageSolvingData::HolderFundingOutput(..) => unreachable!(),
 536                 }
 537         }
 538         fn is_compatible(&self, input: &PackageSolvingData) -> bool {
 539                 match self {
 540                         PackageSolvingData::RevokedOutput(..) => {
 541                                 match input {
 542                                         PackageSolvingData::RevokedHTLCOutput(..) => { true },
 543                                         PackageSolvingData::RevokedOutput(..) => { true },
 544                                         _ => { false }
 545                                 }
 546                         },
 547                         PackageSolvingData::RevokedHTLCOutput(..) => {
 548                                 match input {
 549                                         PackageSolvingData::RevokedOutput(..) => { true },
 550                                         PackageSolvingData::RevokedHTLCOutput(..) => { true },
 551                                         _ => { false }
 552                                 }
 553                         },
 554                         _ => { mem::discriminant(self) == mem::discriminant(&input) }
 555                 }
 556         }
 557         fn as_tx_input(&self, previous_output: BitcoinOutPoint) -> TxIn {
 558                 let sequence = match self {
 559                         PackageSolvingData::RevokedOutput(_) => Sequence::ENABLE_RBF_NO_LOCKTIME,
 560                         PackageSolvingData::RevokedHTLCOutput(_) => Sequence::ENABLE_RBF_NO_LOCKTIME,
 561                         PackageSolvingData::CounterpartyOfferedHTLCOutput(outp) => if outp.channel_type_features.supports_anchors_zero_fee_htlc_tx() {
 562                                 Sequence::from_consensus(1)
 563                         } else {
 564                                 Sequence::ENABLE_RBF_NO_LOCKTIME
 565                         },
 566                         PackageSolvingData::CounterpartyReceivedHTLCOutput(outp) => if outp.channel_type_features.supports_anchors_zero_fee_htlc_tx() {
 567                                 Sequence::from_consensus(1)
 568                         } else {
 569                                 Sequence::ENABLE_RBF_NO_LOCKTIME
 570                         },
 571                         _ => {
 572                                 debug_assert!(false, "This should not be reachable by 'untractable' or 'malleable with external funding' packages");
 573                                 Sequence::ENABLE_RBF_NO_LOCKTIME
 574                         },
 575                 };
 576                 TxIn {
 577                         previous_output,
 578                         script_sig: ScriptBuf::new(),
 579                         sequence,
 580                         witness: Witness::new(),
 581                 }
 582         }
 583         fn finalize_input<Signer: WriteableEcdsaChannelSigner>(&self, bumped_tx: &mut Transaction, i: usize, onchain_handler: &mut OnchainTxHandler<Signer>) -> bool {
 584                 match self {
 585                         PackageSolvingData::RevokedOutput(ref outp) => {
 586                                 let chan_keys = TxCreationKeys::derive_new(&onchain_handler.secp_ctx, &outp.per_commitment_point, &outp.counterparty_delayed_payment_base_key, &outp.counterparty_htlc_base_key, &onchain_handler.signer.pubkeys().revocation_basepoint, &onchain_handler.signer.pubkeys().htlc_basepoint);
 587                                 let witness_script = chan_utils::get_revokeable_redeemscript(&chan_keys.revocation_key, outp.on_counterparty_tx_csv, &chan_keys.broadcaster_delayed_payment_key);
 588                                 //TODO: should we panic on signer failure ?
 589                                 if let Ok(sig) = onchain_handler.signer.sign_justice_revoked_output(&bumped_tx, i, outp.amount, &outp.per_commitment_key, &onchain_handler.secp_ctx) {
 590                                         let mut ser_sig = sig.serialize_der().to_vec();
 591                                         ser_sig.push(EcdsaSighashType::All as u8);
 592                                         bumped_tx.input[i].witness.push(ser_sig);
 593                                         bumped_tx.input[i].witness.push(vec!(1));
 594                                         bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 595                                 } else { return false; }
 596                         },
 597                         PackageSolvingData::RevokedHTLCOutput(ref outp) => {
 598                                 let chan_keys = TxCreationKeys::derive_new(&onchain_handler.secp_ctx, &outp.per_commitment_point, &outp.counterparty_delayed_payment_base_key, &outp.counterparty_htlc_base_key, &onchain_handler.signer.pubkeys().revocation_basepoint, &onchain_handler.signer.pubkeys().htlc_basepoint);
 599                                 let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&outp.htlc, &onchain_handler.channel_type_features(), &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key);
 600                                 //TODO: should we panic on signer failure ?
 601                                 if let Ok(sig) = onchain_handler.signer.sign_justice_revoked_htlc(&bumped_tx, i, outp.amount, &outp.per_commitment_key, &outp.htlc, &onchain_handler.secp_ctx) {
 602                                         let mut ser_sig = sig.serialize_der().to_vec();
 603                                         ser_sig.push(EcdsaSighashType::All as u8);
 604                                         bumped_tx.input[i].witness.push(ser_sig);
 605                                         bumped_tx.input[i].witness.push(chan_keys.revocation_key.to_public_key().serialize().to_vec());
 606                                         bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 607                                 } else { return false; }
 608                         },
 609                         PackageSolvingData::CounterpartyOfferedHTLCOutput(ref outp) => {
 610                                 let chan_keys = TxCreationKeys::derive_new(&onchain_handler.secp_ctx, &outp.per_commitment_point, &outp.counterparty_delayed_payment_base_key, &outp.counterparty_htlc_base_key, &onchain_handler.signer.pubkeys().revocation_basepoint, &onchain_handler.signer.pubkeys().htlc_basepoint);
 611                                 let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&outp.htlc, &onchain_handler.channel_type_features(), &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key);
 612
 613                                 if let Ok(sig) = onchain_handler.signer.sign_counterparty_htlc_transaction(&bumped_tx, i, &outp.htlc.amount_msat / 1000, &outp.per_commitment_point, &outp.htlc, &onchain_handler.secp_ctx) {
 614                                         let mut ser_sig = sig.serialize_der().to_vec();
 615                                         ser_sig.push(EcdsaSighashType::All as u8);
 616                                         bumped_tx.input[i].witness.push(ser_sig);
 617                                         bumped_tx.input[i].witness.push(outp.preimage.0.to_vec());
 618                                         bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 619                                 }
 620                         },
 621                         PackageSolvingData::CounterpartyReceivedHTLCOutput(ref outp) => {
 622                                 let chan_keys = TxCreationKeys::derive_new(&onchain_handler.secp_ctx, &outp.per_commitment_point, &outp.counterparty_delayed_payment_base_key, &outp.counterparty_htlc_base_key, &onchain_handler.signer.pubkeys().revocation_basepoint, &onchain_handler.signer.pubkeys().htlc_basepoint);
 623                                 let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&outp.htlc, &onchain_handler.channel_type_features(), &chan_keys.broadcaster_htlc_key, &chan_keys.countersignatory_htlc_key, &chan_keys.revocation_key);
 624
 625                                 if let Ok(sig) = onchain_handler.signer.sign_counterparty_htlc_transaction(&bumped_tx, i, &outp.htlc.amount_msat / 1000, &outp.per_commitment_point, &outp.htlc, &onchain_handler.secp_ctx) {
 626                                         let mut ser_sig = sig.serialize_der().to_vec();
 627                                         ser_sig.push(EcdsaSighashType::All as u8);
 628                                         bumped_tx.input[i].witness.push(ser_sig);
 629                                         // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
 630                                         bumped_tx.input[i].witness.push(vec![]);
 631                                         bumped_tx.input[i].witness.push(witness_script.clone().into_bytes());
 632                                 }
 633                         },
 634                         _ => { panic!("API Error!"); }
 635                 }
 636                 true
 637         }
 638         fn get_maybe_finalized_tx<Signer: WriteableEcdsaChannelSigner>(&self, outpoint: &BitcoinOutPoint, onchain_handler: &mut OnchainTxHandler<Signer>) -> Option<MaybeSignedTransaction> {
 639                 match self {
 640                         PackageSolvingData::HolderHTLCOutput(ref outp) => {
 641                                 debug_assert!(!outp.channel_type_features.supports_anchors_zero_fee_htlc_tx());
 642                                 onchain_handler.get_maybe_signed_htlc_tx(outpoint, &outp.preimage)
 643                         }
 644                         PackageSolvingData::HolderFundingOutput(ref outp) => {
 645                                 Some(onchain_handler.get_maybe_signed_holder_tx(&outp.funding_redeemscript))
 646                         }
 647                         _ => { panic!("API Error!"); }
 648                 }
 649         }
 650         fn absolute_tx_timelock(&self, current_height: u32) -> u32 {
 651                 // We use `current_height` as our default locktime to discourage fee sniping and because
 652                 // transactions with it always propagate.
 653                 let absolute_timelock = match self {
 654                         PackageSolvingData::RevokedOutput(_) => current_height,
 655                         PackageSolvingData::RevokedHTLCOutput(_) => current_height,
 656                         PackageSolvingData::CounterpartyOfferedHTLCOutput(_) => current_height,
 657                         PackageSolvingData::CounterpartyReceivedHTLCOutput(ref outp) => cmp::max(outp.htlc.cltv_expiry, current_height),
 658                         // HTLC timeout/success transactions rely on a fixed timelock due to the counterparty's
 659                         // signature.
 660                         PackageSolvingData::HolderHTLCOutput(ref outp) => {
 661                                 if outp.preimage.is_some() {
 662                                         debug_assert_eq!(outp.cltv_expiry, 0);
 663                                 }
 664                                 outp.cltv_expiry
 665                         },
 666                         PackageSolvingData::HolderFundingOutput(_) => current_height,
 667                 };
 668                 absolute_timelock
 669         }
 670
 671         fn map_output_type_flags(&self) -> (PackageMalleability, bool) {
 672                 // Post-anchor, aggregation of outputs of different types is unsafe. See https://github.com/lightning/bolts/pull/803.
 673                 let (malleability, aggregable) = match self {
 674                         PackageSolvingData::RevokedOutput(RevokedOutput { is_counterparty_balance_on_anchors: Some(()), .. }) => { (PackageMalleability::Malleable, false) },
 675                         PackageSolvingData::RevokedOutput(RevokedOutput { is_counterparty_balance_on_anchors: None, .. }) => { (PackageMalleability::Malleable, true) },
 676                         PackageSolvingData::RevokedHTLCOutput(..) => { (PackageMalleability::Malleable, true) },
 677                         PackageSolvingData::CounterpartyOfferedHTLCOutput(..) => { (PackageMalleability::Malleable, true) },
 678                         PackageSolvingData::CounterpartyReceivedHTLCOutput(..) => { (PackageMalleability::Malleable, false) },
 679                         PackageSolvingData::HolderHTLCOutput(ref outp) => if outp.channel_type_features.supports_anchors_zero_fee_htlc_tx() {
 680                                 (PackageMalleability::Malleable, outp.preimage.is_some())
 681                         } else {
 682                                 (PackageMalleability::Untractable, false)
 683                         },
 684                         PackageSolvingData::HolderFundingOutput(..) => { (PackageMalleability::Untractable, false) },
 685                 };
 686                 (malleability, aggregable)
 687         }
 688 }
 689
 690 impl_writeable_tlv_based_enum!(PackageSolvingData, ;
 691         (0, RevokedOutput),
 692         (1, RevokedHTLCOutput),
 693         (2, CounterpartyOfferedHTLCOutput),
 694         (3, CounterpartyReceivedHTLCOutput),
 695         (4, HolderHTLCOutput),
 696         (5, HolderFundingOutput),
 697 );
 698
 699 /// A malleable package might be aggregated with other packages to save on fees.
 700 /// A untractable package has been counter-signed and aggregable will break cached counterparty signatures.
 701 #[derive(Clone, PartialEq, Eq)]
 702 pub(crate) enum PackageMalleability {
 703         Malleable,
 704         Untractable,
 705 }
 706
 707 /// A structure to describe a package content that is generated by ChannelMonitor and
 708 /// used by OnchainTxHandler to generate and broadcast transactions settling onchain claims.
 709 ///
 710 /// A package is defined as one or more transactions claiming onchain outputs in reaction
 711 /// to confirmation of a channel transaction. Those packages might be aggregated to save on
 712 /// fees, if satisfaction of outputs's witnessScript let's us do so.
 713 ///
 714 /// As packages are time-sensitive, we fee-bump and rebroadcast them at scheduled intervals.
 715 /// Failing to confirm a package translate as a loss of funds for the user.
 716 #[derive(Clone, PartialEq, Eq)]
 717 pub struct PackageTemplate {
 718         // List of onchain outputs and solving data to generate satisfying witnesses.
 719         inputs: Vec<(BitcoinOutPoint, PackageSolvingData)>,
 720         // Packages are deemed as malleable if we have local knwoledge of at least one set of
 721         // private keys yielding a satisfying witnesses. Malleability implies that we can aggregate
 722         // packages among them to save on fees or rely on RBF to bump their feerates.
 723         // Untractable packages have been counter-signed and thus imply that we can't aggregate
 724         // them without breaking signatures. Fee-bumping strategy will also rely on CPFP.
 725         malleability: PackageMalleability,
 726         // Block height after which the earlier-output belonging to this package is mature for a
 727         // competing claim by the counterparty. As our chain tip becomes nearer from the timelock,
 728         // the fee-bumping frequency will increase. See `OnchainTxHandler::get_height_timer`.
 729         soonest_conf_deadline: u32,
 730         // Determines if this package can be aggregated.
 731         // Timelocked outputs belonging to the same transaction might have differing
 732         // satisfying heights. Picking up the later height among the output set would be a valid
 733         // aggregable strategy but it comes with at least 2 trade-offs :
 734         // * earlier-output fund are going to take longer to come back
 735         // * CLTV delta backing up a corresponding HTLC on an upstream channel could be swallowed
 736         // by the requirement of the later-output part of the set
 737         // For now, we mark such timelocked outputs as non-aggregable, though we might introduce
 738         // smarter aggregable strategy in the future.
 739         aggregable: bool,
 740         // Cache of package feerate committed at previous (re)broadcast. If bumping resources
 741         // (either claimed output value or external utxo), it will keep increasing until holder
 742         // or counterparty successful claim.
 743         feerate_previous: u64,
 744         // Cache of next height at which fee-bumping and rebroadcast will be attempted. In
 745         // the future, we might abstract it to an observed mempool fluctuation.
 746         height_timer: u32,
 747         // Confirmation height of the claimed outputs set transaction. In case of reorg reaching
 748         // it, we wipe out and forget the package.
 749         height_original: u32,
 750 }
 751
 752 impl PackageTemplate {
 753         pub(crate) fn is_malleable(&self) -> bool {
 754                 self.malleability == PackageMalleability::Malleable
 755         }
 756         pub(crate) fn timelock(&self) -> u32 {
 757                 self.soonest_conf_deadline
 758         }
 759         pub(crate) fn aggregable(&self) -> bool {
 760                 self.aggregable
 761         }
 762         pub(crate) fn previous_feerate(&self) -> u64 {
 763                 self.feerate_previous
 764         }
 765         pub(crate) fn set_feerate(&mut self, new_feerate: u64) {
 766                 self.feerate_previous = new_feerate;
 767         }
 768         pub(crate) fn timer(&self) -> u32 {
 769                 self.height_timer
 770         }
 771         pub(crate) fn set_timer(&mut self, new_timer: u32) {
 772                 self.height_timer = new_timer;
 773         }
 774         pub(crate) fn outpoints(&self) -> Vec<&BitcoinOutPoint> {
 775                 self.inputs.iter().map(|(o, _)| o).collect()
 776         }
 777         pub(crate) fn inputs(&self) -> impl ExactSizeIterator<Item = &PackageSolvingData> {
 778                 self.inputs.iter().map(|(_, i)| i)
 779         }
 780         pub(crate) fn split_package(&mut self, split_outp: &BitcoinOutPoint) -> Option<PackageTemplate> {
 781                 match self.malleability {
 782                         PackageMalleability::Malleable => {
 783                                 let mut split_package = None;
 784                                 let timelock = self.soonest_conf_deadline;
 785                                 let aggregable = self.aggregable;
 786                                 let feerate_previous = self.feerate_previous;
 787                                 let height_timer = self.height_timer;
 788                                 let height_original = self.height_original;
 789                                 self.inputs.retain(|outp| {
 790                                         if *split_outp == outp.0 {
 791                                                 split_package = Some(PackageTemplate {
 792                                                         inputs: vec![(outp.0, outp.1.clone())],
 793                                                         malleability: PackageMalleability::Malleable,
 794                                                         soonest_conf_deadline: timelock,
 795                                                         aggregable,
 796                                                         feerate_previous,
 797                                                         height_timer,
 798                                                         height_original,
 799                                                 });
 800                                                 return false;
 801                                         }
 802                                         return true;
 803                                 });
 804                                 return split_package;
 805                         },
 806                         _ => {
 807                                 // Note, we may try to split on remote transaction for
 808                                 // which we don't have a competing one (HTLC-Success before
 809                                 // timelock expiration). This explain we don't panic!
 810                                 // We should refactor OnchainTxHandler::block_connected to
 811                                 // only test equality on competing claims.
 812                                 return None;
 813                         }
 814                 }
 815         }
 816         pub(crate) fn merge_package(&mut self, mut merge_from: PackageTemplate) {
 817                 assert_eq!(self.height_original, merge_from.height_original);
 818                 if self.malleability == PackageMalleability::Untractable || merge_from.malleability == PackageMalleability::Untractable {
 819                         panic!("Merging template on untractable packages");
 820                 }
 821                 if !self.aggregable || !merge_from.aggregable {
 822                         panic!("Merging non aggregatable packages");
 823                 }
 824                 if let Some((_, lead_input)) = self.inputs.first() {
 825                         for (_, v) in merge_from.inputs.iter() {
 826                                 if !lead_input.is_compatible(v) { panic!("Merging outputs from differing types !"); }
 827                         }
 828                 } else { panic!("Merging template on an empty package"); }
 829                 for (k, v) in merge_from.inputs.drain(..) {
 830                         self.inputs.push((k, v));
 831                 }
 832                 //TODO: verify coverage and sanity?
 833                 if self.soonest_conf_deadline > merge_from.soonest_conf_deadline {
 834                         self.soonest_conf_deadline = merge_from.soonest_conf_deadline;
 835                 }
 836                 if self.feerate_previous > merge_from.feerate_previous {
 837                         self.feerate_previous = merge_from.feerate_previous;
 838                 }
 839                 self.height_timer = cmp::min(self.height_timer, merge_from.height_timer);
 840         }
 841         /// Gets the amount of all outptus being spent by this package, only valid for malleable
 842         /// packages.
 843         pub(crate) fn package_amount(&self) -> u64 {
 844                 let mut amounts = 0;
 845                 for (_, outp) in self.inputs.iter() {
 846                         amounts += outp.amount();
 847                 }
 848                 amounts
 849         }
 850         pub(crate) fn package_locktime(&self, current_height: u32) -> u32 {
 851                 let locktime = self.inputs.iter().map(|(_, outp)| outp.absolute_tx_timelock(current_height))
 852                         .max().expect("There must always be at least one output to spend in a PackageTemplate");
 853
 854                 // If we ever try to aggregate a `HolderHTLCOutput`s with another output type, we'll likely
 855                 // end up with an incorrect transaction locktime since the counterparty has included it in
 856                 // its HTLC signature. This should never happen unless we decide to aggregate outputs across
 857                 // different channel commitments.
 858                 #[cfg(debug_assertions)] {
 859                         if self.inputs.iter().any(|(_, outp)|
 860                                 if let PackageSolvingData::HolderHTLCOutput(outp) = outp {
 861                                         outp.preimage.is_some()
 862                                 } else {
 863                                         false
 864                                 }
 865                         ) {
 866                                 debug_assert_eq!(locktime, 0);
 867                         };
 868                         for timeout_htlc_expiry in self.inputs.iter().filter_map(|(_, outp)|
 869                                 if let PackageSolvingData::HolderHTLCOutput(outp) = outp {
 870                                         if outp.preimage.is_none() {
 871                                                 Some(outp.cltv_expiry)
 872                                         } else { None }
 873                                 } else { None }
 874                         ) {
 875                                 debug_assert_eq!(locktime, timeout_htlc_expiry);
 876                         }
 877                 }
 878
 879                 locktime
 880         }
 881         pub(crate) fn package_weight(&self, destination_script: &Script) -> u64 {
 882                 let mut inputs_weight = 0;
 883                 let mut witnesses_weight = 2; // count segwit flags
 884                 for (_, outp) in self.inputs.iter() {
 885                         // previous_out_point: 36 bytes ; var_int: 1 byte ; sequence: 4 bytes
 886                         inputs_weight += 41 * WITNESS_SCALE_FACTOR;
 887                         witnesses_weight += outp.weight();
 888                 }
 889                 // version: 4 bytes ; count_tx_in: 1 byte ; count_tx_out: 1 byte ; lock_time: 4 bytes
 890                 let transaction_weight = 10 * WITNESS_SCALE_FACTOR;
 891                 // value: 8 bytes ; var_int: 1 byte ; pk_script: `destination_script.len()`
 892                 let output_weight = (8 + 1 + destination_script.len()) * WITNESS_SCALE_FACTOR;
 893                 (inputs_weight + witnesses_weight + transaction_weight + output_weight) as u64
 894         }
 895         pub(crate) fn construct_malleable_package_with_external_funding<Signer: WriteableEcdsaChannelSigner>(
 896                 &self, onchain_handler: &mut OnchainTxHandler<Signer>,
 897         ) -> Option<Vec<ExternalHTLCClaim>> {
 898                 debug_assert!(self.requires_external_funding());
 899                 let mut htlcs: Option<Vec<ExternalHTLCClaim>> = None;
 900                 for (previous_output, input) in &self.inputs {
 901                         match input {
 902                                 PackageSolvingData::HolderHTLCOutput(ref outp) => {
 903                                         debug_assert!(outp.channel_type_features.supports_anchors_zero_fee_htlc_tx());
 904                                         onchain_handler.generate_external_htlc_claim(&previous_output, &outp.preimage).map(|htlc| {
 905                                                 htlcs.get_or_insert_with(|| Vec::with_capacity(self.inputs.len())).push(htlc);
 906                                         });
 907                                 }
 908                                 _ => debug_assert!(false, "Expected HolderHTLCOutputs to not be aggregated with other input types"),
 909                         }
 910                 }
 911                 htlcs
 912         }
 913         pub(crate) fn maybe_finalize_malleable_package<L: Logger, Signer: WriteableEcdsaChannelSigner>(
 914                 &self, current_height: u32, onchain_handler: &mut OnchainTxHandler<Signer>, value: u64,
 915                 destination_script: ScriptBuf, logger: &L
 916         ) -> Option<MaybeSignedTransaction> {
 917                 debug_assert!(self.is_malleable());
 918                 let mut bumped_tx = Transaction {
 919                         version: 2,
 920                         lock_time: LockTime::from_consensus(self.package_locktime(current_height)),
 921                         input: vec![],
 922                         output: vec![TxOut {
 923                                 script_pubkey: destination_script,
 924                                 value,
 925                         }],
 926                 };
 927                 for (outpoint, outp) in self.inputs.iter() {
 928                         bumped_tx.input.push(outp.as_tx_input(*outpoint));
 929                 }
 930                 for (i, (outpoint, out)) in self.inputs.iter().enumerate() {
 931                         log_debug!(logger, "Adding claiming input for outpoint {}:{}", outpoint.txid, outpoint.vout);
 932                         if !out.finalize_input(&mut bumped_tx, i, onchain_handler) { continue; }
 933                 }
 934                 Some(MaybeSignedTransaction(bumped_tx))
 935         }
 936         pub(crate) fn maybe_finalize_untractable_package<L: Logger, Signer: WriteableEcdsaChannelSigner>(
 937                 &self, onchain_handler: &mut OnchainTxHandler<Signer>, logger: &L,
 938         ) -> Option<MaybeSignedTransaction> {
 939                 debug_assert!(!self.is_malleable());
 940                 if let Some((outpoint, outp)) = self.inputs.first() {
 941                         if let Some(final_tx) = outp.get_maybe_finalized_tx(outpoint, onchain_handler) {
 942                                 log_debug!(logger, "Adding claiming input for outpoint {}:{}", outpoint.txid, outpoint.vout);
 943                                 return Some(final_tx);
 944                         }
 945                         return None;
 946                 } else { panic!("API Error: Package must not be inputs empty"); }
 947         }
 948         /// In LN, output claimed are time-sensitive, which means we have to spend them before reaching some timelock expiration. At in-channel
 949         /// output detection, we generate a first version of a claim tx and associate to it a height timer. A height timer is an absolute block
 950         /// height that once reached we should generate a new bumped "version" of the claim tx to be sure that we safely claim outputs before
 951         /// that our counterparty can do so. If timelock expires soon, height timer is going to be scaled down in consequence to increase
 952         /// frequency of the bump and so increase our bets of success.
 953         pub(crate) fn get_height_timer(&self, current_height: u32) -> u32 {
 954                 if self.soonest_conf_deadline <= current_height + MIDDLE_FREQUENCY_BUMP_INTERVAL {
 955                         return current_height + HIGH_FREQUENCY_BUMP_INTERVAL
 956                 } else if self.soonest_conf_deadline - current_height <= LOW_FREQUENCY_BUMP_INTERVAL {
 957                         return current_height + MIDDLE_FREQUENCY_BUMP_INTERVAL
 958                 }
 959                 current_height + LOW_FREQUENCY_BUMP_INTERVAL
 960         }
 961
 962         /// Returns value in satoshis to be included as package outgoing output amount and feerate
 963         /// which was used to generate the value. Will not return less than `dust_limit_sats` for the
 964         /// value.
 965         pub(crate) fn compute_package_output<F: Deref, L: Logger>(
 966                 &self, predicted_weight: u64, dust_limit_sats: u64, feerate_strategy: &FeerateStrategy,
 967                 fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
 968         ) -> Option<(u64, u64)>
 969         where F::Target: FeeEstimator,
 970         {
 971                 debug_assert!(self.malleability == PackageMalleability::Malleable, "The package output is fixed for non-malleable packages");
 972                 let input_amounts = self.package_amount();
 973                 assert!(dust_limit_sats as i64 > 0, "Output script must be broadcastable/have a 'real' dust limit.");
 974                 // If old feerate is 0, first iteration of this claim, use normal fee calculation
 975                 if self.feerate_previous != 0 {
 976                         if let Some((new_fee, feerate)) = feerate_bump(
 977                                 predicted_weight, input_amounts, self.feerate_previous, feerate_strategy,
 978                                 fee_estimator, logger,
 979                         ) {
 980                                 return Some((cmp::max(input_amounts as i64 - new_fee as i64, dust_limit_sats as i64) as u64, feerate));
 981                         }
 982                 } else {
 983                         if let Some((new_fee, feerate)) = compute_fee_from_spent_amounts(input_amounts, predicted_weight, fee_estimator, logger) {
 984                                 return Some((cmp::max(input_amounts as i64 - new_fee as i64, dust_limit_sats as i64) as u64, feerate));
 985                         }
 986                 }
 987                 None
 988         }
 989
 990         /// Computes a feerate based on the given confirmation target and feerate strategy.
 991         pub(crate) fn compute_package_feerate<F: Deref>(
 992                 &self, fee_estimator: &LowerBoundedFeeEstimator<F>, conf_target: ConfirmationTarget,
 993                 feerate_strategy: &FeerateStrategy,
 994         ) -> u32 where F::Target: FeeEstimator {
 995                 let feerate_estimate = fee_estimator.bounded_sat_per_1000_weight(conf_target);
 996                 if self.feerate_previous != 0 {
 997                         let previous_feerate = self.feerate_previous.try_into().unwrap_or(u32::max_value());
 998                         match feerate_strategy {
 999                                 FeerateStrategy::RetryPrevious => previous_feerate,
1000                                 FeerateStrategy::HighestOfPreviousOrNew => cmp::max(previous_feerate, feerate_estimate),
1001                                 FeerateStrategy::ForceBump => if feerate_estimate > previous_feerate {
1002                                         feerate_estimate
1003                                 } else {
1004                                         // Our fee estimate has decreased, but our transaction remains unconfirmed after
1005                                         // using our previous fee estimate. This may point to an unreliable fee estimator,
1006                                         // so we choose to bump our previous feerate by 25%, making sure we don't use a
1007                                         // lower feerate or overpay by a large margin by limiting it to 5x the new fee
1008                                         // estimate.
1009                                         let previous_feerate = self.feerate_previous.try_into().unwrap_or(u32::max_value());
1010                                         let mut new_feerate = previous_feerate.saturating_add(previous_feerate / 4);
1011                                         if new_feerate > feerate_estimate * 5 {
1012                                                 new_feerate = cmp::max(feerate_estimate * 5, previous_feerate);
1013                                         }
1014                                         new_feerate
1015                                 },
1016                         }
1017                 } else {
1018                         feerate_estimate
1019                 }
1020         }
1021
1022         /// Determines whether a package contains an input which must have additional external inputs
1023         /// attached to help the spending transaction reach confirmation.
1024         pub(crate) fn requires_external_funding(&self) -> bool {
1025                 self.inputs.iter().find(|input| match input.1 {
1026                         PackageSolvingData::HolderFundingOutput(ref outp) => outp.channel_type_features.supports_anchors_zero_fee_htlc_tx(),
1027                         PackageSolvingData::HolderHTLCOutput(ref outp) => outp.channel_type_features.supports_anchors_zero_fee_htlc_tx(),
1028                         _ => false,
1029                 }).is_some()
1030         }
1031
1032         pub (crate) fn build_package(txid: Txid, vout: u32, input_solving_data: PackageSolvingData, soonest_conf_deadline: u32, height_original: u32) -> Self {
1033                 let (malleability, aggregable) = PackageSolvingData::map_output_type_flags(&input_solving_data);
1034                 let mut inputs = Vec::with_capacity(1);
1035                 inputs.push((BitcoinOutPoint { txid, vout }, input_solving_data));
1036                 PackageTemplate {
1037                         inputs,
1038                         malleability,
1039                         soonest_conf_deadline,
1040                         aggregable,
1041                         feerate_previous: 0,
1042                         height_timer: height_original,
1043                         height_original,
1044                 }
1045         }
1046 }
1047
1048 impl Writeable for PackageTemplate {
1049         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
1050                 writer.write_all(&(self.inputs.len() as u64).to_be_bytes())?;
1051                 for (ref outpoint, ref rev_outp) in self.inputs.iter() {
1052                         outpoint.write(writer)?;
1053                         rev_outp.write(writer)?;
1054                 }
1055                 write_tlv_fields!(writer, {
1056                         (0, self.soonest_conf_deadline, required),
1057                         (2, self.feerate_previous, required),
1058                         (4, self.height_original, required),
1059                         (6, self.height_timer, required)
1060                 });
1061                 Ok(())
1062         }
1063 }
1064
1065 impl Readable for PackageTemplate {
1066         fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
1067                 let inputs_count = <u64 as Readable>::read(reader)?;
1068                 let mut inputs: Vec<(BitcoinOutPoint, PackageSolvingData)> = Vec::with_capacity(cmp::min(inputs_count as usize, MAX_ALLOC_SIZE / 128));
1069                 for _ in 0..inputs_count {
1070                         let outpoint = Readable::read(reader)?;
1071                         let rev_outp = Readable::read(reader)?;
1072                         inputs.push((outpoint, rev_outp));
1073                 }
1074                 let (malleability, aggregable) = if let Some((_, lead_input)) = inputs.first() {
1075                         PackageSolvingData::map_output_type_flags(&lead_input)
1076                 } else { return Err(DecodeError::InvalidValue); };
1077                 let mut soonest_conf_deadline = 0;
1078                 let mut feerate_previous = 0;
1079                 let mut height_timer = None;
1080                 let mut height_original = 0;
1081                 read_tlv_fields!(reader, {
1082                         (0, soonest_conf_deadline, required),
1083                         (2, feerate_previous, required),
1084                         (4, height_original, required),
1085                         (6, height_timer, option),
1086                 });
1087                 if height_timer.is_none() {
1088                         height_timer = Some(height_original);
1089                 }
1090                 Ok(PackageTemplate {
1091                         inputs,
1092                         malleability,
1093                         soonest_conf_deadline,
1094                         aggregable,
1095                         feerate_previous,
1096                         height_timer: height_timer.unwrap(),
1097                         height_original,
1098                 })
1099         }
1100 }
1101
1102 /// Attempt to propose a bumping fee for a transaction from its spent output's values and predicted
1103 /// weight. We first try our [`OnChainSweep`] feerate, if it's not enough we try to sweep half of
1104 /// the input amounts.
1105 ///
1106 /// If the proposed fee is less than the available spent output's values, we return the proposed
1107 /// fee and the corresponding updated feerate. If fee is under [`FEERATE_FLOOR_SATS_PER_KW`], we
1108 /// return nothing.
1109 ///
1110 /// [`OnChainSweep`]: crate::chain::chaininterface::ConfirmationTarget::OnChainSweep
1111 /// [`FEERATE_FLOOR_SATS_PER_KW`]: crate::chain::chaininterface::MIN_RELAY_FEE_SAT_PER_1000_WEIGHT
1112 fn compute_fee_from_spent_amounts<F: Deref, L: Logger>(input_amounts: u64, predicted_weight: u64, fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L) -> Option<(u64, u64)>
1113         where F::Target: FeeEstimator,
1114 {
1115         let sweep_feerate = fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::OnChainSweep);
1116         let fee_rate = cmp::min(sweep_feerate, compute_feerate_sat_per_1000_weight(input_amounts / 2, predicted_weight));
1117         let fee = fee_rate as u64 * (predicted_weight) / 1000;
1118
1119         // if the fee rate is below the floor, we don't sweep
1120         if fee_rate < FEERATE_FLOOR_SATS_PER_KW {
1121                 log_error!(logger, "Failed to generate an on-chain tx with fee ({} sat/kw) was less than the floor ({} sat/kw)",
1122                                         fee_rate, FEERATE_FLOOR_SATS_PER_KW);
1123                 None
1124         } else {
1125                 Some((fee, fee_rate as u64))
1126         }
1127 }
1128
1129 /// Attempt to propose a bumping fee for a transaction from its spent output's values and predicted
1130 /// weight. If feerates proposed by the fee-estimator have been increasing since last fee-bumping
1131 /// attempt, use them. If we need to force a feerate bump, we manually bump the feerate by 25% of
1132 /// the previous feerate. If a feerate bump did happen, we also verify that those bumping heuristics
1133 /// respect BIP125 rules 3) and 4) and if required adjust the new fee to meet the RBF policy
1134 /// requirement.
1135 fn feerate_bump<F: Deref, L: Logger>(
1136         predicted_weight: u64, input_amounts: u64, previous_feerate: u64, feerate_strategy: &FeerateStrategy,
1137         fee_estimator: &LowerBoundedFeeEstimator<F>, logger: &L,
1138 ) -> Option<(u64, u64)>
1139 where
1140         F::Target: FeeEstimator,
1141 {
1142         // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee...
1143         let (new_fee, new_feerate) = if let Some((new_fee, new_feerate)) = compute_fee_from_spent_amounts(input_amounts, predicted_weight, fee_estimator, logger) {
1144                 match feerate_strategy {
1145                         FeerateStrategy::RetryPrevious => {
1146                                 let previous_fee = previous_feerate * predicted_weight / 1000;
1147                                 (previous_fee, previous_feerate)
1148                         },
1149                         FeerateStrategy::HighestOfPreviousOrNew => if new_feerate > previous_feerate {
1150                                 (new_fee, new_feerate)
1151                         } else {
1152                                 let previous_fee = previous_feerate * predicted_weight / 1000;
1153                                 (previous_fee, previous_feerate)
1154                         },
1155                         FeerateStrategy::ForceBump => if new_feerate > previous_feerate {
1156                                 (new_fee, new_feerate)
1157                         } else {
1158                                 // ...else just increase the previous feerate by 25% (because that's a nice number)
1159                                 let bumped_feerate = previous_feerate + (previous_feerate / 4);
1160                                 let bumped_fee = bumped_feerate * predicted_weight / 1000;
1161                                 if input_amounts <= bumped_fee {
1162                                         log_warn!(logger, "Can't 25% bump new claiming tx, amount {} is too small", input_amounts);
1163                                         return None;
1164                                 }
1165                                 (bumped_fee, bumped_feerate)
1166                         },
1167                 }
1168         } else {
1169                 log_warn!(logger, "Can't new-estimation bump new claiming tx, amount {} is too small", input_amounts);
1170                 return None;
1171         };
1172
1173         // Our feerates should never decrease. If it hasn't changed though, we just need to
1174         // rebroadcast/re-sign the previous claim.
1175         debug_assert!(new_feerate >= previous_feerate);
1176         if new_feerate == previous_feerate {
1177                 return Some((new_fee, new_feerate));
1178         }
1179
1180         let previous_fee = previous_feerate * predicted_weight / 1000;
1181         let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * predicted_weight / 1000;
1182         // BIP 125 Opt-in Full Replace-by-Fee Signaling
1183         //      * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions.
1184         //      * 4. The replacement transaction must also pay for its own bandwidth at or above the rate set by the node's minimum relay fee setting.
1185         let new_fee = if new_fee < previous_fee + min_relay_fee {
1186                 new_fee + previous_fee + min_relay_fee - new_fee
1187         } else {
1188                 new_fee
1189         };
1190         Some((new_fee, new_fee * 1000 / predicted_weight))
1191 }
1192
1193 #[cfg(test)]
1194 mod tests {
1195         use crate::chain::package::{CounterpartyOfferedHTLCOutput, CounterpartyReceivedHTLCOutput, HolderHTLCOutput, PackageTemplate, PackageSolvingData, RevokedOutput, WEIGHT_REVOKED_OUTPUT, weight_offered_htlc, weight_received_htlc};
1196         use crate::chain::Txid;
1197         use crate::ln::chan_utils::HTLCOutputInCommitment;
1198         use crate::ln::{PaymentPreimage, PaymentHash};
1199         use crate::ln::channel_keys::{DelayedPaymentBasepoint, HtlcBasepoint};
1200
1201         use bitcoin::blockdata::constants::WITNESS_SCALE_FACTOR;
1202         use bitcoin::blockdata::script::ScriptBuf;
1203         use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
1204
1205         use bitcoin::hashes::hex::FromHex;
1206
1207         use bitcoin::secp256k1::{PublicKey,SecretKey};
1208         use bitcoin::secp256k1::Secp256k1;
1209         use crate::ln::features::ChannelTypeFeatures;
1210
1211         use std::str::FromStr;
1212
1213         macro_rules! dumb_revk_output {
1214                 ($secp_ctx: expr, $is_counterparty_balance_on_anchors: expr) => {
1215                         {
1216                                 let dumb_scalar = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
1217                                 let dumb_point = PublicKey::from_secret_key(&$secp_ctx, &dumb_scalar);
1218                                 PackageSolvingData::RevokedOutput(RevokedOutput::build(dumb_point, DelayedPaymentBasepoint::from(dumb_point), HtlcBasepoint::from(dumb_point), dumb_scalar, 0, 0, $is_counterparty_balance_on_anchors))
1219                         }
1220                 }
1221         }
1222
1223         macro_rules! dumb_counterparty_output {
1224                 ($secp_ctx: expr, $amt: expr, $opt_anchors: expr) => {
1225                         {
1226                                 let dumb_scalar = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
1227                                 let dumb_point = PublicKey::from_secret_key(&$secp_ctx, &dumb_scalar);
1228                                 let hash = PaymentHash([1; 32]);
1229                                 let htlc = HTLCOutputInCommitment { offered: true, amount_msat: $amt, cltv_expiry: 0, payment_hash: hash, transaction_output_index: None };
1230                                 PackageSolvingData::CounterpartyReceivedHTLCOutput(CounterpartyReceivedHTLCOutput::build(dumb_point, DelayedPaymentBasepoint::from(dumb_point), HtlcBasepoint::from(dumb_point), htlc, $opt_anchors))
1231                         }
1232                 }
1233         }
1234
1235         macro_rules! dumb_counterparty_offered_output {
1236                 ($secp_ctx: expr, $amt: expr, $opt_anchors: expr) => {
1237                         {
1238                                 let dumb_scalar = SecretKey::from_slice(&<Vec<u8>>::from_hex("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
1239                                 let dumb_point = PublicKey::from_secret_key(&$secp_ctx, &dumb_scalar);
1240                                 let hash = PaymentHash([1; 32]);
1241                                 let preimage = PaymentPreimage([2;32]);
1242                                 let htlc = HTLCOutputInCommitment { offered: false, amount_msat: $amt, cltv_expiry: 1000, payment_hash: hash, transaction_output_index: None };
1243                                 PackageSolvingData::CounterpartyOfferedHTLCOutput(CounterpartyOfferedHTLCOutput::build(dumb_point, DelayedPaymentBasepoint::from(dumb_point), HtlcBasepoint::from(dumb_point), preimage, htlc, $opt_anchors))
1244                         }
1245                 }
1246         }
1247
1248         macro_rules! dumb_htlc_output {
1249                 () => {
1250                         {
1251                                 let preimage = PaymentPreimage([2;32]);
1252                                 PackageSolvingData::HolderHTLCOutput(HolderHTLCOutput::build_accepted(preimage, 0, ChannelTypeFeatures::only_static_remote_key()))
1253                         }
1254                 }
1255         }
1256
1257         #[test]
1258         #[should_panic]
1259         fn test_package_differing_heights() {
1260                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1261                 let secp_ctx = Secp256k1::new();
1262                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1263
1264                 let mut package_one_hundred = PackageTemplate::build_package(txid, 0, revk_outp.clone(), 1000, 100);
1265                 let package_two_hundred = PackageTemplate::build_package(txid, 1, revk_outp.clone(), 1000, 200);
1266                 package_one_hundred.merge_package(package_two_hundred);
1267         }
1268
1269         #[test]
1270         #[should_panic]
1271         fn test_package_untractable_merge_to() {
1272                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1273                 let secp_ctx = Secp256k1::new();
1274                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1275                 let htlc_outp = dumb_htlc_output!();
1276
1277                 let mut untractable_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), 1000, 100);
1278                 let malleable_package = PackageTemplate::build_package(txid, 1, htlc_outp.clone(), 1000, 100);
1279                 untractable_package.merge_package(malleable_package);
1280         }
1281
1282         #[test]
1283         #[should_panic]
1284         fn test_package_untractable_merge_from() {
1285                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1286                 let secp_ctx = Secp256k1::new();
1287                 let htlc_outp = dumb_htlc_output!();
1288                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1289
1290                 let mut malleable_package = PackageTemplate::build_package(txid, 0, htlc_outp.clone(), 1000, 100);
1291                 let untractable_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), 1000, 100);
1292                 malleable_package.merge_package(untractable_package);
1293         }
1294
1295         #[test]
1296         #[should_panic]
1297         fn test_package_noaggregation_to() {
1298                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1299                 let secp_ctx = Secp256k1::new();
1300                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1301                 let revk_outp_counterparty_balance = dumb_revk_output!(secp_ctx, true);
1302
1303                 let mut noaggregation_package = PackageTemplate::build_package(txid, 0, revk_outp_counterparty_balance.clone(), 1000, 100);
1304                 let aggregation_package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), 1000, 100);
1305                 noaggregation_package.merge_package(aggregation_package);
1306         }
1307
1308         #[test]
1309         #[should_panic]
1310         fn test_package_noaggregation_from() {
1311                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1312                 let secp_ctx = Secp256k1::new();
1313                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1314                 let revk_outp_counterparty_balance = dumb_revk_output!(secp_ctx, true);
1315
1316                 let mut aggregation_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), 1000, 100);
1317                 let noaggregation_package = PackageTemplate::build_package(txid, 1, revk_outp_counterparty_balance.clone(), 1000, 100);
1318                 aggregation_package.merge_package(noaggregation_package);
1319         }
1320
1321         #[test]
1322         #[should_panic]
1323         fn test_package_empty() {
1324                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1325                 let secp_ctx = Secp256k1::new();
1326                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1327
1328                 let mut empty_package = PackageTemplate::build_package(txid, 0, revk_outp.clone(), 1000, 100);
1329                 empty_package.inputs = vec![];
1330                 let package = PackageTemplate::build_package(txid, 1, revk_outp.clone(), 1000, 100);
1331                 empty_package.merge_package(package);
1332         }
1333
1334         #[test]
1335         #[should_panic]
1336         fn test_package_differing_categories() {
1337                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1338                 let secp_ctx = Secp256k1::new();
1339                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1340                 let counterparty_outp = dumb_counterparty_output!(secp_ctx, 0, ChannelTypeFeatures::only_static_remote_key());
1341
1342                 let mut revoked_package = PackageTemplate::build_package(txid, 0, revk_outp, 1000, 100);
1343                 let counterparty_package = PackageTemplate::build_package(txid, 1, counterparty_outp, 1000, 100);
1344                 revoked_package.merge_package(counterparty_package);
1345         }
1346
1347         #[test]
1348         fn test_package_split_malleable() {
1349                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1350                 let secp_ctx = Secp256k1::new();
1351                 let revk_outp_one = dumb_revk_output!(secp_ctx, false);
1352                 let revk_outp_two = dumb_revk_output!(secp_ctx, false);
1353                 let revk_outp_three = dumb_revk_output!(secp_ctx, false);
1354
1355                 let mut package_one = PackageTemplate::build_package(txid, 0, revk_outp_one, 1000, 100);
1356                 let package_two = PackageTemplate::build_package(txid, 1, revk_outp_two, 1000, 100);
1357                 let package_three = PackageTemplate::build_package(txid, 2, revk_outp_three, 1000, 100);
1358
1359                 package_one.merge_package(package_two);
1360                 package_one.merge_package(package_three);
1361                 assert_eq!(package_one.outpoints().len(), 3);
1362
1363                 if let Some(split_package) = package_one.split_package(&BitcoinOutPoint { txid, vout: 1 }) {
1364                         // Packages attributes should be identical
1365                         assert!(split_package.is_malleable());
1366                         assert_eq!(split_package.soonest_conf_deadline, package_one.soonest_conf_deadline);
1367                         assert_eq!(split_package.aggregable, package_one.aggregable);
1368                         assert_eq!(split_package.feerate_previous, package_one.feerate_previous);
1369                         assert_eq!(split_package.height_timer, package_one.height_timer);
1370                         assert_eq!(split_package.height_original, package_one.height_original);
1371                 } else { panic!(); }
1372                 assert_eq!(package_one.outpoints().len(), 2);
1373         }
1374
1375         #[test]
1376         fn test_package_split_untractable() {
1377                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1378                 let htlc_outp_one = dumb_htlc_output!();
1379
1380                 let mut package_one = PackageTemplate::build_package(txid, 0, htlc_outp_one, 1000, 100);
1381                 let ret_split = package_one.split_package(&BitcoinOutPoint { txid, vout: 0});
1382                 assert!(ret_split.is_none());
1383         }
1384
1385         #[test]
1386         fn test_package_timer() {
1387                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1388                 let secp_ctx = Secp256k1::new();
1389                 let revk_outp = dumb_revk_output!(secp_ctx, false);
1390
1391                 let mut package = PackageTemplate::build_package(txid, 0, revk_outp, 1000, 100);
1392                 assert_eq!(package.timer(), 100);
1393                 package.set_timer(101);
1394                 assert_eq!(package.timer(), 101);
1395         }
1396
1397         #[test]
1398         fn test_package_amounts() {
1399                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1400                 let secp_ctx = Secp256k1::new();
1401                 let counterparty_outp = dumb_counterparty_output!(secp_ctx, 1_000_000, ChannelTypeFeatures::only_static_remote_key());
1402
1403                 let package = PackageTemplate::build_package(txid, 0, counterparty_outp, 1000, 100);
1404                 assert_eq!(package.package_amount(), 1000);
1405         }
1406
1407         #[test]
1408         fn test_package_weight() {
1409                 let txid = Txid::from_str("c2d4449afa8d26140898dd54d3390b057ba2a5afcf03ba29d7dc0d8b9ffe966e").unwrap();
1410                 let secp_ctx = Secp256k1::new();
1411
1412                 // (nVersion (4) + nLocktime (4) + count_tx_in (1) + prevout (36) + sequence (4) + script_length (1) + count_tx_out (1) + value (8) + var_int (1)) * WITNESS_SCALE_FACTOR + witness marker (2)
1413                 let weight_sans_output = (4 + 4 + 1 + 36 + 4 + 1 + 1 + 8 + 1) * WITNESS_SCALE_FACTOR as u64 + 2;
1414
1415                 {
1416                         let revk_outp = dumb_revk_output!(secp_ctx, false);
1417                         let package = PackageTemplate::build_package(txid, 0, revk_outp, 0, 100);
1418                         assert_eq!(package.package_weight(&ScriptBuf::new()),  weight_sans_output + WEIGHT_REVOKED_OUTPUT);
1419                 }
1420
1421                 {
1422                         for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
1423                                 let counterparty_outp = dumb_counterparty_output!(secp_ctx, 1_000_000, channel_type_features.clone());
1424                                 let package = PackageTemplate::build_package(txid, 0, counterparty_outp, 1000, 100);
1425                                 assert_eq!(package.package_weight(&ScriptBuf::new()), weight_sans_output + weight_received_htlc(channel_type_features));
1426                         }
1427                 }
1428
1429                 {
1430                         for channel_type_features in [ChannelTypeFeatures::only_static_remote_key(), ChannelTypeFeatures::anchors_zero_htlc_fee_and_dependencies()].iter() {
1431                                 let counterparty_outp = dumb_counterparty_offered_output!(secp_ctx, 1_000_000, channel_type_features.clone());
1432                                 let package = PackageTemplate::build_package(txid, 0, counterparty_outp, 1000, 100);
1433                                 assert_eq!(package.package_weight(&ScriptBuf::new()), weight_sans_output + weight_offered_htlc(channel_type_features));
1434                         }
1435                 }
1436         }
1437 }