1 // This file is Copyright its original authors, visible in version control
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
10 //! Various utilities for building scripts and deriving keys related to channels. These are
11 //! largely of interest for those implementing chain::keysinterface::Sign message signing by hand.
13 use bitcoin::blockdata::script::{Script,Builder};
14 use bitcoin::blockdata::opcodes;
15 use bitcoin::blockdata::transaction::{TxIn,TxOut,OutPoint,Transaction, SigHashType};
16 use bitcoin::util::bip143;
18 use bitcoin::hashes::{Hash, HashEngine};
19 use bitcoin::hashes::sha256::Hash as Sha256;
20 use bitcoin::hashes::ripemd160::Hash as Ripemd160;
21 use bitcoin::hash_types::{Txid, PubkeyHash};
23 use ln::{PaymentHash, PaymentPreimage};
24 use ln::msgs::DecodeError;
25 use util::ser::{Readable, Writeable, Writer};
26 use util::{byte_utils, transaction_utils};
28 use bitcoin::hash_types::WPubkeyHash;
29 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
30 use bitcoin::secp256k1::{Secp256k1, Signature, Message};
31 use bitcoin::secp256k1::Error as SecpError;
32 use bitcoin::secp256k1;
38 use util::transaction_utils::sort_outputs;
39 use ln::channel::{INITIAL_COMMITMENT_NUMBER, ANCHOR_OUTPUT_VALUE_SATOSHI};
43 pub(crate) const MAX_HTLCS: u16 = 483;
45 pub(super) const HTLC_SUCCESS_TX_WEIGHT: u64 = 703;
46 pub(super) const HTLC_TIMEOUT_TX_WEIGHT: u64 = 663;
48 /// Gets the weight for an HTLC-Success transaction.
50 pub fn htlc_success_tx_weight(opt_anchors: bool) -> u64 {
51 const HTLC_SUCCESS_ANCHOR_TX_WEIGHT: u64 = 706;
52 if opt_anchors { HTLC_SUCCESS_ANCHOR_TX_WEIGHT } else { HTLC_SUCCESS_TX_WEIGHT }
55 /// Gets the weight for an HTLC-Timeout transaction.
57 pub fn htlc_timeout_tx_weight(opt_anchors: bool) -> u64 {
58 const HTLC_TIMEOUT_ANCHOR_TX_WEIGHT: u64 = 666;
59 if opt_anchors { HTLC_TIMEOUT_ANCHOR_TX_WEIGHT } else { HTLC_TIMEOUT_TX_WEIGHT }
63 pub(crate) enum HTLCType {
69 /// Check if a given tx witnessScript len matchs one of a pre-signed HTLC
70 pub(crate) fn scriptlen_to_htlctype(witness_script_len: usize) -> Option<HTLCType> {
71 if witness_script_len == 133 {
72 Some(HTLCType::OfferedHTLC)
73 } else if witness_script_len >= 136 && witness_script_len <= 139 {
74 Some(HTLCType::AcceptedHTLC)
81 // Various functions for key derivation and transaction creation for use within channels. Primarily
82 // used in Channel and ChannelMonitor.
84 /// Build the commitment secret from the seed and the commitment number
85 pub fn build_commitment_secret(commitment_seed: &[u8; 32], idx: u64) -> [u8; 32] {
86 let mut res: [u8; 32] = commitment_seed.clone();
89 if idx & (1 << bitpos) == (1 << bitpos) {
90 res[bitpos / 8] ^= 1 << (bitpos & 7);
91 res = Sha256::hash(&res).into_inner();
97 /// Build a closing transaction
98 pub fn build_closing_transaction(to_holder_value_sat: u64, to_counterparty_value_sat: u64, to_holder_script: Script, to_counterparty_script: Script, funding_outpoint: OutPoint) -> Transaction {
100 let mut ins: Vec<TxIn> = Vec::new();
102 previous_output: funding_outpoint,
103 script_sig: Script::new(),
104 sequence: 0xffffffff,
110 let mut txouts: Vec<(TxOut, ())> = Vec::new();
112 if to_counterparty_value_sat > 0 {
114 script_pubkey: to_counterparty_script,
115 value: to_counterparty_value_sat
119 if to_holder_value_sat > 0 {
121 script_pubkey: to_holder_script,
122 value: to_holder_value_sat
126 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
128 let mut outputs: Vec<TxOut> = Vec::new();
129 for out in txouts.drain(..) {
141 /// Implements the per-commitment secret storage scheme from
142 /// [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
144 /// Allows us to keep track of all of the revocation secrets of counterarties in just 50*32 bytes
147 pub(crate) struct CounterpartyCommitmentSecrets {
148 old_secrets: [([u8; 32], u64); 49],
151 impl PartialEq for CounterpartyCommitmentSecrets {
152 fn eq(&self, other: &Self) -> bool {
153 for (&(ref secret, ref idx), &(ref o_secret, ref o_idx)) in self.old_secrets.iter().zip(other.old_secrets.iter()) {
154 if secret != o_secret || idx != o_idx {
162 impl CounterpartyCommitmentSecrets {
163 pub(crate) fn new() -> Self {
164 Self { old_secrets: [([0; 32], 1 << 48); 49], }
168 fn place_secret(idx: u64) -> u8 {
170 if idx & (1 << i) == (1 << i) {
177 pub(crate) fn get_min_seen_secret(&self) -> u64 {
178 //TODO This can be optimized?
179 let mut min = 1 << 48;
180 for &(_, idx) in self.old_secrets.iter() {
189 fn derive_secret(secret: [u8; 32], bits: u8, idx: u64) -> [u8; 32] {
190 let mut res: [u8; 32] = secret;
192 let bitpos = bits - 1 - i;
193 if idx & (1 << bitpos) == (1 << bitpos) {
194 res[(bitpos / 8) as usize] ^= 1 << (bitpos & 7);
195 res = Sha256::hash(&res).into_inner();
201 pub(crate) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), ()> {
202 let pos = Self::place_secret(idx);
204 let (old_secret, old_idx) = self.old_secrets[i as usize];
205 if Self::derive_secret(secret, pos, old_idx) != old_secret {
209 if self.get_min_seen_secret() <= idx {
212 self.old_secrets[pos as usize] = (secret, idx);
216 /// Can only fail if idx is < get_min_seen_secret
217 pub(crate) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
218 for i in 0..self.old_secrets.len() {
219 if (idx & (!((1 << i) - 1))) == self.old_secrets[i].1 {
220 return Some(Self::derive_secret(self.old_secrets[i].0, i as u8, idx))
223 assert!(idx < self.get_min_seen_secret());
228 impl Writeable for CounterpartyCommitmentSecrets {
229 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
230 for &(ref secret, ref idx) in self.old_secrets.iter() {
231 writer.write_all(secret)?;
232 writer.write_all(&byte_utils::be64_to_array(*idx))?;
234 write_tlv_fields!(writer, {});
238 impl Readable for CounterpartyCommitmentSecrets {
239 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
240 let mut old_secrets = [([0; 32], 1 << 48); 49];
241 for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() {
242 *secret = Readable::read(reader)?;
243 *idx = Readable::read(reader)?;
245 read_tlv_fields!(reader, {});
246 Ok(Self { old_secrets })
250 /// Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
251 /// from the base secret and the per_commitment_point.
253 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
254 /// generated (ie our own).
255 pub fn derive_private_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_secret: &SecretKey) -> Result<SecretKey, SecpError> {
256 let mut sha = Sha256::engine();
257 sha.input(&per_commitment_point.serialize());
258 sha.input(&PublicKey::from_secret_key(&secp_ctx, &base_secret).serialize());
259 let res = Sha256::from_engine(sha).into_inner();
261 let mut key = base_secret.clone();
262 key.add_assign(&res)?;
266 /// Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
267 /// from the base point and the per_commitment_key. This is the public equivalent of
268 /// derive_private_key - using only public keys to derive a public key instead of private keys.
270 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
271 /// generated (ie our own).
272 pub fn derive_public_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_point: &PublicKey) -> Result<PublicKey, SecpError> {
273 let mut sha = Sha256::engine();
274 sha.input(&per_commitment_point.serialize());
275 sha.input(&base_point.serialize());
276 let res = Sha256::from_engine(sha).into_inner();
278 let hashkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&res)?);
279 base_point.combine(&hashkey)
282 /// Derives a per-commitment-transaction revocation key from its constituent parts.
284 /// Only the cheating participant owns a valid witness to propagate a revoked
285 /// commitment transaction, thus per_commitment_secret always come from cheater
286 /// and revocation_base_secret always come from punisher, which is the broadcaster
287 /// of the transaction spending with this key knowledge.
289 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
290 /// generated (ie our own).
291 pub fn derive_private_revocation_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_secret: &SecretKey, countersignatory_revocation_base_secret: &SecretKey) -> Result<SecretKey, SecpError> {
292 let countersignatory_revocation_base_point = PublicKey::from_secret_key(&secp_ctx, &countersignatory_revocation_base_secret);
293 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
295 let rev_append_commit_hash_key = {
296 let mut sha = Sha256::engine();
297 sha.input(&countersignatory_revocation_base_point.serialize());
298 sha.input(&per_commitment_point.serialize());
300 Sha256::from_engine(sha).into_inner()
302 let commit_append_rev_hash_key = {
303 let mut sha = Sha256::engine();
304 sha.input(&per_commitment_point.serialize());
305 sha.input(&countersignatory_revocation_base_point.serialize());
307 Sha256::from_engine(sha).into_inner()
310 let mut countersignatory_contrib = countersignatory_revocation_base_secret.clone();
311 countersignatory_contrib.mul_assign(&rev_append_commit_hash_key)?;
312 let mut broadcaster_contrib = per_commitment_secret.clone();
313 broadcaster_contrib.mul_assign(&commit_append_rev_hash_key)?;
314 countersignatory_contrib.add_assign(&broadcaster_contrib[..])?;
315 Ok(countersignatory_contrib)
318 /// Derives a per-commitment-transaction revocation public key from its constituent parts. This is
319 /// the public equivalend of derive_private_revocation_key - using only public keys to derive a
320 /// public key instead of private keys.
322 /// Only the cheating participant owns a valid witness to propagate a revoked
323 /// commitment transaction, thus per_commitment_point always come from cheater
324 /// and revocation_base_point always come from punisher, which is the broadcaster
325 /// of the transaction spending with this key knowledge.
327 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
328 /// generated (ie our own).
329 pub fn derive_public_revocation_key<T: secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, countersignatory_revocation_base_point: &PublicKey) -> Result<PublicKey, SecpError> {
330 let rev_append_commit_hash_key = {
331 let mut sha = Sha256::engine();
332 sha.input(&countersignatory_revocation_base_point.serialize());
333 sha.input(&per_commitment_point.serialize());
335 Sha256::from_engine(sha).into_inner()
337 let commit_append_rev_hash_key = {
338 let mut sha = Sha256::engine();
339 sha.input(&per_commitment_point.serialize());
340 sha.input(&countersignatory_revocation_base_point.serialize());
342 Sha256::from_engine(sha).into_inner()
345 let mut countersignatory_contrib = countersignatory_revocation_base_point.clone();
346 countersignatory_contrib.mul_assign(&secp_ctx, &rev_append_commit_hash_key)?;
347 let mut broadcaster_contrib = per_commitment_point.clone();
348 broadcaster_contrib.mul_assign(&secp_ctx, &commit_append_rev_hash_key)?;
349 countersignatory_contrib.combine(&broadcaster_contrib)
352 /// The set of public keys which are used in the creation of one commitment transaction.
353 /// These are derived from the channel base keys and per-commitment data.
355 /// A broadcaster key is provided from potential broadcaster of the computed transaction.
356 /// A countersignatory key is coming from a protocol participant unable to broadcast the
359 /// These keys are assumed to be good, either because the code derived them from
360 /// channel basepoints via the new function, or they were obtained via
361 /// CommitmentTransaction.trust().keys() because we trusted the source of the
362 /// pre-calculated keys.
363 #[derive(PartialEq, Clone)]
364 pub struct TxCreationKeys {
365 /// The broadcaster's per-commitment public key which was used to derive the other keys.
366 pub per_commitment_point: PublicKey,
367 /// The revocation key which is used to allow the broadcaster of the commitment
368 /// transaction to provide their counterparty the ability to punish them if they broadcast
370 pub revocation_key: PublicKey,
371 /// Broadcaster's HTLC Key
372 pub broadcaster_htlc_key: PublicKey,
373 /// Countersignatory's HTLC Key
374 pub countersignatory_htlc_key: PublicKey,
375 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
376 pub broadcaster_delayed_payment_key: PublicKey,
379 impl_writeable_tlv_based!(TxCreationKeys, {
380 (0, per_commitment_point, required),
381 (2, revocation_key, required),
382 (4, broadcaster_htlc_key, required),
383 (6, countersignatory_htlc_key, required),
384 (8, broadcaster_delayed_payment_key, required),
387 /// One counterparty's public keys which do not change over the life of a channel.
388 #[derive(Clone, PartialEq)]
389 pub struct ChannelPublicKeys {
390 /// The public key which is used to sign all commitment transactions, as it appears in the
391 /// on-chain channel lock-in 2-of-2 multisig output.
392 pub funding_pubkey: PublicKey,
393 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
394 /// revocation keys. This is combined with the per-commitment-secret generated by the
395 /// counterparty to create a secret which the counterparty can reveal to revoke previous
397 pub revocation_basepoint: PublicKey,
398 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
399 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
400 /// static across every commitment transaction.
401 pub payment_point: PublicKey,
402 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
403 /// public key which receives non-HTLC-encumbered funds which are only available for spending
404 /// after some delay (or can be claimed via the revocation path).
405 pub delayed_payment_basepoint: PublicKey,
406 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
407 /// which is used to encumber HTLC-in-flight outputs.
408 pub htlc_basepoint: PublicKey,
411 impl_writeable_tlv_based!(ChannelPublicKeys, {
412 (0, funding_pubkey, required),
413 (2, revocation_basepoint, required),
414 (4, payment_point, required),
415 (6, delayed_payment_basepoint, required),
416 (8, htlc_basepoint, required),
419 impl TxCreationKeys {
420 /// Create per-state keys from channel base points and the per-commitment point.
421 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
422 pub fn derive_new<T: secp256k1::Signing + secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, broadcaster_delayed_payment_base: &PublicKey, broadcaster_htlc_base: &PublicKey, countersignatory_revocation_base: &PublicKey, countersignatory_htlc_base: &PublicKey) -> Result<TxCreationKeys, SecpError> {
424 per_commitment_point: per_commitment_point.clone(),
425 revocation_key: derive_public_revocation_key(&secp_ctx, &per_commitment_point, &countersignatory_revocation_base)?,
426 broadcaster_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &broadcaster_htlc_base)?,
427 countersignatory_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &countersignatory_htlc_base)?,
428 broadcaster_delayed_payment_key: derive_public_key(&secp_ctx, &per_commitment_point, &broadcaster_delayed_payment_base)?,
432 /// Generate per-state keys from channel static keys.
433 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
434 pub fn from_channel_static_keys<T: secp256k1::Signing + secp256k1::Verification>(per_commitment_point: &PublicKey, broadcaster_keys: &ChannelPublicKeys, countersignatory_keys: &ChannelPublicKeys, secp_ctx: &Secp256k1<T>) -> Result<TxCreationKeys, SecpError> {
435 TxCreationKeys::derive_new(
437 &per_commitment_point,
438 &broadcaster_keys.delayed_payment_basepoint,
439 &broadcaster_keys.htlc_basepoint,
440 &countersignatory_keys.revocation_basepoint,
441 &countersignatory_keys.htlc_basepoint,
446 /// The maximum length of a script returned by get_revokeable_redeemscript.
447 // Calculated as 6 bytes of opcodes, 1 byte push plus 2 bytes for contest_delay, and two public
448 // keys of 33 bytes (+ 1 push).
449 pub const REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH: usize = 6 + 3 + 34*2;
451 /// A script either spendable by the revocation
452 /// key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
453 /// Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
454 pub fn get_revokeable_redeemscript(revocation_key: &PublicKey, contest_delay: u16, broadcaster_delayed_payment_key: &PublicKey) -> Script {
455 let res = Builder::new().push_opcode(opcodes::all::OP_IF)
456 .push_slice(&revocation_key.serialize())
457 .push_opcode(opcodes::all::OP_ELSE)
458 .push_int(contest_delay as i64)
459 .push_opcode(opcodes::all::OP_CSV)
460 .push_opcode(opcodes::all::OP_DROP)
461 .push_slice(&broadcaster_delayed_payment_key.serialize())
462 .push_opcode(opcodes::all::OP_ENDIF)
463 .push_opcode(opcodes::all::OP_CHECKSIG)
465 debug_assert!(res.len() <= REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH);
469 #[derive(Clone, PartialEq)]
470 /// Information about an HTLC as it appears in a commitment transaction
471 pub struct HTLCOutputInCommitment {
472 /// Whether the HTLC was "offered" (ie outbound in relation to this commitment transaction).
473 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
474 /// need to compare this value to whether the commitment transaction in question is that of
475 /// the counterparty or our own.
477 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
478 /// this divided by 1000.
479 pub amount_msat: u64,
480 /// The CLTV lock-time at which this HTLC expires.
481 pub cltv_expiry: u32,
482 /// The hash of the preimage which unlocks this HTLC.
483 pub payment_hash: PaymentHash,
484 /// The position within the commitment transactions' outputs. This may be None if the value is
485 /// below the dust limit (in which case no output appears in the commitment transaction and the
486 /// value is spent to additional transaction fees).
487 pub transaction_output_index: Option<u32>,
490 impl_writeable_tlv_based!(HTLCOutputInCommitment, {
491 (0, offered, required),
492 (2, amount_msat, required),
493 (4, cltv_expiry, required),
494 (6, payment_hash, required),
495 (8, transaction_output_index, option),
499 pub(crate) fn get_htlc_redeemscript_with_explicit_keys(htlc: &HTLCOutputInCommitment, opt_anchors: bool, broadcaster_htlc_key: &PublicKey, countersignatory_htlc_key: &PublicKey, revocation_key: &PublicKey) -> Script {
500 let payment_hash160 = Ripemd160::hash(&htlc.payment_hash.0[..]).into_inner();
502 let mut bldr = Builder::new().push_opcode(opcodes::all::OP_DUP)
503 .push_opcode(opcodes::all::OP_HASH160)
504 .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
505 .push_opcode(opcodes::all::OP_EQUAL)
506 .push_opcode(opcodes::all::OP_IF)
507 .push_opcode(opcodes::all::OP_CHECKSIG)
508 .push_opcode(opcodes::all::OP_ELSE)
509 .push_slice(&countersignatory_htlc_key.serialize()[..])
510 .push_opcode(opcodes::all::OP_SWAP)
511 .push_opcode(opcodes::all::OP_SIZE)
513 .push_opcode(opcodes::all::OP_EQUAL)
514 .push_opcode(opcodes::all::OP_NOTIF)
515 .push_opcode(opcodes::all::OP_DROP)
517 .push_opcode(opcodes::all::OP_SWAP)
518 .push_slice(&broadcaster_htlc_key.serialize()[..])
520 .push_opcode(opcodes::all::OP_CHECKMULTISIG)
521 .push_opcode(opcodes::all::OP_ELSE)
522 .push_opcode(opcodes::all::OP_HASH160)
523 .push_slice(&payment_hash160)
524 .push_opcode(opcodes::all::OP_EQUALVERIFY)
525 .push_opcode(opcodes::all::OP_CHECKSIG)
526 .push_opcode(opcodes::all::OP_ENDIF);
528 bldr = bldr.push_opcode(opcodes::all::OP_PUSHNUM_1)
529 .push_opcode(opcodes::all::OP_CSV)
530 .push_opcode(opcodes::all::OP_DROP);
532 bldr.push_opcode(opcodes::all::OP_ENDIF)
535 let mut bldr = Builder::new().push_opcode(opcodes::all::OP_DUP)
536 .push_opcode(opcodes::all::OP_HASH160)
537 .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
538 .push_opcode(opcodes::all::OP_EQUAL)
539 .push_opcode(opcodes::all::OP_IF)
540 .push_opcode(opcodes::all::OP_CHECKSIG)
541 .push_opcode(opcodes::all::OP_ELSE)
542 .push_slice(&countersignatory_htlc_key.serialize()[..])
543 .push_opcode(opcodes::all::OP_SWAP)
544 .push_opcode(opcodes::all::OP_SIZE)
546 .push_opcode(opcodes::all::OP_EQUAL)
547 .push_opcode(opcodes::all::OP_IF)
548 .push_opcode(opcodes::all::OP_HASH160)
549 .push_slice(&payment_hash160)
550 .push_opcode(opcodes::all::OP_EQUALVERIFY)
552 .push_opcode(opcodes::all::OP_SWAP)
553 .push_slice(&broadcaster_htlc_key.serialize()[..])
555 .push_opcode(opcodes::all::OP_CHECKMULTISIG)
556 .push_opcode(opcodes::all::OP_ELSE)
557 .push_opcode(opcodes::all::OP_DROP)
558 .push_int(htlc.cltv_expiry as i64)
559 .push_opcode(opcodes::all::OP_CLTV)
560 .push_opcode(opcodes::all::OP_DROP)
561 .push_opcode(opcodes::all::OP_CHECKSIG)
562 .push_opcode(opcodes::all::OP_ENDIF);
564 bldr = bldr.push_opcode(opcodes::all::OP_PUSHNUM_1)
565 .push_opcode(opcodes::all::OP_CSV)
566 .push_opcode(opcodes::all::OP_DROP);
568 bldr.push_opcode(opcodes::all::OP_ENDIF)
573 /// Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
574 /// does not need to have its previous_output_index filled.
576 pub fn get_htlc_redeemscript(htlc: &HTLCOutputInCommitment, opt_anchors: bool, keys: &TxCreationKeys) -> Script {
577 get_htlc_redeemscript_with_explicit_keys(htlc, opt_anchors, &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key)
580 /// Gets the redeemscript for a funding output from the two funding public keys.
581 /// Note that the order of funding public keys does not matter.
582 pub fn make_funding_redeemscript(broadcaster: &PublicKey, countersignatory: &PublicKey) -> Script {
583 let broadcaster_funding_key = broadcaster.serialize();
584 let countersignatory_funding_key = countersignatory.serialize();
586 let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
587 if broadcaster_funding_key[..] < countersignatory_funding_key[..] {
588 builder.push_slice(&broadcaster_funding_key)
589 .push_slice(&countersignatory_funding_key)
591 builder.push_slice(&countersignatory_funding_key)
592 .push_slice(&broadcaster_funding_key)
593 }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
596 /// Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
597 /// parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
598 /// transaction which needs signing, and can be used to construct an HTLC transaction which is
599 /// broadcastable given a counterparty HTLC signature.
601 /// Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
602 /// commitment transaction).
603 pub fn build_htlc_transaction(commitment_txid: &Txid, feerate_per_kw: u32, contest_delay: u16, htlc: &HTLCOutputInCommitment, opt_anchors: bool, broadcaster_delayed_payment_key: &PublicKey, revocation_key: &PublicKey) -> Transaction {
604 let mut txins: Vec<TxIn> = Vec::new();
606 previous_output: OutPoint {
607 txid: commitment_txid.clone(),
608 vout: htlc.transaction_output_index.expect("Can't build an HTLC transaction for a dust output"),
610 script_sig: Script::new(),
611 sequence: if opt_anchors { 1 } else { 0 },
615 let weight = if htlc.offered {
616 htlc_timeout_tx_weight(opt_anchors)
618 htlc_success_tx_weight(opt_anchors)
620 let total_fee = feerate_per_kw as u64 * weight / 1000;
622 let mut txouts: Vec<TxOut> = Vec::new();
624 script_pubkey: get_revokeable_redeemscript(revocation_key, contest_delay, broadcaster_delayed_payment_key).to_v0_p2wsh(),
625 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)
630 lock_time: if htlc.offered { htlc.cltv_expiry } else { 0 },
636 /// Gets the witnessScript for the to_remote output when anchors are enabled.
638 pub(crate) fn get_to_countersignatory_with_anchors_redeemscript(payment_point: &PublicKey) -> Script {
640 .push_slice(&payment_point.serialize()[..])
641 .push_opcode(opcodes::all::OP_CHECKSIGVERIFY)
643 .push_opcode(opcodes::all::OP_CSV)
647 /// Gets the witnessScript for an anchor output from the funding public key.
648 /// The witness in the spending input must be:
649 /// <BIP 143 funding_signature>
650 /// After 16 blocks of confirmation, an alternative satisfying witness could be:
652 /// (empty vector required to satisfy compliance with MINIMALIF-standard rule)
654 pub fn get_anchor_redeemscript(funding_pubkey: &PublicKey) -> Script {
655 Builder::new().push_slice(&funding_pubkey.serialize()[..])
656 .push_opcode(opcodes::all::OP_CHECKSIG)
657 .push_opcode(opcodes::all::OP_IFDUP)
658 .push_opcode(opcodes::all::OP_NOTIF)
660 .push_opcode(opcodes::all::OP_CSV)
661 .push_opcode(opcodes::all::OP_ENDIF)
665 /// Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
666 /// The fields are organized by holder/counterparty.
668 /// Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
669 /// before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
671 pub struct ChannelTransactionParameters {
672 /// Holder public keys
673 pub holder_pubkeys: ChannelPublicKeys,
674 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
675 pub holder_selected_contest_delay: u16,
676 /// Whether the holder is the initiator of this channel.
677 /// This is an input to the commitment number obscure factor computation.
678 pub is_outbound_from_holder: bool,
679 /// The late-bound counterparty channel transaction parameters.
680 /// These parameters are populated at the point in the protocol where the counterparty provides them.
681 pub counterparty_parameters: Option<CounterpartyChannelTransactionParameters>,
682 /// The late-bound funding outpoint
683 pub funding_outpoint: Option<chain::transaction::OutPoint>,
684 /// Are anchors used for this channel. Boolean is serialization backwards-compatible
685 pub opt_anchors: Option<()>
688 /// Late-bound per-channel counterparty data used to build transactions.
690 pub struct CounterpartyChannelTransactionParameters {
691 /// Counter-party public keys
692 pub pubkeys: ChannelPublicKeys,
693 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
694 pub selected_contest_delay: u16,
697 impl ChannelTransactionParameters {
698 /// Whether the late bound parameters are populated.
699 pub fn is_populated(&self) -> bool {
700 self.counterparty_parameters.is_some() && self.funding_outpoint.is_some()
703 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
704 /// given that the holder is the broadcaster.
706 /// self.is_populated() must be true before calling this function.
707 pub fn as_holder_broadcastable(&self) -> DirectedChannelTransactionParameters {
708 assert!(self.is_populated(), "self.late_parameters must be set before using as_holder_broadcastable");
709 DirectedChannelTransactionParameters {
711 holder_is_broadcaster: true
715 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
716 /// given that the counterparty is the broadcaster.
718 /// self.is_populated() must be true before calling this function.
719 pub fn as_counterparty_broadcastable(&self) -> DirectedChannelTransactionParameters {
720 assert!(self.is_populated(), "self.late_parameters must be set before using as_counterparty_broadcastable");
721 DirectedChannelTransactionParameters {
723 holder_is_broadcaster: false
728 impl_writeable_tlv_based!(CounterpartyChannelTransactionParameters, {
729 (0, pubkeys, required),
730 (2, selected_contest_delay, required),
733 impl_writeable_tlv_based!(ChannelTransactionParameters, {
734 (0, holder_pubkeys, required),
735 (2, holder_selected_contest_delay, required),
736 (4, is_outbound_from_holder, required),
737 (6, counterparty_parameters, option),
738 (8, funding_outpoint, option),
739 (10, opt_anchors, option),
742 /// Static channel fields used to build transactions given per-commitment fields, organized by
743 /// broadcaster/countersignatory.
745 /// This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
746 /// as_holder_broadcastable and as_counterparty_broadcastable functions.
747 pub struct DirectedChannelTransactionParameters<'a> {
748 /// The holder's channel static parameters
749 inner: &'a ChannelTransactionParameters,
750 /// Whether the holder is the broadcaster
751 holder_is_broadcaster: bool,
754 impl<'a> DirectedChannelTransactionParameters<'a> {
755 /// Get the channel pubkeys for the broadcaster
756 pub fn broadcaster_pubkeys(&self) -> &ChannelPublicKeys {
757 if self.holder_is_broadcaster {
758 &self.inner.holder_pubkeys
760 &self.inner.counterparty_parameters.as_ref().unwrap().pubkeys
764 /// Get the channel pubkeys for the countersignatory
765 pub fn countersignatory_pubkeys(&self) -> &ChannelPublicKeys {
766 if self.holder_is_broadcaster {
767 &self.inner.counterparty_parameters.as_ref().unwrap().pubkeys
769 &self.inner.holder_pubkeys
773 /// Get the contest delay applicable to the transactions.
774 /// Note that the contest delay was selected by the countersignatory.
775 pub fn contest_delay(&self) -> u16 {
776 let counterparty_parameters = self.inner.counterparty_parameters.as_ref().unwrap();
777 if self.holder_is_broadcaster { counterparty_parameters.selected_contest_delay } else { self.inner.holder_selected_contest_delay }
780 /// Whether the channel is outbound from the broadcaster.
782 /// The boolean representing the side that initiated the channel is
783 /// an input to the commitment number obscure factor computation.
784 pub fn is_outbound(&self) -> bool {
785 if self.holder_is_broadcaster { self.inner.is_outbound_from_holder } else { !self.inner.is_outbound_from_holder }
788 /// The funding outpoint
789 pub fn funding_outpoint(&self) -> OutPoint {
790 self.inner.funding_outpoint.unwrap().into_bitcoin_outpoint()
793 /// Whether to use anchors for this channel
794 pub fn opt_anchors(&self) -> bool {
795 self.inner.opt_anchors.is_some()
799 /// Information needed to build and sign a holder's commitment transaction.
801 /// The transaction is only signed once we are ready to broadcast.
803 pub struct HolderCommitmentTransaction {
804 inner: CommitmentTransaction,
805 /// Our counterparty's signature for the transaction
806 pub counterparty_sig: Signature,
807 /// All non-dust counterparty HTLC signatures, in the order they appear in the transaction
808 pub counterparty_htlc_sigs: Vec<Signature>,
809 // Which order the signatures should go in when constructing the final commitment tx witness.
810 // The user should be able to reconstruct this themselves, so we don't bother to expose it.
811 holder_sig_first: bool,
814 impl Deref for HolderCommitmentTransaction {
815 type Target = CommitmentTransaction;
817 fn deref(&self) -> &Self::Target { &self.inner }
820 impl PartialEq for HolderCommitmentTransaction {
821 // We dont care whether we are signed in equality comparison
822 fn eq(&self, o: &Self) -> bool {
823 self.inner == o.inner
827 impl_writeable_tlv_based!(HolderCommitmentTransaction, {
828 (0, inner, required),
829 (2, counterparty_sig, required),
830 (4, holder_sig_first, required),
831 (6, counterparty_htlc_sigs, vec_type),
834 impl HolderCommitmentTransaction {
836 pub fn dummy() -> Self {
837 let secp_ctx = Secp256k1::new();
838 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
839 let dummy_sig = secp_ctx.sign(&secp256k1::Message::from_slice(&[42; 32]).unwrap(), &SecretKey::from_slice(&[42; 32]).unwrap());
841 let keys = TxCreationKeys {
842 per_commitment_point: dummy_key.clone(),
843 revocation_key: dummy_key.clone(),
844 broadcaster_htlc_key: dummy_key.clone(),
845 countersignatory_htlc_key: dummy_key.clone(),
846 broadcaster_delayed_payment_key: dummy_key.clone(),
848 let channel_pubkeys = ChannelPublicKeys {
849 funding_pubkey: dummy_key.clone(),
850 revocation_basepoint: dummy_key.clone(),
851 payment_point: dummy_key.clone(),
852 delayed_payment_basepoint: dummy_key.clone(),
853 htlc_basepoint: dummy_key.clone()
855 let channel_parameters = ChannelTransactionParameters {
856 holder_pubkeys: channel_pubkeys.clone(),
857 holder_selected_contest_delay: 0,
858 is_outbound_from_holder: false,
859 counterparty_parameters: Some(CounterpartyChannelTransactionParameters { pubkeys: channel_pubkeys.clone(), selected_contest_delay: 0 }),
860 funding_outpoint: Some(chain::transaction::OutPoint { txid: Default::default(), index: 0 }),
863 let mut htlcs_with_aux: Vec<(_, ())> = Vec::new();
864 let inner = CommitmentTransaction::new_with_auxiliary_htlc_data(0, 0, 0, false, dummy_key.clone(), dummy_key.clone(), keys, 0, &mut htlcs_with_aux, &channel_parameters.as_counterparty_broadcastable());
865 HolderCommitmentTransaction {
867 counterparty_sig: dummy_sig,
868 counterparty_htlc_sigs: Vec::new(),
869 holder_sig_first: false
873 /// Create a new holder transaction with the given counterparty signatures.
874 /// The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
875 pub fn new(commitment_tx: CommitmentTransaction, counterparty_sig: Signature, counterparty_htlc_sigs: Vec<Signature>, holder_funding_key: &PublicKey, counterparty_funding_key: &PublicKey) -> Self {
877 inner: commitment_tx,
879 counterparty_htlc_sigs,
880 holder_sig_first: holder_funding_key.serialize()[..] < counterparty_funding_key.serialize()[..],
884 pub(crate) fn add_holder_sig(&self, funding_redeemscript: &Script, holder_sig: Signature) -> Transaction {
885 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
886 let mut tx = self.inner.built.transaction.clone();
887 tx.input[0].witness.push(Vec::new());
889 if self.holder_sig_first {
890 tx.input[0].witness.push(holder_sig.serialize_der().to_vec());
891 tx.input[0].witness.push(self.counterparty_sig.serialize_der().to_vec());
893 tx.input[0].witness.push(self.counterparty_sig.serialize_der().to_vec());
894 tx.input[0].witness.push(holder_sig.serialize_der().to_vec());
896 tx.input[0].witness[1].push(SigHashType::All as u8);
897 tx.input[0].witness[2].push(SigHashType::All as u8);
899 tx.input[0].witness.push(funding_redeemscript.as_bytes().to_vec());
904 /// A pre-built Bitcoin commitment transaction and its txid.
906 pub struct BuiltCommitmentTransaction {
907 /// The commitment transaction
908 pub transaction: Transaction,
909 /// The txid for the commitment transaction.
911 /// This is provided as a performance optimization, instead of calling transaction.txid()
916 impl_writeable_tlv_based!(BuiltCommitmentTransaction, {
917 (0, transaction, required),
921 impl BuiltCommitmentTransaction {
922 /// Get the SIGHASH_ALL sighash value of the transaction.
924 /// This can be used to verify a signature.
925 pub fn get_sighash_all(&self, funding_redeemscript: &Script, channel_value_satoshis: u64) -> Message {
926 let sighash = &bip143::SigHashCache::new(&self.transaction).signature_hash(0, funding_redeemscript, channel_value_satoshis, SigHashType::All)[..];
927 hash_to_message!(sighash)
930 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
931 /// because we are about to broadcast a holder transaction.
932 pub fn sign<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
933 let sighash = self.get_sighash_all(funding_redeemscript, channel_value_satoshis);
934 secp_ctx.sign(&sighash, funding_key)
938 /// This class tracks the per-transaction information needed to build a closing transaction and will
939 /// actually build it and sign.
941 /// This class can be used inside a signer implementation to generate a signature given the relevant
943 pub struct ClosingTransaction {
944 to_holder_value_sat: u64,
945 to_counterparty_value_sat: u64,
946 to_holder_script: Script,
947 to_counterparty_script: Script,
951 impl ClosingTransaction {
952 /// Construct an object of the class
954 to_holder_value_sat: u64,
955 to_counterparty_value_sat: u64,
956 to_holder_script: Script,
957 to_counterparty_script: Script,
958 funding_outpoint: OutPoint,
960 let built = build_closing_transaction(
961 to_holder_value_sat, to_counterparty_value_sat,
962 to_holder_script.clone(), to_counterparty_script.clone(),
967 to_counterparty_value_sat,
969 to_counterparty_script,
974 /// Trust our pre-built transaction.
976 /// Applies a wrapper which allows access to the transaction.
978 /// This should only be used if you fully trust the builder of this object. It should not
979 /// be used by an external signer - instead use the verify function.
980 pub fn trust(&self) -> TrustedClosingTransaction {
981 TrustedClosingTransaction { inner: self }
984 /// Verify our pre-built transaction.
986 /// Applies a wrapper which allows access to the transaction.
988 /// An external validating signer must call this method before signing
989 /// or using the built transaction.
990 pub fn verify(&self, funding_outpoint: OutPoint) -> Result<TrustedClosingTransaction, ()> {
991 let built = build_closing_transaction(
992 self.to_holder_value_sat, self.to_counterparty_value_sat,
993 self.to_holder_script.clone(), self.to_counterparty_script.clone(),
996 if self.built != built {
999 Ok(TrustedClosingTransaction { inner: self })
1002 /// The value to be sent to the holder, or zero if the output will be omitted
1003 pub fn to_holder_value_sat(&self) -> u64 {
1004 self.to_holder_value_sat
1007 /// The value to be sent to the counterparty, or zero if the output will be omitted
1008 pub fn to_counterparty_value_sat(&self) -> u64 {
1009 self.to_counterparty_value_sat
1012 /// The destination of the holder's output
1013 pub fn to_holder_script(&self) -> &Script {
1014 &self.to_holder_script
1017 /// The destination of the counterparty's output
1018 pub fn to_counterparty_script(&self) -> &Script {
1019 &self.to_counterparty_script
1023 /// A wrapper on ClosingTransaction indicating that the built bitcoin
1024 /// transaction is trusted.
1026 /// See trust() and verify() functions on CommitmentTransaction.
1028 /// This structure implements Deref.
1029 pub struct TrustedClosingTransaction<'a> {
1030 inner: &'a ClosingTransaction,
1033 impl<'a> Deref for TrustedClosingTransaction<'a> {
1034 type Target = ClosingTransaction;
1036 fn deref(&self) -> &Self::Target { self.inner }
1039 impl<'a> TrustedClosingTransaction<'a> {
1040 /// The pre-built Bitcoin commitment transaction
1041 pub fn built_transaction(&self) -> &Transaction {
1045 /// Get the SIGHASH_ALL sighash value of the transaction.
1047 /// This can be used to verify a signature.
1048 pub fn get_sighash_all(&self, funding_redeemscript: &Script, channel_value_satoshis: u64) -> Message {
1049 let sighash = &bip143::SigHashCache::new(&self.inner.built).signature_hash(0, funding_redeemscript, channel_value_satoshis, SigHashType::All)[..];
1050 hash_to_message!(sighash)
1053 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
1054 /// because we are about to broadcast a holder transaction.
1055 pub fn sign<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
1056 let sighash = self.get_sighash_all(funding_redeemscript, channel_value_satoshis);
1057 secp_ctx.sign(&sighash, funding_key)
1061 /// This class tracks the per-transaction information needed to build a commitment transaction and will
1062 /// actually build it and sign. It is used for holder transactions that we sign only when needed
1063 /// and for transactions we sign for the counterparty.
1065 /// This class can be used inside a signer implementation to generate a signature given the relevant
1068 pub struct CommitmentTransaction {
1069 commitment_number: u64,
1070 to_broadcaster_value_sat: u64,
1071 to_countersignatory_value_sat: u64,
1072 feerate_per_kw: u32,
1073 htlcs: Vec<HTLCOutputInCommitment>,
1074 // A boolean that is serialization backwards-compatible
1075 opt_anchors: Option<()>,
1076 // A cache of the parties' pubkeys required to construct the transaction, see doc for trust()
1077 keys: TxCreationKeys,
1078 // For access to the pre-built transaction, see doc for trust()
1079 built: BuiltCommitmentTransaction,
1082 impl PartialEq for CommitmentTransaction {
1083 fn eq(&self, o: &Self) -> bool {
1084 let eq = self.commitment_number == o.commitment_number &&
1085 self.to_broadcaster_value_sat == o.to_broadcaster_value_sat &&
1086 self.to_countersignatory_value_sat == o.to_countersignatory_value_sat &&
1087 self.feerate_per_kw == o.feerate_per_kw &&
1088 self.htlcs == o.htlcs &&
1089 self.opt_anchors == o.opt_anchors &&
1090 self.keys == o.keys;
1092 debug_assert_eq!(self.built.transaction, o.built.transaction);
1093 debug_assert_eq!(self.built.txid, o.built.txid);
1099 impl_writeable_tlv_based!(CommitmentTransaction, {
1100 (0, commitment_number, required),
1101 (2, to_broadcaster_value_sat, required),
1102 (4, to_countersignatory_value_sat, required),
1103 (6, feerate_per_kw, required),
1104 (8, keys, required),
1105 (10, built, required),
1106 (12, htlcs, vec_type),
1107 (14, opt_anchors, option),
1110 impl CommitmentTransaction {
1111 /// Construct an object of the class while assigning transaction output indices to HTLCs.
1113 /// Populates HTLCOutputInCommitment.transaction_output_index in htlcs_with_aux.
1115 /// The generic T allows the caller to match the HTLC output index with auxiliary data.
1116 /// This auxiliary data is not stored in this object.
1118 /// Only include HTLCs that are above the dust limit for the channel.
1120 /// (C-not exported) due to the generic though we likely should expose a version without
1121 pub fn new_with_auxiliary_htlc_data<T>(commitment_number: u64, to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, opt_anchors: bool, broadcaster_funding_key: PublicKey, countersignatory_funding_key: PublicKey, keys: TxCreationKeys, feerate_per_kw: u32, htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>, channel_parameters: &DirectedChannelTransactionParameters) -> CommitmentTransaction {
1122 // Sort outputs and populate output indices while keeping track of the auxiliary data
1123 let (outputs, htlcs) = Self::internal_build_outputs(&keys, to_broadcaster_value_sat, to_countersignatory_value_sat, htlcs_with_aux, channel_parameters, opt_anchors, &broadcaster_funding_key, &countersignatory_funding_key).unwrap();
1125 let (obscured_commitment_transaction_number, txins) = Self::internal_build_inputs(commitment_number, channel_parameters);
1126 let transaction = Self::make_transaction(obscured_commitment_transaction_number, txins, outputs);
1127 let txid = transaction.txid();
1128 CommitmentTransaction {
1130 to_broadcaster_value_sat,
1131 to_countersignatory_value_sat,
1134 opt_anchors: if opt_anchors { Some(()) } else { None },
1136 built: BuiltCommitmentTransaction {
1143 fn internal_rebuild_transaction(&self, keys: &TxCreationKeys, channel_parameters: &DirectedChannelTransactionParameters, broadcaster_funding_key: &PublicKey, countersignatory_funding_key: &PublicKey) -> Result<BuiltCommitmentTransaction, ()> {
1144 let (obscured_commitment_transaction_number, txins) = Self::internal_build_inputs(self.commitment_number, channel_parameters);
1146 let mut htlcs_with_aux = self.htlcs.iter().map(|h| (h.clone(), ())).collect();
1147 let (outputs, _) = Self::internal_build_outputs(keys, self.to_broadcaster_value_sat, self.to_countersignatory_value_sat, &mut htlcs_with_aux, channel_parameters, self.opt_anchors.is_some(), broadcaster_funding_key, countersignatory_funding_key)?;
1149 let transaction = Self::make_transaction(obscured_commitment_transaction_number, txins, outputs);
1150 let txid = transaction.txid();
1151 let built_transaction = BuiltCommitmentTransaction {
1155 Ok(built_transaction)
1158 fn make_transaction(obscured_commitment_transaction_number: u64, txins: Vec<TxIn>, outputs: Vec<TxOut>) -> Transaction {
1161 lock_time: ((0x20 as u32) << 8 * 3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1167 // This is used in two cases:
1168 // - initial sorting of outputs / HTLCs in the constructor, in which case T is auxiliary data the
1169 // caller needs to have sorted together with the HTLCs so it can keep track of the output index
1170 // - building of a bitcoin transaction during a verify() call, in which case T is just ()
1171 fn internal_build_outputs<T>(keys: &TxCreationKeys, to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>, channel_parameters: &DirectedChannelTransactionParameters, opt_anchors: bool, broadcaster_funding_key: &PublicKey, countersignatory_funding_key: &PublicKey) -> Result<(Vec<TxOut>, Vec<HTLCOutputInCommitment>), ()> {
1172 let countersignatory_pubkeys = channel_parameters.countersignatory_pubkeys();
1173 let contest_delay = channel_parameters.contest_delay();
1175 let mut txouts: Vec<(TxOut, Option<&mut HTLCOutputInCommitment>)> = Vec::new();
1177 if to_countersignatory_value_sat > 0 {
1178 let script = if opt_anchors {
1179 get_to_countersignatory_with_anchors_redeemscript(&countersignatory_pubkeys.payment_point).to_v0_p2wsh()
1181 get_p2wpkh_redeemscript(&countersignatory_pubkeys.payment_point)
1185 script_pubkey: script.clone(),
1186 value: to_countersignatory_value_sat,
1192 if to_broadcaster_value_sat > 0 {
1193 let redeem_script = get_revokeable_redeemscript(
1194 &keys.revocation_key,
1196 &keys.broadcaster_delayed_payment_key,
1200 script_pubkey: redeem_script.to_v0_p2wsh(),
1201 value: to_broadcaster_value_sat,
1208 if to_broadcaster_value_sat > 0 || !htlcs_with_aux.is_empty() {
1209 let anchor_script = get_anchor_redeemscript(broadcaster_funding_key);
1212 script_pubkey: anchor_script.to_v0_p2wsh(),
1213 value: ANCHOR_OUTPUT_VALUE_SATOSHI,
1219 if to_countersignatory_value_sat > 0 || !htlcs_with_aux.is_empty() {
1220 let anchor_script = get_anchor_redeemscript(countersignatory_funding_key);
1223 script_pubkey: anchor_script.to_v0_p2wsh(),
1224 value: ANCHOR_OUTPUT_VALUE_SATOSHI,
1231 let mut htlcs = Vec::with_capacity(htlcs_with_aux.len());
1232 for (htlc, _) in htlcs_with_aux {
1233 let script = chan_utils::get_htlc_redeemscript(&htlc, opt_anchors, &keys);
1235 script_pubkey: script.to_v0_p2wsh(),
1236 value: htlc.amount_msat / 1000,
1238 txouts.push((txout, Some(htlc)));
1241 // Sort output in BIP-69 order (amount, scriptPubkey). Tie-breaks based on HTLC
1242 // CLTV expiration height.
1243 sort_outputs(&mut txouts, |a, b| {
1244 if let &Some(ref a_htlcout) = a {
1245 if let &Some(ref b_htlcout) = b {
1246 a_htlcout.cltv_expiry.cmp(&b_htlcout.cltv_expiry)
1247 // Note that due to hash collisions, we have to have a fallback comparison
1248 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1250 .then(a_htlcout.payment_hash.0.cmp(&b_htlcout.payment_hash.0))
1251 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1252 // close the channel due to mismatches - they're doing something dumb:
1253 } else { cmp::Ordering::Equal }
1254 } else { cmp::Ordering::Equal }
1257 let mut outputs = Vec::with_capacity(txouts.len());
1258 for (idx, out) in txouts.drain(..).enumerate() {
1259 if let Some(htlc) = out.1 {
1260 htlc.transaction_output_index = Some(idx as u32);
1261 htlcs.push(htlc.clone());
1263 outputs.push(out.0);
1265 Ok((outputs, htlcs))
1268 fn internal_build_inputs(commitment_number: u64, channel_parameters: &DirectedChannelTransactionParameters) -> (u64, Vec<TxIn>) {
1269 let broadcaster_pubkeys = channel_parameters.broadcaster_pubkeys();
1270 let countersignatory_pubkeys = channel_parameters.countersignatory_pubkeys();
1271 let commitment_transaction_number_obscure_factor = get_commitment_transaction_number_obscure_factor(
1272 &broadcaster_pubkeys.payment_point,
1273 &countersignatory_pubkeys.payment_point,
1274 channel_parameters.is_outbound(),
1277 let obscured_commitment_transaction_number =
1278 commitment_transaction_number_obscure_factor ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
1281 let mut ins: Vec<TxIn> = Vec::new();
1283 previous_output: channel_parameters.funding_outpoint(),
1284 script_sig: Script::new(),
1285 sequence: ((0x80 as u32) << 8 * 3)
1286 | ((obscured_commitment_transaction_number >> 3 * 8) as u32),
1287 witness: Vec::new(),
1291 (obscured_commitment_transaction_number, txins)
1294 /// The backwards-counting commitment number
1295 pub fn commitment_number(&self) -> u64 {
1296 self.commitment_number
1299 /// The value to be sent to the broadcaster
1300 pub fn to_broadcaster_value_sat(&self) -> u64 {
1301 self.to_broadcaster_value_sat
1304 /// The value to be sent to the counterparty
1305 pub fn to_countersignatory_value_sat(&self) -> u64 {
1306 self.to_countersignatory_value_sat
1309 /// The feerate paid per 1000-weight-unit in this commitment transaction.
1310 pub fn feerate_per_kw(&self) -> u32 {
1314 /// The non-dust HTLCs (direction, amt, height expiration, hash, transaction output index)
1315 /// which were included in this commitment transaction in output order.
1316 /// The transaction index is always populated.
1318 /// (C-not exported) as we cannot currently convert Vec references to/from C, though we should
1319 /// expose a less effecient version which creates a Vec of references in the future.
1320 pub fn htlcs(&self) -> &Vec<HTLCOutputInCommitment> {
1324 /// Trust our pre-built transaction and derived transaction creation public keys.
1326 /// Applies a wrapper which allows access to these fields.
1328 /// This should only be used if you fully trust the builder of this object. It should not
1329 /// be used by an external signer - instead use the verify function.
1330 pub fn trust(&self) -> TrustedCommitmentTransaction {
1331 TrustedCommitmentTransaction { inner: self }
1334 /// Verify our pre-built transaction and derived transaction creation public keys.
1336 /// Applies a wrapper which allows access to these fields.
1338 /// An external validating signer must call this method before signing
1339 /// or using the built transaction.
1340 pub fn verify<T: secp256k1::Signing + secp256k1::Verification>(&self, channel_parameters: &DirectedChannelTransactionParameters, broadcaster_keys: &ChannelPublicKeys, countersignatory_keys: &ChannelPublicKeys, secp_ctx: &Secp256k1<T>) -> Result<TrustedCommitmentTransaction, ()> {
1341 // This is the only field of the key cache that we trust
1342 let per_commitment_point = self.keys.per_commitment_point;
1343 let keys = TxCreationKeys::from_channel_static_keys(&per_commitment_point, broadcaster_keys, countersignatory_keys, secp_ctx).unwrap();
1344 if keys != self.keys {
1347 let tx = self.internal_rebuild_transaction(&keys, channel_parameters, &broadcaster_keys.funding_pubkey, &countersignatory_keys.funding_pubkey)?;
1348 if self.built.transaction != tx.transaction || self.built.txid != tx.txid {
1351 Ok(TrustedCommitmentTransaction { inner: self })
1355 /// A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1356 /// transaction and the transaction creation keys) are trusted.
1358 /// See trust() and verify() functions on CommitmentTransaction.
1360 /// This structure implements Deref.
1361 pub struct TrustedCommitmentTransaction<'a> {
1362 inner: &'a CommitmentTransaction,
1365 impl<'a> Deref for TrustedCommitmentTransaction<'a> {
1366 type Target = CommitmentTransaction;
1368 fn deref(&self) -> &Self::Target { self.inner }
1371 impl<'a> TrustedCommitmentTransaction<'a> {
1372 /// The transaction ID of the built Bitcoin transaction
1373 pub fn txid(&self) -> Txid {
1374 self.inner.built.txid
1377 /// The pre-built Bitcoin commitment transaction
1378 pub fn built_transaction(&self) -> &BuiltCommitmentTransaction {
1382 /// The pre-calculated transaction creation public keys.
1383 pub fn keys(&self) -> &TxCreationKeys {
1387 /// Should anchors be used.
1388 pub fn opt_anchors(&self) -> bool {
1389 self.opt_anchors.is_some()
1392 /// Get a signature for each HTLC which was included in the commitment transaction (ie for
1393 /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
1395 /// The returned Vec has one entry for each HTLC, and in the same order.
1396 pub fn get_htlc_sigs<T: secp256k1::Signing>(&self, htlc_base_key: &SecretKey, channel_parameters: &DirectedChannelTransactionParameters, secp_ctx: &Secp256k1<T>) -> Result<Vec<Signature>, ()> {
1397 let inner = self.inner;
1398 let keys = &inner.keys;
1399 let txid = inner.built.txid;
1400 let mut ret = Vec::with_capacity(inner.htlcs.len());
1401 let holder_htlc_key = derive_private_key(secp_ctx, &inner.keys.per_commitment_point, htlc_base_key).map_err(|_| ())?;
1403 for this_htlc in inner.htlcs.iter() {
1404 assert!(this_htlc.transaction_output_index.is_some());
1405 let htlc_tx = build_htlc_transaction(&txid, inner.feerate_per_kw, channel_parameters.contest_delay(), &this_htlc, self.opt_anchors(), &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
1407 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc, self.opt_anchors(), &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key);
1409 let sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, this_htlc.amount_msat / 1000, SigHashType::All)[..]);
1410 ret.push(secp_ctx.sign(&sighash, &holder_htlc_key));
1415 /// Gets a signed HTLC transaction given a preimage (for !htlc.offered) and the holder HTLC transaction signature.
1416 pub(crate) fn get_signed_htlc_tx(&self, channel_parameters: &DirectedChannelTransactionParameters, htlc_index: usize, counterparty_signature: &Signature, signature: &Signature, preimage: &Option<PaymentPreimage>) -> Transaction {
1417 let inner = self.inner;
1418 let keys = &inner.keys;
1419 let txid = inner.built.txid;
1420 let this_htlc = &inner.htlcs[htlc_index];
1421 assert!(this_htlc.transaction_output_index.is_some());
1422 // if we don't have preimage for an HTLC-Success, we can't generate an HTLC transaction.
1423 if !this_htlc.offered && preimage.is_none() { unreachable!(); }
1424 // Further, we should never be provided the preimage for an HTLC-Timeout transaction.
1425 if this_htlc.offered && preimage.is_some() { unreachable!(); }
1427 let mut htlc_tx = build_htlc_transaction(&txid, inner.feerate_per_kw, channel_parameters.contest_delay(), &this_htlc, self.opt_anchors(), &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
1429 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc, self.opt_anchors(), &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key);
1431 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
1432 htlc_tx.input[0].witness.push(Vec::new());
1434 htlc_tx.input[0].witness.push(counterparty_signature.serialize_der().to_vec());
1435 htlc_tx.input[0].witness.push(signature.serialize_der().to_vec());
1436 htlc_tx.input[0].witness[1].push(SigHashType::All as u8);
1437 htlc_tx.input[0].witness[2].push(SigHashType::All as u8);
1439 if this_htlc.offered {
1440 // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
1441 htlc_tx.input[0].witness.push(Vec::new());
1443 htlc_tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1446 htlc_tx.input[0].witness.push(htlc_redeemscript.as_bytes().to_vec());
1451 /// Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
1452 /// shared secret first. This prevents on-chain observers from discovering how many commitment
1453 /// transactions occurred in a channel before it was closed.
1455 /// This function gets the shared secret from relevant channel public keys and can be used to
1456 /// "decrypt" the commitment transaction number given a commitment transaction on-chain.
1457 pub fn get_commitment_transaction_number_obscure_factor(
1458 broadcaster_payment_basepoint: &PublicKey,
1459 countersignatory_payment_basepoint: &PublicKey,
1460 outbound_from_broadcaster: bool,
1462 let mut sha = Sha256::engine();
1464 if outbound_from_broadcaster {
1465 sha.input(&broadcaster_payment_basepoint.serialize());
1466 sha.input(&countersignatory_payment_basepoint.serialize());
1468 sha.input(&countersignatory_payment_basepoint.serialize());
1469 sha.input(&broadcaster_payment_basepoint.serialize());
1471 let res = Sha256::from_engine(sha).into_inner();
1473 ((res[26] as u64) << 5 * 8)
1474 | ((res[27] as u64) << 4 * 8)
1475 | ((res[28] as u64) << 3 * 8)
1476 | ((res[29] as u64) << 2 * 8)
1477 | ((res[30] as u64) << 1 * 8)
1478 | ((res[31] as u64) << 0 * 8)
1481 fn get_p2wpkh_redeemscript(key: &PublicKey) -> Script {
1482 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1483 .push_slice(&WPubkeyHash::hash(&key.serialize())[..])
1489 use super::CounterpartyCommitmentSecrets;
1492 use ln::chan_utils::{get_htlc_redeemscript, get_to_countersignatory_with_anchors_redeemscript, get_p2wpkh_redeemscript, CommitmentTransaction, TxCreationKeys, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, HTLCOutputInCommitment};
1493 use bitcoin::secp256k1::{PublicKey, SecretKey, Secp256k1};
1494 use util::test_utils;
1495 use chain::keysinterface::{KeysInterface, BaseSign};
1496 use bitcoin::Network;
1497 use ln::PaymentHash;
1498 use bitcoin::hashes::hex::ToHex;
1502 let secp_ctx = Secp256k1::new();
1504 let seed = [42; 32];
1505 let network = Network::Testnet;
1506 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
1507 let signer = keys_provider.get_channel_signer(false, 3000);
1508 let counterparty_signer = keys_provider.get_channel_signer(false, 3000);
1509 let delayed_payment_base = &signer.pubkeys().delayed_payment_basepoint;
1510 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
1511 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
1512 let htlc_basepoint = &signer.pubkeys().htlc_basepoint;
1513 let holder_pubkeys = signer.pubkeys();
1514 let counterparty_pubkeys = counterparty_signer.pubkeys();
1515 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
1516 let mut channel_parameters = ChannelTransactionParameters {
1517 holder_pubkeys: holder_pubkeys.clone(),
1518 holder_selected_contest_delay: 0,
1519 is_outbound_from_holder: false,
1520 counterparty_parameters: Some(CounterpartyChannelTransactionParameters { pubkeys: counterparty_pubkeys.clone(), selected_contest_delay: 0 }),
1521 funding_outpoint: Some(chain::transaction::OutPoint { txid: Default::default(), index: 0 }),
1525 let mut htlcs_with_aux: Vec<(_, ())> = Vec::new();
1527 // Generate broadcaster and counterparty outputs
1528 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1531 holder_pubkeys.funding_pubkey,
1532 counterparty_pubkeys.funding_pubkey,
1534 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1536 assert_eq!(tx.built.transaction.output.len(), 2);
1537 assert_eq!(tx.built.transaction.output[1].script_pubkey, get_p2wpkh_redeemscript(&counterparty_pubkeys.payment_point));
1539 // Generate broadcaster and counterparty outputs as well as two anchors
1540 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1543 holder_pubkeys.funding_pubkey,
1544 counterparty_pubkeys.funding_pubkey,
1546 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1548 assert_eq!(tx.built.transaction.output.len(), 4);
1549 assert_eq!(tx.built.transaction.output[3].script_pubkey, get_to_countersignatory_with_anchors_redeemscript(&counterparty_pubkeys.payment_point).to_v0_p2wsh());
1551 // Generate broadcaster output and anchor
1552 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1555 holder_pubkeys.funding_pubkey,
1556 counterparty_pubkeys.funding_pubkey,
1558 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1560 assert_eq!(tx.built.transaction.output.len(), 2);
1562 // Generate counterparty output and anchor
1563 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1566 holder_pubkeys.funding_pubkey,
1567 counterparty_pubkeys.funding_pubkey,
1569 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1571 assert_eq!(tx.built.transaction.output.len(), 2);
1573 let received_htlc = HTLCOutputInCommitment {
1575 amount_msat: 400000,
1577 payment_hash: PaymentHash([42; 32]),
1578 transaction_output_index: None,
1581 let offered_htlc = HTLCOutputInCommitment {
1583 amount_msat: 600000,
1585 payment_hash: PaymentHash([43; 32]),
1586 transaction_output_index: None,
1589 // Generate broadcaster output and received and offered HTLC outputs, w/o anchors
1590 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1593 holder_pubkeys.funding_pubkey,
1594 counterparty_pubkeys.funding_pubkey,
1596 &mut vec![(received_htlc.clone(), ()), (offered_htlc.clone(), ())],
1597 &channel_parameters.as_holder_broadcastable()
1599 assert_eq!(tx.built.transaction.output.len(), 3);
1600 assert_eq!(tx.built.transaction.output[0].script_pubkey, get_htlc_redeemscript(&received_htlc, false, &keys).to_v0_p2wsh());
1601 assert_eq!(tx.built.transaction.output[1].script_pubkey, get_htlc_redeemscript(&offered_htlc, false, &keys).to_v0_p2wsh());
1602 assert_eq!(get_htlc_redeemscript(&received_htlc, false, &keys).to_v0_p2wsh().to_hex(),
1603 "002085cf52e41ba7c099a39df504e7b61f6de122971ceb53b06731876eaeb85e8dc5");
1604 assert_eq!(get_htlc_redeemscript(&offered_htlc, false, &keys).to_v0_p2wsh().to_hex(),
1605 "002049f0736bb335c61a04d2623a24df878a7592a3c51fa7258d41b2c85318265e73");
1607 // Generate broadcaster output and received and offered HTLC outputs, with anchors
1608 channel_parameters.opt_anchors = Some(());
1609 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1612 holder_pubkeys.funding_pubkey,
1613 counterparty_pubkeys.funding_pubkey,
1615 &mut vec![(received_htlc.clone(), ()), (offered_htlc.clone(), ())],
1616 &channel_parameters.as_holder_broadcastable()
1618 assert_eq!(tx.built.transaction.output.len(), 5);
1619 assert_eq!(tx.built.transaction.output[2].script_pubkey, get_htlc_redeemscript(&received_htlc, true, &keys).to_v0_p2wsh());
1620 assert_eq!(tx.built.transaction.output[3].script_pubkey, get_htlc_redeemscript(&offered_htlc, true, &keys).to_v0_p2wsh());
1621 assert_eq!(get_htlc_redeemscript(&received_htlc, true, &keys).to_v0_p2wsh().to_hex(),
1622 "002067114123af3f95405bae4fd930fc95de03e3c86baaee8b2dd29b43dd26cf613c");
1623 assert_eq!(get_htlc_redeemscript(&offered_htlc, true, &keys).to_v0_p2wsh().to_hex(),
1624 "0020a06e3b0d4fcf704f2b9c41e16a70099e39989466c3142b8573a1154542f28f57");
1628 fn test_per_commitment_storage() {
1629 // Test vectors from BOLT 3:
1630 let mut secrets: Vec<[u8; 32]> = Vec::new();
1633 macro_rules! test_secrets {
1635 let mut idx = 281474976710655;
1636 for secret in secrets.iter() {
1637 assert_eq!(monitor.get_secret(idx).unwrap(), *secret);
1640 assert_eq!(monitor.get_min_seen_secret(), idx + 1);
1641 assert!(monitor.get_secret(idx).is_none());
1646 // insert_secret correct sequence
1647 monitor = CounterpartyCommitmentSecrets::new();
1650 secrets.push([0; 32]);
1651 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1652 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1655 secrets.push([0; 32]);
1656 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1657 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1660 secrets.push([0; 32]);
1661 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1662 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1665 secrets.push([0; 32]);
1666 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1667 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1670 secrets.push([0; 32]);
1671 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1672 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1675 secrets.push([0; 32]);
1676 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1677 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1680 secrets.push([0; 32]);
1681 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1682 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1685 secrets.push([0; 32]);
1686 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1687 monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).unwrap();
1692 // insert_secret #1 incorrect
1693 monitor = CounterpartyCommitmentSecrets::new();
1696 secrets.push([0; 32]);
1697 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1698 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1701 secrets.push([0; 32]);
1702 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1703 assert!(monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).is_err());
1707 // insert_secret #2 incorrect (#1 derived from incorrect)
1708 monitor = CounterpartyCommitmentSecrets::new();
1711 secrets.push([0; 32]);
1712 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1713 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1716 secrets.push([0; 32]);
1717 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
1718 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1721 secrets.push([0; 32]);
1722 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1723 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1726 secrets.push([0; 32]);
1727 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1728 assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
1732 // insert_secret #3 incorrect
1733 monitor = CounterpartyCommitmentSecrets::new();
1736 secrets.push([0; 32]);
1737 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1738 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1741 secrets.push([0; 32]);
1742 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1743 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1746 secrets.push([0; 32]);
1747 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
1748 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1751 secrets.push([0; 32]);
1752 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1753 assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
1757 // insert_secret #4 incorrect (1,2,3 derived from incorrect)
1758 monitor = CounterpartyCommitmentSecrets::new();
1761 secrets.push([0; 32]);
1762 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1763 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1766 secrets.push([0; 32]);
1767 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
1768 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1771 secrets.push([0; 32]);
1772 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
1773 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1776 secrets.push([0; 32]);
1777 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("ba65d7b0ef55a3ba300d4e87af29868f394f8f138d78a7011669c79b37b936f4").unwrap());
1778 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1781 secrets.push([0; 32]);
1782 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1783 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1786 secrets.push([0; 32]);
1787 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1788 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1791 secrets.push([0; 32]);
1792 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1793 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1796 secrets.push([0; 32]);
1797 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1798 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1802 // insert_secret #5 incorrect
1803 monitor = CounterpartyCommitmentSecrets::new();
1806 secrets.push([0; 32]);
1807 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1808 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1811 secrets.push([0; 32]);
1812 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1813 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1816 secrets.push([0; 32]);
1817 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1818 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1821 secrets.push([0; 32]);
1822 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1823 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1826 secrets.push([0; 32]);
1827 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
1828 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1831 secrets.push([0; 32]);
1832 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1833 assert!(monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).is_err());
1837 // insert_secret #6 incorrect (5 derived from incorrect)
1838 monitor = CounterpartyCommitmentSecrets::new();
1841 secrets.push([0; 32]);
1842 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1843 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1846 secrets.push([0; 32]);
1847 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1848 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1851 secrets.push([0; 32]);
1852 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1853 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1856 secrets.push([0; 32]);
1857 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1858 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1861 secrets.push([0; 32]);
1862 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
1863 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1866 secrets.push([0; 32]);
1867 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("b7e76a83668bde38b373970155c868a653304308f9896692f904a23731224bb1").unwrap());
1868 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1871 secrets.push([0; 32]);
1872 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1873 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1876 secrets.push([0; 32]);
1877 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1878 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1882 // insert_secret #7 incorrect
1883 monitor = CounterpartyCommitmentSecrets::new();
1886 secrets.push([0; 32]);
1887 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1888 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1891 secrets.push([0; 32]);
1892 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1893 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1896 secrets.push([0; 32]);
1897 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1898 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1901 secrets.push([0; 32]);
1902 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1903 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1906 secrets.push([0; 32]);
1907 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1908 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1911 secrets.push([0; 32]);
1912 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1913 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1916 secrets.push([0; 32]);
1917 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("e7971de736e01da8ed58b94c2fc216cb1dca9e326f3a96e7194fe8ea8af6c0a3").unwrap());
1918 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1921 secrets.push([0; 32]);
1922 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1923 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1927 // insert_secret #8 incorrect
1928 monitor = CounterpartyCommitmentSecrets::new();
1931 secrets.push([0; 32]);
1932 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1933 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1936 secrets.push([0; 32]);
1937 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1938 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1941 secrets.push([0; 32]);
1942 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1943 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1946 secrets.push([0; 32]);
1947 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1948 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1951 secrets.push([0; 32]);
1952 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1953 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1956 secrets.push([0; 32]);
1957 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1958 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1961 secrets.push([0; 32]);
1962 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1963 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1966 secrets.push([0; 32]);
1967 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a7efbc61aac46d34f77778bac22c8a20c6a46ca460addc49009bda875ec88fa4").unwrap());
1968 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());