Correct async `lightning-background-processor` exit check docs
[rust-lightning] / lightning / src / util / macro_logger.rs
index eadfdbdfc67aaeea13477dc7b5315df4f4ab42cd..8c2aba0c1c1cf87ac15ec95076a3a5cc05ea1330 100644 (file)
@@ -7,29 +7,21 @@
 // You may not use this file except in accordance with one or both of these
 // licenses.
 
-use chain::transaction::OutPoint;
-use chain::keysinterface::SpendableOutputDescriptor;
+use crate::chain::transaction::OutPoint;
+use crate::chain::keysinterface::SpendableOutputDescriptor;
 
 use bitcoin::hash_types::Txid;
 use bitcoin::blockdata::transaction::Transaction;
-use bitcoin::secp256k1::PublicKey;
 
-use routing::router::Route;
-use ln::chan_utils::HTLCType;
-use util::logger::DebugBytes;
+use crate::routing::router::Route;
+use crate::ln::chan_utils::HTLCClaim;
+use crate::util::logger::DebugBytes;
 
-pub(crate) struct DebugPubKey<'a>(pub &'a PublicKey);
-impl<'a> core::fmt::Display for DebugPubKey<'a> {
-       fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
-               for i in self.0.serialize().iter() {
-                       write!(f, "{:02x}", i)?;
-               }
-               Ok(())
-       }
-}
+/// Logs a pubkey in hex format.
+#[macro_export]
 macro_rules! log_pubkey {
        ($obj: expr) => {
-               ::util::macro_logger::DebugPubKey(&$obj)
+               $crate::util::logger::DebugPubKey(&$obj)
        }
 }
 
@@ -52,7 +44,7 @@ impl<'a> core::fmt::Display for DebugFundingChannelId<'a> {
 }
 macro_rules! log_funding_channel_id {
        ($funding_txid: expr, $funding_txo: expr) => {
-               ::util::macro_logger::DebugFundingChannelId(&$funding_txid, $funding_txo)
+               $crate::util::macro_logger::DebugFundingChannelId(&$funding_txid, $funding_txo)
        }
 }
 
@@ -64,7 +56,7 @@ impl<'a, T> core::fmt::Display for DebugFundingInfo<'a, T> {
 }
 macro_rules! log_funding_info {
        ($key_storage: expr) => {
-               ::util::macro_logger::DebugFundingInfo(&$key_storage.get_funding_txo())
+               $crate::util::macro_logger::DebugFundingInfo(&$key_storage.get_funding_txo())
        }
 }
 
@@ -82,7 +74,7 @@ impl<'a> core::fmt::Display for DebugRoute<'a> {
 }
 macro_rules! log_route {
        ($obj: expr) => {
-               ::util::macro_logger::DebugRoute(&$obj)
+               $crate::util::macro_logger::DebugRoute(&$obj)
        }
 }
 
