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

   1 //! Various utilities for building scripts and deriving keys related to channels. These are
   2 //! largely of interest for those implementing chain::keysinterface::ChannelKeys message signing
   3 //! by hand.
   4
   5 use bitcoin::blockdata::script::{Script,Builder};
   6 use bitcoin::blockdata::opcodes;
   7 use bitcoin::blockdata::transaction::{TxIn,TxOut,OutPoint,Transaction, SigHashType};
   8 use bitcoin::consensus::encode::{self, Decodable, Encodable};
   9 use bitcoin::util::bip143;
  10
  11 use bitcoin::hashes::{Hash, HashEngine};
  12 use bitcoin::hashes::sha256::Hash as Sha256;
  13 use bitcoin::hashes::ripemd160::Hash as Ripemd160;
  14 use bitcoin::hash_types::{Txid, PubkeyHash};
  15
  16 use ln::channelmanager::{PaymentHash, PaymentPreimage};
  17 use ln::msgs::DecodeError;
  18 use util::ser::{Readable, Writeable, Writer, WriterWriteAdaptor};
  19 use util::byte_utils;
  20
  21 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
  22 use bitcoin::secp256k1::{Secp256k1, Signature};
  23 use bitcoin::secp256k1;
  24
  25 use std::{cmp, mem};
  26
  27 const MAX_ALLOC_SIZE: usize = 64*1024;
  28
  29 pub(super) const HTLC_SUCCESS_TX_WEIGHT: u64 = 703; // XXX
  30 pub(super) const HTLC_TIMEOUT_TX_WEIGHT: u64 = 663; // XXX
  31
  32 #[derive(PartialEq)]
  33 pub(crate) enum HTLCType {
  34         AcceptedHTLC,
  35         OfferedHTLC
  36 }
  37
  38 impl HTLCType {
  39         /// Check if a given tx witnessScript len matchs one of a pre-signed HTLC
  40         pub(crate) fn scriptlen_to_htlctype(witness_script_len: usize) ->  Option<HTLCType> {
  41                 if witness_script_len == 136 {
  42                         Some(HTLCType::OfferedHTLC)
  43                 } else if witness_script_len >= 139 && witness_script_len <= 142 {
  44                         Some(HTLCType::AcceptedHTLC)
  45                 } else {
  46                         None
  47                 }
  48         }
  49 }
  50
  51 // Various functions for key derivation and transaction creation for use within channels. Primarily
  52 // used in Channel and ChannelMonitor.
  53
  54 pub(super) fn build_commitment_secret(commitment_seed: &[u8; 32], idx: u64) -> [u8; 32] {
  55         let mut res: [u8; 32] = commitment_seed.clone();
  56         for i in 0..48 {
  57                 let bitpos = 47 - i;
  58                 if idx & (1 << bitpos) == (1 << bitpos) {
  59                         res[bitpos / 8] ^= 1 << (bitpos & 7);
  60                         res = Sha256::hash(&res).into_inner();
  61                 }
  62         }
  63         res
  64 }
  65
  66 /// Implements the per-commitment secret storage scheme from
  67 /// [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
  68 ///
  69 /// Allows us to keep track of all of the revocation secrets of counterarties in just 50*32 bytes
  70 /// or so.
  71 #[derive(Clone)]
  72 pub(super) struct CounterpartyCommitmentSecrets {
  73         old_secrets: [([u8; 32], u64); 49],
  74 }
  75
  76 impl PartialEq for CounterpartyCommitmentSecrets {
  77         fn eq(&self, other: &Self) -> bool {
  78                 for (&(ref secret, ref idx), &(ref o_secret, ref o_idx)) in self.old_secrets.iter().zip(other.old_secrets.iter()) {
  79                         if secret != o_secret || idx != o_idx {
  80                                 return false
  81                         }
  82                 }
  83                 true
  84         }
  85 }
  86
  87 impl CounterpartyCommitmentSecrets {
  88         pub(super) fn new() -> Self {
  89                 Self { old_secrets: [([0; 32], 1 << 48); 49], }
  90         }
  91
  92         #[inline]
  93         fn place_secret(idx: u64) -> u8 {
  94                 for i in 0..48 {
  95                         if idx & (1 << i) == (1 << i) {
  96                                 return i
  97                         }
  98                 }
  99                 48
 100         }
 101
 102         pub(super) fn get_min_seen_secret(&self) -> u64 {
 103                 //TODO This can be optimized?
 104                 let mut min = 1 << 48;
 105                 for &(_, idx) in self.old_secrets.iter() {
 106                         if idx < min {
 107                                 min = idx;
 108                         }
 109                 }
 110                 min
 111         }
 112
 113         #[inline]
 114         pub(super) fn derive_secret(secret: [u8; 32], bits: u8, idx: u64) -> [u8; 32] {
 115                 let mut res: [u8; 32] = secret;
 116                 for i in 0..bits {
 117                         let bitpos = bits - 1 - i;
 118                         if idx & (1 << bitpos) == (1 << bitpos) {
 119                                 res[(bitpos / 8) as usize] ^= 1 << (bitpos & 7);
 120                                 res = Sha256::hash(&res).into_inner();
 121                         }
 122                 }
 123                 res
 124         }
 125
 126         pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), ()> {
 127                 let pos = Self::place_secret(idx);
 128                 for i in 0..pos {
 129                         let (old_secret, old_idx) = self.old_secrets[i as usize];
 130                         if Self::derive_secret(secret, pos, old_idx) != old_secret {
 131                                 return Err(());
 132                         }
 133                 }
 134                 if self.get_min_seen_secret() <= idx {
 135                         return Ok(());
 136                 }
 137                 self.old_secrets[pos as usize] = (secret, idx);
 138                 Ok(())
 139         }
 140
 141         /// Can only fail if idx is < get_min_seen_secret
 142         pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
 143                 for i in 0..self.old_secrets.len() {
 144                         if (idx & (!((1 << i) - 1))) == self.old_secrets[i].1 {
 145                                 return Some(Self::derive_secret(self.old_secrets[i].0, i as u8, idx))
 146                         }
 147                 }
 148                 assert!(idx < self.get_min_seen_secret());
 149                 None
 150         }
 151 }
 152
 153 impl Writeable for CounterpartyCommitmentSecrets {
 154         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 155                 for &(ref secret, ref idx) in self.old_secrets.iter() {
 156                         writer.write_all(secret)?;
 157                         writer.write_all(&byte_utils::be64_to_array(*idx))?;
 158                 }
 159                 Ok(())
 160         }
 161 }
 162 impl Readable for CounterpartyCommitmentSecrets {
 163         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 164                 let mut old_secrets = [([0; 32], 1 << 48); 49];
 165                 for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() {
 166                         *secret = Readable::read(reader)?;
 167                         *idx = Readable::read(reader)?;
 168                 }
 169
 170                 Ok(Self { old_secrets })
 171         }
 172 }
 173
 174 /// Derives a per-commitment-transaction private key (eg an htlc key or payment key) from the base
 175 /// private key for that type of key and the per_commitment_point (available in TxCreationKeys)
 176 pub fn derive_private_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_secret: &SecretKey) -> Result<SecretKey, secp256k1::Error> {
 177         let mut sha = Sha256::engine();
 178         sha.input(&per_commitment_point.serialize());
 179         sha.input(&PublicKey::from_secret_key(&secp_ctx, &base_secret).serialize());
 180         let res = Sha256::from_engine(sha).into_inner();
 181
 182         let mut key = base_secret.clone();
 183         key.add_assign(&res)?;
 184         Ok(key)
 185 }
 186
 187 pub(super) fn derive_public_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_point: &PublicKey) -> Result<PublicKey, secp256k1::Error> {
 188         let mut sha = Sha256::engine();
 189         sha.input(&per_commitment_point.serialize());
 190         sha.input(&base_point.serialize());
 191         let res = Sha256::from_engine(sha).into_inner();
 192
 193         let hashkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&res)?);
 194         base_point.combine(&hashkey)
 195 }
 196
 197 /// Derives a revocation key from its constituent parts.
 198 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
 199 /// generated (ie our own).
 200 pub(super) fn derive_private_revocation_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_secret: &SecretKey, revocation_base_secret: &SecretKey) -> Result<SecretKey, secp256k1::Error> {
 201         let revocation_base_point = PublicKey::from_secret_key(&secp_ctx, &revocation_base_secret);
 202         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
 203
 204         let rev_append_commit_hash_key = {
 205                 let mut sha = Sha256::engine();
 206                 sha.input(&revocation_base_point.serialize());
 207                 sha.input(&per_commitment_point.serialize());
 208
 209                 Sha256::from_engine(sha).into_inner()
 210         };
 211         let commit_append_rev_hash_key = {
 212                 let mut sha = Sha256::engine();
 213                 sha.input(&per_commitment_point.serialize());
 214                 sha.input(&revocation_base_point.serialize());
 215
 216                 Sha256::from_engine(sha).into_inner()
 217         };
 218
 219         let mut part_a = revocation_base_secret.clone();
 220         part_a.mul_assign(&rev_append_commit_hash_key)?;
 221         let mut part_b = per_commitment_secret.clone();
 222         part_b.mul_assign(&commit_append_rev_hash_key)?;
 223         part_a.add_assign(&part_b[..])?;
 224         Ok(part_a)
 225 }
 226
 227 pub(super) fn derive_public_revocation_key<T: secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, revocation_base_point: &PublicKey) -> Result<PublicKey, secp256k1::Error> {
 228         let rev_append_commit_hash_key = {
 229                 let mut sha = Sha256::engine();
 230                 sha.input(&revocation_base_point.serialize());
 231                 sha.input(&per_commitment_point.serialize());
 232
 233                 Sha256::from_engine(sha).into_inner()
 234         };
 235         let commit_append_rev_hash_key = {
 236                 let mut sha = Sha256::engine();
 237                 sha.input(&per_commitment_point.serialize());
 238                 sha.input(&revocation_base_point.serialize());
 239
 240                 Sha256::from_engine(sha).into_inner()
 241         };
 242
 243         let mut part_a = revocation_base_point.clone();
 244         part_a.mul_assign(&secp_ctx, &rev_append_commit_hash_key)?;
 245         let mut part_b = per_commitment_point.clone();
 246         part_b.mul_assign(&secp_ctx, &commit_append_rev_hash_key)?;
 247         part_a.combine(&part_b)
 248 }
 249
 250 /// The set of public keys which are used in the creation of one commitment transaction.
 251 /// These are derived from the channel base keys and per-commitment data.
 252 #[derive(PartialEq, Clone)]
 253 pub struct TxCreationKeys {
 254         /// The per-commitment public key which was used to derive the other keys.
 255         pub per_commitment_point: PublicKey,
 256         /// The revocation key which is used to allow the owner of the commitment transaction to
 257         /// provide their counterparty the ability to punish them if they broadcast an old state.
 258         pub(crate) revocation_key: PublicKey,
 259         /// A's HTLC Key
 260         pub(crate) a_htlc_key: PublicKey,
 261         /// B's HTLC Key
 262         pub(crate) b_htlc_key: PublicKey,
 263         /// A's Payment Key (which isn't allowed to be spent from for some delay)
 264         pub(crate) a_delayed_payment_key: PublicKey,
 265 }
 266 impl_writeable!(TxCreationKeys, 33*6,
 267         { per_commitment_point, revocation_key, a_htlc_key, b_htlc_key, a_delayed_payment_key });
 268
 269 /// One counterparty's public keys which do not change over the life of a channel.
 270 #[derive(Clone, PartialEq)]
 271 pub struct ChannelPublicKeys {
 272         /// The public key which is used to sign all commitment transactions, as it appears in the
 273         /// on-chain channel lock-in 2-of-2 multisig output.
 274         pub funding_pubkey: PublicKey,
 275         /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
 276         /// revocation keys. The per-commitment revocation private key is then revealed by the owner of
 277         /// a commitment transaction so that their counterparty can claim all available funds if they
 278         /// broadcast an old state.
 279         pub revocation_basepoint: PublicKey,
 280         /// The public key which receives our immediately spendable primary channel balance in
 281         /// remote-broadcasted commitment transactions. This key is static across every commitment
 282         /// transaction.
 283         pub payment_point: PublicKey,
 284         /// The base point which is used (with derive_public_key) to derive a per-commitment payment
 285         /// public key which receives non-HTLC-encumbered funds which are only available for spending
 286         /// after some delay (or can be claimed via the revocation path).
 287         pub delayed_payment_basepoint: PublicKey,
 288         /// The base point which is used (with derive_public_key) to derive a per-commitment public key
 289         /// which is used to encumber HTLC-in-flight outputs.
 290         pub htlc_basepoint: PublicKey,
 291 }
 292
 293 impl_writeable!(ChannelPublicKeys, 33*5, {
 294         funding_pubkey,
 295         revocation_basepoint,
 296         payment_point,
 297         delayed_payment_basepoint,
 298         htlc_basepoint
 299 });
 300
 301
 302 impl TxCreationKeys {
 303         pub(crate) fn new<T: secp256k1::Signing + secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, a_delayed_payment_base: &PublicKey, a_htlc_base: &PublicKey, b_revocation_base: &PublicKey, b_htlc_base: &PublicKey) -> Result<TxCreationKeys, secp256k1::Error> {
 304                 Ok(TxCreationKeys {
 305                         per_commitment_point: per_commitment_point.clone(),
 306                         revocation_key: derive_public_revocation_key(&secp_ctx, &per_commitment_point, &b_revocation_base)?,
 307                         a_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &a_htlc_base)?,
 308                         b_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &b_htlc_base)?,
 309                         a_delayed_payment_key: derive_public_key(&secp_ctx, &per_commitment_point, &a_delayed_payment_base)?,
 310                 })
 311         }
 312 }
 313
 314 /// Gets the "to_local" output redeemscript, ie the script which is time-locked or spendable by
 315 /// the revocation key
 316 pub(super) fn get_revokeable_redeemscript(revocation_key: &PublicKey, to_self_delay: u16, delayed_payment_key: &PublicKey) -> Script {
 317         Builder::new().push_opcode(opcodes::all::OP_IF)
 318                       .push_slice(&revocation_key.serialize())
 319                       .push_opcode(opcodes::all::OP_ELSE)
 320                       .push_int(to_self_delay as i64)
 321                       .push_opcode(opcodes::all::OP_CSV)
 322                       .push_opcode(opcodes::all::OP_DROP)
 323                       .push_slice(&delayed_payment_key.serialize())
 324                       .push_opcode(opcodes::all::OP_ENDIF)
 325                       .push_opcode(opcodes::all::OP_CHECKSIG)
 326                       .into_script()
 327 }
 328
 329 #[derive(Clone, PartialEq)]
 330 /// Information about an HTLC as it appears in a commitment transaction
 331 pub struct HTLCOutputInCommitment {
 332         /// Whether the HTLC was "offered" (ie outbound in relation to this commitment transaction).
 333         /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
 334         /// need to compare this value to whether the commitment transaction in question is that of
 335         /// the remote party or our own.
 336         pub offered: bool,
 337         /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
 338         /// this divided by 1000.
 339         pub amount_msat: u64,
 340         /// The CLTV lock-time at which this HTLC expires.
 341         pub cltv_expiry: u32,
 342         /// The hash of the preimage which unlocks this HTLC.
 343         pub payment_hash: PaymentHash,
 344         /// The position within the commitment transactions' outputs. This may be None if the value is
 345         /// below the dust limit (in which case no output appears in the commitment transaction and the
 346         /// value is spent to additional transaction fees).
 347         pub transaction_output_index: Option<u32>,
 348 }
 349
 350 impl_writeable!(HTLCOutputInCommitment, 1 + 8 + 4 + 32 + 5, {
 351         offered,
 352         amount_msat,
 353         cltv_expiry,
 354         payment_hash,
 355         transaction_output_index
 356 });
 357
 358 #[inline]
 359 pub(crate) fn get_htlc_redeemscript_with_explicit_keys(htlc: &HTLCOutputInCommitment, a_htlc_key: &PublicKey, b_htlc_key: &PublicKey, revocation_key: &PublicKey) -> Script {
 360         let payment_hash160 = Ripemd160::hash(&htlc.payment_hash.0[..]).into_inner();
 361         if htlc.offered {
 362                 Builder::new().push_opcode(opcodes::all::OP_DUP)
 363                               .push_opcode(opcodes::all::OP_HASH160)
 364                               .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
 365                               .push_opcode(opcodes::all::OP_EQUAL)
 366                               .push_opcode(opcodes::all::OP_IF)
 367                               .push_opcode(opcodes::all::OP_CHECKSIG)
 368                               .push_opcode(opcodes::all::OP_ELSE)
 369                               .push_slice(&b_htlc_key.serialize()[..])
 370                               .push_opcode(opcodes::all::OP_SWAP)
 371                               .push_opcode(opcodes::all::OP_SIZE)
 372                               .push_int(32)
 373                               .push_opcode(opcodes::all::OP_EQUAL)
 374                               .push_opcode(opcodes::all::OP_NOTIF)
 375                               .push_opcode(opcodes::all::OP_DROP)
 376                               .push_int(2)
 377                               .push_opcode(opcodes::all::OP_SWAP)
 378                               .push_slice(&a_htlc_key.serialize()[..])
 379                               .push_int(2)
 380                               .push_opcode(opcodes::all::OP_CHECKMULTISIG)
 381                               .push_opcode(opcodes::all::OP_ELSE)
 382                               .push_opcode(opcodes::all::OP_HASH160)
 383                               .push_slice(&payment_hash160)
 384                               .push_opcode(opcodes::all::OP_EQUALVERIFY)
 385                               .push_opcode(opcodes::all::OP_CHECKSIG)
 386                               .push_opcode(opcodes::all::OP_ENDIF)
 387                               .push_opcode(opcodes::all::OP_ENDIF)
 388                               .push_int(1)
 389                               .push_opcode(opcodes::all::OP_CSV)
 390                               .push_opcode(opcodes::all::OP_DROP)
 391                               .into_script()
 392         } else {
 393                 Builder::new().push_opcode(opcodes::all::OP_DUP)
 394                               .push_opcode(opcodes::all::OP_HASH160)
 395                               .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
 396                               .push_opcode(opcodes::all::OP_EQUAL)
 397                               .push_opcode(opcodes::all::OP_IF)
 398                               .push_opcode(opcodes::all::OP_CHECKSIG)
 399                               .push_opcode(opcodes::all::OP_ELSE)
 400                               .push_slice(&b_htlc_key.serialize()[..])
 401                               .push_opcode(opcodes::all::OP_SWAP)
 402                               .push_opcode(opcodes::all::OP_SIZE)
 403                               .push_int(32)
 404                               .push_opcode(opcodes::all::OP_EQUAL)
 405                               .push_opcode(opcodes::all::OP_IF)
 406                               .push_opcode(opcodes::all::OP_HASH160)
 407                               .push_slice(&payment_hash160)
 408                               .push_opcode(opcodes::all::OP_EQUALVERIFY)
 409                               .push_int(2)
 410                               .push_opcode(opcodes::all::OP_SWAP)
 411                               .push_slice(&a_htlc_key.serialize()[..])
 412                               .push_int(2)
 413                               .push_opcode(opcodes::all::OP_CHECKMULTISIG)
 414                               .push_opcode(opcodes::all::OP_ELSE)
 415                               .push_opcode(opcodes::all::OP_DROP)
 416                               .push_int(htlc.cltv_expiry as i64)
 417                               .push_opcode(opcodes::all::OP_CLTV)
 418                               .push_opcode(opcodes::all::OP_DROP)
 419                               .push_opcode(opcodes::all::OP_CHECKSIG)
 420                               .push_opcode(opcodes::all::OP_ENDIF)
 421                               .push_opcode(opcodes::all::OP_ENDIF)
 422                               .push_int(1)
 423                               .push_opcode(opcodes::all::OP_CSV)
 424                               .push_opcode(opcodes::all::OP_DROP)
 425                               .into_script()
 426         }
 427 }
 428
 429 /// note here that 'a_revocation_key' is generated using b_revocation_basepoint and a's
 430 /// commitment secret. 'htlc' does *not* need to have its previous_output_index filled.
 431 #[inline]
 432 pub fn get_htlc_redeemscript(htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Script {
 433         get_htlc_redeemscript_with_explicit_keys(htlc, &keys.a_htlc_key, &keys.b_htlc_key, &keys.revocation_key)
 434 }
 435
 436 /// Gets the redeemscript for a funding output from the two funding public keys.
 437 /// Note that the order of funding public keys does not matter.
 438 pub fn make_funding_redeemscript(a: &PublicKey, b: &PublicKey) -> Script {
 439         let our_funding_key = a.serialize();
 440         let their_funding_key = b.serialize();
 441
 442         let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
 443         if our_funding_key[..] < their_funding_key[..] {
 444                 builder.push_slice(&our_funding_key)
 445                         .push_slice(&their_funding_key)
 446         } else {
 447                 builder.push_slice(&their_funding_key)
 448                         .push_slice(&our_funding_key)
 449         }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
 450 }
 451
 452 /// panics if htlc.transaction_output_index.is_none()!
 453 pub fn build_htlc_transaction(prev_hash: &Txid, feerate_per_kw: u64, to_self_delay: u16, htlc: &HTLCOutputInCommitment, a_delayed_payment_key: &PublicKey, revocation_key: &PublicKey) -> Transaction {
 454         let mut txins: Vec<TxIn> = Vec::new();
 455         txins.push(TxIn {
 456                 previous_output: OutPoint {
 457                         txid: prev_hash.clone(),
 458                         vout: htlc.transaction_output_index.expect("Can't build an HTLC transaction for a dust output"),
 459                 },
 460                 script_sig: Script::new(),
 461                 sequence: 1,
 462                 witness: Vec::new(),
 463         });
 464
 465         let total_fee = if htlc.offered {
 466                         feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000
 467                 } else {
 468                         feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000
 469                 };
 470
 471         let mut txouts: Vec<TxOut> = Vec::new();
 472         txouts.push(TxOut {
 473                 script_pubkey: get_revokeable_redeemscript(revocation_key, to_self_delay, a_delayed_payment_key).to_v0_p2wsh(),
 474                 value: htlc.amount_msat / 1000 - total_fee //TODO: BOLT 3 does not specify if we should add amount_msat before dividing or if we should divide by 1000 before subtracting (as we do here)
 475         });
 476
 477         Transaction {
 478                 version: 2,
 479                 lock_time: if htlc.offered { htlc.cltv_expiry } else { 0 },
 480                 input: txins,
 481                 output: txouts,
 482         }
 483 }
 484
 485 #[derive(Clone)]
 486 /// We use this to track local commitment transactions and put off signing them until we are ready
 487 /// to broadcast. Eventually this will require a signer which is possibly external, but for now we
 488 /// just pass in the SecretKeys required.
 489 pub struct LocalCommitmentTransaction {
 490         // TODO: We should migrate away from providing the transaction, instead providing enough to
 491         // allow the ChannelKeys to construct it from scratch. Luckily we already have HTLC data here,
 492         // so we're probably most of the way there.
 493         /// The commitment transaction itself, in unsigned form.
 494         pub unsigned_tx: Transaction,
 495         /// Our counterparty's signature for the transaction, above.
 496         pub their_sig: Signature,
 497         // Which order the signatures should go in when constructing the final commitment tx witness.
 498         // The user should be able to reconstruc this themselves, so we don't bother to expose it.
 499         our_sig_first: bool,
 500         /// The key derivation parameters for this commitment transaction
 501         pub local_keys: TxCreationKeys,
 502         /// The feerate paid per 1000-weight-unit in this commitment transaction. This value is
 503         /// controlled by the channel initiator.
 504         pub feerate_per_kw: u64,
 505         /// The HTLCs and remote htlc signatures which were included in this commitment transaction.
 506         ///
 507         /// Note that this includes all HTLCs, including ones which were considered dust and not
 508         /// actually included in the transaction as it appears on-chain, but who's value is burned as
 509         /// fees and not included in the to_local or to_remote outputs.
 510         ///
 511         /// The remote HTLC signatures in the second element will always be set for non-dust HTLCs, ie
 512         /// those for which transaction_output_index.is_some().
 513         pub per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)>,
 514 }
 515 impl LocalCommitmentTransaction {
 516         #[cfg(test)]
 517         pub fn dummy() -> Self {
 518                 let dummy_input = TxIn {
 519                         previous_output: OutPoint {
 520                                 txid: Default::default(),
 521                                 vout: 0,
 522                         },
 523                         script_sig: Default::default(),
 524                         sequence: 0,
 525                         witness: vec![]
 526                 };
 527                 let dummy_key = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&[42; 32]).unwrap());
 528                 let dummy_sig = Secp256k1::new().sign(&secp256k1::Message::from_slice(&[42; 32]).unwrap(), &SecretKey::from_slice(&[42; 32]).unwrap());
 529                 Self {
 530                         unsigned_tx: Transaction {
 531                                 version: 2,
 532                                 input: vec![dummy_input],
 533                                 output: Vec::new(),
 534                                 lock_time: 0,
 535                         },
 536                         their_sig: dummy_sig,
 537                         our_sig_first: false,
 538                         local_keys: TxCreationKeys {
 539                                         per_commitment_point: dummy_key.clone(),
 540                                         revocation_key: dummy_key.clone(),
 541                                         a_htlc_key: dummy_key.clone(),
 542                                         b_htlc_key: dummy_key.clone(),
 543                                         a_delayed_payment_key: dummy_key.clone(),
 544                                 },
 545                         feerate_per_kw: 0,
 546                         per_htlc: Vec::new()
 547                 }
 548         }
 549
 550         /// Generate a new LocalCommitmentTransaction based on a raw commitment transaction,
 551         /// remote signature and both parties keys
 552         pub(crate) fn new_missing_local_sig(unsigned_tx: Transaction, their_sig: Signature, our_funding_key: &PublicKey, their_funding_key: &PublicKey, local_keys: TxCreationKeys, feerate_per_kw: u64, htlc_data: Vec<(HTLCOutputInCommitment, Option<Signature>)>) -> LocalCommitmentTransaction {
 553                 if unsigned_tx.input.len() != 1 { panic!("Tried to store a commitment transaction that had input count != 1!"); }
 554                 if unsigned_tx.input[0].witness.len() != 0 { panic!("Tried to store a signed commitment transaction?"); }
 555
 556                 Self {
 557                         unsigned_tx,
 558                         their_sig,
 559                         our_sig_first: our_funding_key.serialize()[..] < their_funding_key.serialize()[..],
 560                         local_keys,
 561                         feerate_per_kw,
 562                         per_htlc: htlc_data,
 563                 }
 564         }
 565
 566         /// Get the txid of the local commitment transaction contained in this
 567         /// LocalCommitmentTransaction
 568         pub fn txid(&self) -> Txid {
 569                 self.unsigned_tx.txid()
 570         }
 571
 572         /// Gets our signature for the contained commitment transaction given our funding private key.
 573         ///
 574         /// Funding key is your key included in the 2-2 funding_outpoint lock. Should be provided
 575         /// by your ChannelKeys.
 576         /// Funding redeemscript is script locking funding_outpoint. This is the mutlsig script
 577         /// between your own funding key and your counterparty's. Currently, this is provided in
 578         /// ChannelKeys::sign_local_commitment() calls directly.
 579         /// Channel value is amount locked in funding_outpoint.
 580         pub fn get_local_sig<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
 581                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&self.unsigned_tx)
 582                         .sighash_all(&self.unsigned_tx.input[0], funding_redeemscript, channel_value_satoshis)[..]);
 583                 secp_ctx.sign(&sighash, funding_key)
 584         }
 585
 586         pub(crate) fn add_local_sig(&self, funding_redeemscript: &Script, our_sig: Signature) -> Transaction {
 587                 let mut tx = self.unsigned_tx.clone();
 588                 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
 589                 tx.input[0].witness.push(Vec::new());
 590
 591                 if self.our_sig_first {
 592                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
 593                         tx.input[0].witness.push(self.their_sig.serialize_der().to_vec());
 594                 } else {
 595                         tx.input[0].witness.push(self.their_sig.serialize_der().to_vec());
 596                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
 597                 }
 598                 tx.input[0].witness[1].push(SigHashType::All as u8);
 599                 tx.input[0].witness[2].push(SigHashType::All as u8);
 600
 601                 tx.input[0].witness.push(funding_redeemscript.as_bytes().to_vec());
 602                 tx
 603         }
 604
 605         /// Get a signature for each HTLC which was included in the commitment transaction (ie for
 606         /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
 607         ///
 608         /// The returned Vec has one entry for each HTLC, and in the same order. For HTLCs which were
 609         /// considered dust and not included, a None entry exists, for all others a signature is
 610         /// included.
 611         pub fn get_htlc_sigs<T: secp256k1::Signing + secp256k1::Verification>(&self, htlc_base_key: &SecretKey, local_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Vec<Option<Signature>>, ()> {
 612                 let txid = self.txid();
 613                 let mut ret = Vec::with_capacity(self.per_htlc.len());
 614                 let our_htlc_key = derive_private_key(secp_ctx, &self.local_keys.per_commitment_point, htlc_base_key).map_err(|_| ())?;
 615
 616                 for this_htlc in self.per_htlc.iter() {
 617                         if this_htlc.0.transaction_output_index.is_some() {
 618                                 let htlc_tx = build_htlc_transaction(&txid, self.feerate_per_kw, local_csv, &this_htlc.0, &self.local_keys.a_delayed_payment_key, &self.local_keys.revocation_key);
 619
 620                                 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc.0, &self.local_keys.a_htlc_key, &self.local_keys.b_htlc_key, &self.local_keys.revocation_key);
 621
 622                                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, this_htlc.0.amount_msat / 1000)[..]);
 623                                 ret.push(Some(secp_ctx.sign(&sighash, &our_htlc_key)));
 624                         } else {
 625                                 ret.push(None);
 626                         }
 627                 }
 628                 Ok(ret)
 629         }
 630
 631         /// Gets a signed HTLC transaction given a preimage (for !htlc.offered) and the local HTLC transaction signature.
 632         pub(crate) fn get_signed_htlc_tx(&self, htlc_index: usize, signature: &Signature, preimage: &Option<PaymentPreimage>, local_csv: u16) -> Transaction {
 633                 let txid = self.txid();
 634                 let this_htlc = &self.per_htlc[htlc_index];
 635                 assert!(this_htlc.0.transaction_output_index.is_some());
 636                 // if we don't have preimage for an HTLC-Success, we can't generate an HTLC transaction.
 637                 if !this_htlc.0.offered && preimage.is_none() { unreachable!(); }
 638                 // Further, we should never be provided the preimage for an HTLC-Timeout transaction.
 639                 if  this_htlc.0.offered && preimage.is_some() { unreachable!(); }
 640
 641                 let mut htlc_tx = build_htlc_transaction(&txid, self.feerate_per_kw, local_csv, &this_htlc.0, &self.local_keys.a_delayed_payment_key, &self.local_keys.revocation_key);
 642                 // Channel should have checked that we have a remote signature for this HTLC at
 643                 // creation, and we should have a sensible htlc transaction:
 644                 assert!(this_htlc.1.is_some());
 645
 646                 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc.0, &self.local_keys.a_htlc_key, &self.local_keys.b_htlc_key, &self.local_keys.revocation_key);
 647
 648                 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
 649                 htlc_tx.input[0].witness.push(Vec::new());
 650
 651                 htlc_tx.input[0].witness.push(this_htlc.1.unwrap().serialize_der().to_vec());
 652                 htlc_tx.input[0].witness.push(signature.serialize_der().to_vec());
 653                 htlc_tx.input[0].witness[1].push(SigHashType::All as u8);
 654                 htlc_tx.input[0].witness[2].push(SigHashType::All as u8);
 655
 656                 if this_htlc.0.offered {
 657                         // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
 658                         htlc_tx.input[0].witness.push(Vec::new());
 659                 } else {
 660                         htlc_tx.input[0].witness.push(preimage.unwrap().0.to_vec());
 661                 }
 662
 663                 htlc_tx.input[0].witness.push(htlc_redeemscript.as_bytes().to_vec());
 664                 htlc_tx
 665         }
 666 }
 667 impl PartialEq for LocalCommitmentTransaction {
 668         // We dont care whether we are signed in equality comparison
 669         fn eq(&self, o: &Self) -> bool {
 670                 self.txid() == o.txid()
 671         }
 672 }
 673 impl Writeable for LocalCommitmentTransaction {
 674         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 675                 if let Err(e) = self.unsigned_tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
 676                         match e {
 677                                 encode::Error::Io(e) => return Err(e),
 678                                 _ => panic!("local tx must have been well-formed!"),
 679                         }
 680                 }
 681                 self.their_sig.write(writer)?;
 682                 self.our_sig_first.write(writer)?;
 683                 self.local_keys.write(writer)?;
 684                 self.feerate_per_kw.write(writer)?;
 685                 writer.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
 686                 for &(ref htlc, ref sig) in self.per_htlc.iter() {
 687                         htlc.write(writer)?;
 688                         sig.write(writer)?;
 689                 }
 690                 Ok(())
 691         }
 692 }
 693 impl Readable for LocalCommitmentTransaction {
 694         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 695                 let unsigned_tx = match Transaction::consensus_decode(reader.by_ref()) {
 696                         Ok(tx) => tx,
 697                         Err(e) => match e {
 698                                 encode::Error::Io(ioe) => return Err(DecodeError::Io(ioe)),
 699                                 _ => return Err(DecodeError::InvalidValue),
 700                         },
 701                 };
 702                 let their_sig = Readable::read(reader)?;
 703                 let our_sig_first = Readable::read(reader)?;
 704                 let local_keys = Readable::read(reader)?;
 705                 let feerate_per_kw = Readable::read(reader)?;
 706                 let htlcs_count: u64 = Readable::read(reader)?;
 707                 let mut per_htlc = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / mem::size_of::<(HTLCOutputInCommitment, Option<Signature>)>()));
 708                 for _ in 0..htlcs_count {
 709                         let htlc: HTLCOutputInCommitment = Readable::read(reader)?;
 710                         let sigs = Readable::read(reader)?;
 711                         per_htlc.push((htlc, sigs));
 712                 }
 713
 714                 if unsigned_tx.input.len() != 1 {
 715                         // Ensure tx didn't hit the 0-input ambiguity case.
 716                         return Err(DecodeError::InvalidValue);
 717                 }
 718                 Ok(Self {
 719                         unsigned_tx,
 720                         their_sig,
 721                         our_sig_first,
 722                         local_keys,
 723                         feerate_per_kw,
 724                         per_htlc,
 725                 })
 726         }
 727 }
 728
 729 #[cfg(test)]
 730 mod tests {
 731         use super::CounterpartyCommitmentSecrets;
 732         use hex;
 733
 734         #[test]
 735         fn test_per_commitment_storage() {
 736                 // Test vectors from BOLT 3:
 737                 let mut secrets: Vec<[u8; 32]> = Vec::new();
 738                 let mut monitor;
 739
 740                 macro_rules! test_secrets {
 741                         () => {
 742                                 let mut idx = 281474976710655;
 743                                 for secret in secrets.iter() {
 744                                         assert_eq!(monitor.get_secret(idx).unwrap(), *secret);
 745                                         idx -= 1;
 746                                 }
 747                                 assert_eq!(monitor.get_min_seen_secret(), idx + 1);
 748                                 assert!(monitor.get_secret(idx).is_none());
 749                         };
 750                 }
 751
 752                 {
 753                         // insert_secret correct sequence
 754                         monitor = CounterpartyCommitmentSecrets::new();
 755                         secrets.clear();
 756
 757                         secrets.push([0; 32]);
 758                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 759                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 760                         test_secrets!();
 761
 762                         secrets.push([0; 32]);
 763                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 764                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 765                         test_secrets!();
 766
 767                         secrets.push([0; 32]);
 768                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 769                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 770                         test_secrets!();
 771
 772                         secrets.push([0; 32]);
 773                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 774                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 775                         test_secrets!();
 776
 777                         secrets.push([0; 32]);
 778                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
 779                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 780                         test_secrets!();
 781
 782                         secrets.push([0; 32]);
 783                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 784                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 785                         test_secrets!();
 786
 787                         secrets.push([0; 32]);
 788                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 789                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 790                         test_secrets!();
 791
 792                         secrets.push([0; 32]);
 793                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 794                         monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).unwrap();
 795                         test_secrets!();
 796                 }
 797
 798                 {
 799                         // insert_secret #1 incorrect
 800                         monitor = CounterpartyCommitmentSecrets::new();
 801                         secrets.clear();
 802
 803                         secrets.push([0; 32]);
 804                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 805                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 806                         test_secrets!();
 807
 808                         secrets.push([0; 32]);
 809                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 810                         assert!(monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).is_err());
 811                 }
 812
 813                 {
 814                         // insert_secret #2 incorrect (#1 derived from incorrect)
 815                         monitor = CounterpartyCommitmentSecrets::new();
 816                         secrets.clear();
 817
 818                         secrets.push([0; 32]);
 819                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 820                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 821                         test_secrets!();
 822
 823                         secrets.push([0; 32]);
 824                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
 825                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 826                         test_secrets!();
 827
 828                         secrets.push([0; 32]);
 829                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 830                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 831                         test_secrets!();
 832
 833                         secrets.push([0; 32]);
 834                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 835                         assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
 836                 }
 837
 838                 {
 839                         // insert_secret #3 incorrect
 840                         monitor = CounterpartyCommitmentSecrets::new();
 841                         secrets.clear();
 842
 843                         secrets.push([0; 32]);
 844                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 845                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 846                         test_secrets!();
 847
 848                         secrets.push([0; 32]);
 849                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 850                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 851                         test_secrets!();
 852
 853                         secrets.push([0; 32]);
 854                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
 855                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 856                         test_secrets!();
 857
 858                         secrets.push([0; 32]);
 859                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 860                         assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
 861                 }
 862
 863                 {
 864                         // insert_secret #4 incorrect (1,2,3 derived from incorrect)
 865                         monitor = CounterpartyCommitmentSecrets::new();
 866                         secrets.clear();
 867
 868                         secrets.push([0; 32]);
 869                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 870                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 871                         test_secrets!();
 872
 873                         secrets.push([0; 32]);
 874                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
 875                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 876                         test_secrets!();
 877
 878                         secrets.push([0; 32]);
 879                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
 880                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 881                         test_secrets!();
 882
 883                         secrets.push([0; 32]);
 884                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("ba65d7b0ef55a3ba300d4e87af29868f394f8f138d78a7011669c79b37b936f4").unwrap());
 885                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 886                         test_secrets!();
 887
 888                         secrets.push([0; 32]);
 889                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
 890                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 891                         test_secrets!();
 892
 893                         secrets.push([0; 32]);
 894                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 895                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 896                         test_secrets!();
 897
 898                         secrets.push([0; 32]);
 899                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 900                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 901                         test_secrets!();
 902
 903                         secrets.push([0; 32]);
 904                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 905                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
 906                 }
 907
 908                 {
 909                         // insert_secret #5 incorrect
 910                         monitor = CounterpartyCommitmentSecrets::new();
 911                         secrets.clear();
 912
 913                         secrets.push([0; 32]);
 914                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 915                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 916                         test_secrets!();
 917
 918                         secrets.push([0; 32]);
 919                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 920                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 921                         test_secrets!();
 922
 923                         secrets.push([0; 32]);
 924                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 925                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 926                         test_secrets!();
 927
 928                         secrets.push([0; 32]);
 929                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 930                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 931                         test_secrets!();
 932
 933                         secrets.push([0; 32]);
 934                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
 935                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 936                         test_secrets!();
 937
 938                         secrets.push([0; 32]);
 939                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 940                         assert!(monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).is_err());
 941                 }
 942
 943                 {
 944                         // insert_secret #6 incorrect (5 derived from incorrect)
 945                         monitor = CounterpartyCommitmentSecrets::new();
 946                         secrets.clear();
 947
 948                         secrets.push([0; 32]);
 949                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 950                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 951                         test_secrets!();
 952
 953                         secrets.push([0; 32]);
 954                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 955                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 956                         test_secrets!();
 957
 958                         secrets.push([0; 32]);
 959                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 960                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 961                         test_secrets!();
 962
 963                         secrets.push([0; 32]);
 964                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 965                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 966                         test_secrets!();
 967
 968                         secrets.push([0; 32]);
 969                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
 970                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 971                         test_secrets!();
 972
 973                         secrets.push([0; 32]);
 974                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("b7e76a83668bde38b373970155c868a653304308f9896692f904a23731224bb1").unwrap());
 975                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 976                         test_secrets!();
 977
 978                         secrets.push([0; 32]);
 979                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 980                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 981                         test_secrets!();
 982
 983                         secrets.push([0; 32]);
 984                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 985                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
 986                 }
 987
 988                 {
 989                         // insert_secret #7 incorrect
 990                         monitor = CounterpartyCommitmentSecrets::new();
 991                         secrets.clear();
 992
 993                         secrets.push([0; 32]);
 994                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 995                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 996                         test_secrets!();
 997
 998                         secrets.push([0; 32]);
 999                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1000                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1001                         test_secrets!();
1002
1003                         secrets.push([0; 32]);
1004                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1005                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1006                         test_secrets!();
1007
1008                         secrets.push([0; 32]);
1009                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1010                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1011                         test_secrets!();
1012
1013                         secrets.push([0; 32]);
1014                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1015                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1016                         test_secrets!();
1017
1018                         secrets.push([0; 32]);
1019                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1020                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1021                         test_secrets!();
1022
1023                         secrets.push([0; 32]);
1024                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("e7971de736e01da8ed58b94c2fc216cb1dca9e326f3a96e7194fe8ea8af6c0a3").unwrap());
1025                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1026                         test_secrets!();
1027
1028                         secrets.push([0; 32]);
1029                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1030                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1031                 }
1032
1033                 {
1034                         // insert_secret #8 incorrect
1035                         monitor = CounterpartyCommitmentSecrets::new();
1036                         secrets.clear();
1037
1038                         secrets.push([0; 32]);
1039                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1040                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1041                         test_secrets!();
1042
1043                         secrets.push([0; 32]);
1044                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1045                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1046                         test_secrets!();
1047
1048                         secrets.push([0; 32]);
1049                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1050                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1051                         test_secrets!();
1052
1053                         secrets.push([0; 32]);
1054                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1055                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1056                         test_secrets!();
1057
1058                         secrets.push([0; 32]);
1059                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1060                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1061                         test_secrets!();
1062
1063                         secrets.push([0; 32]);
1064                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1065                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1066                         test_secrets!();
1067
1068                         secrets.push([0; 32]);
1069                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1070                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1071                         test_secrets!();
1072
1073                         secrets.push([0; 32]);
1074                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a7efbc61aac46d34f77778bac22c8a20c6a46ca460addc49009bda875ec88fa4").unwrap());
1075                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1076                 }
1077         }
1078 }