Skip to content

Commit b2252fb

Browse files
TheBlueMattTheBlueMatt
committed
log_trace information about commitment txn as they're being built
1 parent 8845d53 commit b2252fb

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

‎src/ln/channel.rs

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -783,6 +783,8 @@ impl Channel {
783783
let mut local_htlc_total_msat = 0;
784784
let mut value_to_self_msat_offset = 0;
785785

786+
log_trace!(self, "Building commitment transaction number {} for {}, generated by {} with fee {}...", commitment_number, if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
787+
786788
macro_rules! get_htlc_in_commitment {
787789
($htlc: expr, $offered: expr) => {
788790
HTLCOutputInCommitment {
@@ -796,44 +798,49 @@ impl Channel {
796798
}
797799

798800
macro_rules! add_htlc_output {
799-
($htlc: expr, $outbound: expr, $source: expr) => {
801+
($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
800802
if $outbound == local { // "offered HTLC output"
801803
let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
802804
if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
805+
log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
803806
txouts.push((TxOut {
804807
script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
805808
value: $htlc.amount_msat / 1000
806809
}, Some((htlc_in_tx, $source))));
807810
} else {
811+
log_trace!(self, " ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
808812
included_dust_htlcs.push((htlc_in_tx, $source));
809813
}
810814
} else {
811815
let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
812816
if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
817+
log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
813818
txouts.push((TxOut { // "received HTLC output"
814819
script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
815820
value: $htlc.amount_msat / 1000
816821
}, Some((htlc_in_tx, $source))));
817822
} else {
823+
log_trace!(self, " ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
818824
included_dust_htlcs.push((htlc_in_tx, $source));
819825
}
820826
}
821827
}
822828
}
823829

824830
for ref htlc in self.pending_inbound_htlcs.iter() {
825-
let include = match htlc.state {
826-
InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
827-
InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
828-
InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
829-
InboundHTLCState::Committed => true,
830-
InboundHTLCState::LocalRemoved(_) => !generated_by_local,
831+
let (include, state_name) = match htlc.state {
832+
InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
833+
InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
834+
InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
835+
InboundHTLCState::Committed => (true, "Committed"),
836+
InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
831837
};
832838

833839
if include {
834-
add_htlc_output!(htlc, false, None);
840+
add_htlc_output!(htlc, false, None, state_name);
835841
remote_htlc_total_msat += htlc.amount_msat;
836842
} else {
843+
log_trace!(self, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
837844
match &htlc.state {
838845
&InboundHTLCState::LocalRemoved(ref reason) => {
839846
if generated_by_local {
@@ -848,18 +855,19 @@ impl Channel {
848855
}
849856

850857
for ref htlc in self.pending_outbound_htlcs.iter() {
851-
let include = match htlc.state {
852-
OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
853-
OutboundHTLCState::Committed => true,
854-
OutboundHTLCState::RemoteRemoved => generated_by_local,
855-
OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
856-
OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
858+
let (include, state_name) = match htlc.state {
859+
OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
860+
OutboundHTLCState::Committed => (true, "Committed"),
861+
OutboundHTLCState::RemoteRemoved => (generated_by_local, "RemoteRemoved"),
862+
OutboundHTLCState::AwaitingRemoteRevokeToRemove => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
863+
OutboundHTLCState::AwaitingRemovedRemoteRevoke => (false, "AwaitingRemovedRemoteRevoke"),
857864
};
858865

859866
if include {
860-
add_htlc_output!(htlc, true, Some(&htlc.source));
867+
add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
861868
local_htlc_total_msat += htlc.amount_msat;
862869
} else {
870+
log_trace!(self, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
863871
match htlc.state {
864872
OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
865873
if htlc.fail_reason.is_none() {
@@ -1712,6 +1720,7 @@ impl Channel {
17121720
};
17131721
let local_commitment_txid = local_commitment_tx.0.txid();
17141722
let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1723+
log_trace!(self, "Checking commitment tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey.unwrap().serialize()), encode::serialize_hex(&local_commitment_tx.0), encode::serialize_hex(&funding_script));
17151724
secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
17161725

17171726
//If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
@@ -1737,6 +1746,7 @@ impl Channel {
17371746
if let Some(_) = htlc.transaction_output_index {
17381747
let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
17391748
let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1749+
log_trace!(self, "Checking HTLC tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript));
17401750
let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
17411751
secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
17421752
let htlc_sig = if htlc.offered {
@@ -3320,6 +3330,7 @@ impl Channel {
33203330
let remote_commitment_txid = remote_commitment_tx.0.txid();
33213331
let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
33223332
let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3333+
log_trace!(self, "Signing remote commitment tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&remote_commitment_tx.0), encode::serialize_hex(&funding_script), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize()), log_bytes!(our_sig.serialize_compact()[..]));
33233334

33243335
let mut htlc_sigs = Vec::with_capacity(remote_commitment_tx.1);
33253336
for &(ref htlc, _) in remote_commitment_tx.2.iter() {
@@ -3329,6 +3340,7 @@ impl Channel {
33293340
let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
33303341
let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
33313342
htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3343+
log_trace!(self, "Signing remote HTLC tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key).serialize()), log_bytes!(htlc_sigs.last().unwrap().serialize_compact()[..]));
33323344
}
33333345
}
33343346

0 commit comments

Comments
 (0)