@@ -90,25 +82,34 @@ pub(crate) struct DebugTx<'a>(pub &'a Transaction);
 impl<'a> core::fmt::Display for DebugTx<'a> {
        fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
                if self.0.input.len() >= 1 && self.0.input.iter().any(|i| !i.witness.is_empty()) {
-                       if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 71 &&
-                                       (self.0.input[0].sequence >> 8*3) as u8 == 0x80 {
+                       let first_input = &self.0.input[0];
+                       let witness_script_len = first_input.witness.last().unwrap_or(&[]).len();
+                       if self.0.input.len() == 1 && witness_script_len == 71 &&
+                                       (first_input.sequence.0 >> 8*3) as u8 == 0x80 {
                                write!(f, "commitment tx ")?;
-                       } else if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 71 {
+                       } else if self.0.input.len() == 1 && witness_script_len == 71 {
                                write!(f, "closing tx ")?;
-                       } else if self.0.input.len() == 1 && HTLCType::scriptlen_to_htlctype(self.0.input[0].witness.last().unwrap().len()) == Some(HTLCType::OfferedHTLC) &&
-                                       self.0.input[0].witness.len() == 5 {
+                       } else if self.0.input.len() == 1 && HTLCClaim::from_witness(&first_input.witness) == Some(HTLCClaim::OfferedTimeout) {
                                write!(f, "HTLC-timeout tx ")?;
-                       } else if self.0.input.len() == 1 && HTLCType::scriptlen_to_htlctype(self.0.input[0].witness.last().unwrap().len()) == Some(HTLCType::AcceptedHTLC) &&
-                                       self.0.input[0].witness.len() == 5 {
+                       } else if self.0.input.len() == 1 && HTLCClaim::from_witness(&first_input.witness) == Some(HTLCClaim::AcceptedPreimage) {
                                write!(f, "HTLC-success tx ")?;
                        } else {
+                               let mut num_preimage = 0;
+                               let mut num_timeout = 0;
+                               let mut num_revoked = 0;
                                for inp in &self.0.input {
-                                       if !inp.witness.is_empty() {
-                                               if HTLCType::scriptlen_to_htlctype(inp.witness.last().unwrap().len()) == Some(HTLCType::OfferedHTLC) { write!(f, "preimage-")?; break }
-                                               else if HTLCType::scriptlen_to_htlctype(inp.witness.last().unwrap().len()) == Some(HTLCType::AcceptedHTLC) { write!(f, "timeout-")?; break }
+                                       let htlc_claim = HTLCClaim::from_witness(&inp.witness);
+                                       match htlc_claim {
+                                               Some(HTLCClaim::AcceptedPreimage)|Some(HTLCClaim::OfferedPreimage) => num_preimage += 1,
+                                               Some(HTLCClaim::AcceptedTimeout)|Some(HTLCClaim::OfferedTimeout) => num_timeout += 1,
+                                               Some(HTLCClaim::Revocation) => num_revoked += 1,
+                                               None => continue,
                                        }
                                }
-                               write!(f, "tx ")?;
+                               if num_preimage > 0 || num_timeout > 0 || num_revoked > 0 {
+                                       write!(f, "HTLC claim tx ({} preimage, {} timeout, {} revoked)",
+                                               num_preimage, num_timeout, num_revoked)?;
+                               }
                        }
                } else {
                        debug_assert!(false, "We should never generate unknown transaction types");
@@ -121,7 +122,7 @@ impl<'a> core::fmt::Display for DebugTx<'a> {
 
 macro_rules! log_tx {
        ($obj: expr) => {
-               ::util::macro_logger::DebugTx(&$obj)
+               $crate::util::macro_logger::DebugTx(&$obj)
        }
 }
 
@@ -145,7 +146,7 @@ impl<'a> core::fmt::Display for DebugSpendable<'a> {
 
 macro_rules! log_spendable {
        ($obj: expr) => {
-               ::util::macro_logger::DebugSpendable(&$obj)
+               $crate::util::macro_logger::DebugSpendable(&$obj)
        }
 }
 
@@ -160,6 +161,7 @@ macro_rules! log_internal {
 }
 
 /// Logs an entry at the given level.
+#[doc(hidden)]
 #[macro_export]
 macro_rules! log_given_level {
        ($logger: expr, $lvl:expr, $($arg:tt)+) => (
@@ -185,7 +187,7 @@ macro_rules! log_given_level {
        );
 }
 
-/// Log an error.
+/// Log at the `ERROR` level.
 #[macro_export]
 macro_rules! log_error {
        ($logger: expr, $($arg:tt)*) => (
@@ -193,25 +195,31 @@ macro_rules! log_error {
        )
 }
 
+/// Log at the `WARN` level.
+#[macro_export]
 macro_rules! log_warn {
        ($logger: expr, $($arg:tt)*) => (
                log_given_level!($logger, $crate::util::logger::Level::Warn, $($arg)*);
        )
 }
 
+/// Log at the `INFO` level.
+#[macro_export]
 macro_rules! log_info {
        ($logger: expr, $($arg:tt)*) => (
                log_given_level!($logger, $crate::util::logger::Level::Info, $($arg)*);
        )
 }
 
+/// Log at the `DEBUG` level.
+#[macro_export]
 macro_rules! log_debug {
        ($logger: expr, $($arg:tt)*) => (
                log_given_level!($logger, $crate::util::logger::Level::Debug, $($arg)*);
        )
 }
 
-/// Log a trace log.
+/// Log at the `TRACE` level.
 #[macro_export]
 macro_rules! log_trace {
        ($logger: expr, $($arg:tt)*) => (
@@ -219,7 +227,8 @@ macro_rules! log_trace {
        )
 }
 
-/// Log a gossip log.
+/// Log at the `GOSSIP` level.
+#[macro_export]
 macro_rules! log_gossip {
        ($logger: expr, $($arg:tt)*) => (
                log_given_level!($logger, $crate::util::logger::Level::Gossip, $($arg)*);