+// This file is Copyright its original authors, visible in version control
+// history.
+//
+// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
+// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
+// 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 bitcoin_hashes::sha256d::Hash as Sha256dHash;
+use bitcoin::hash_types::Txid;
use bitcoin::blockdata::transaction::Transaction;
-use secp256k1::key::PublicKey;
+use bitcoin::secp256k1::key::PublicKey;
-use ln::router::Route;
+use routing::router::Route;
use ln::chan_utils::HTLCType;
-use std;
-
pub(crate) struct DebugPubKey<'a>(pub &'a PublicKey);
-impl<'a> std::fmt::Display for DebugPubKey<'a> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+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)?;
}
}
pub(crate) struct DebugBytes<'a>(pub &'a [u8]);
-impl<'a> std::fmt::Display for DebugBytes<'a> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+impl<'a> core::fmt::Display for DebugBytes<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
for i in self.0 {
write!(f, "{:02x}", i)?;
}
}
}
-pub(crate) struct DebugFundingChannelId<'a>(pub &'a Sha256dHash, pub u16);
-impl<'a> std::fmt::Display for DebugFundingChannelId<'a> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
- for i in OutPoint::new(self.0.clone(), self.1).to_channel_id().iter() {
+pub(crate) struct DebugFundingChannelId<'a>(pub &'a Txid, pub u16);
+impl<'a> core::fmt::Display for DebugFundingChannelId<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ for i in (OutPoint { txid: self.0.clone(), index: self.1 }).to_channel_id().iter() {
write!(f, "{:02x}", i)?;
}
Ok(())
}
}
-pub(crate) struct DebugFundingInfo<'a, T: 'a>(pub &'a Option<(OutPoint, T)>);
-impl<'a, T> std::fmt::Display for DebugFundingInfo<'a, T> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
- match self.0.as_ref() {
- Some(&(ref funding_output, _)) => DebugBytes(&funding_output.to_channel_id()[..]).fmt(f),
- None => write!(f, "without funding output set"),
- }
+pub(crate) struct DebugFundingInfo<'a, T: 'a>(pub &'a (OutPoint, T));
+impl<'a, T> core::fmt::Display for DebugFundingInfo<'a, T> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ DebugBytes(&(self.0).0.to_channel_id()[..]).fmt(f)
}
}
macro_rules! log_funding_info {
($key_storage: expr) => {
- match $key_storage {
- Storage::Local { ref funding_info, .. } => {
- ::util::macro_logger::DebugFundingInfo(&funding_info)
- },
- Storage::Watchtower { .. } => {
- ::util::macro_logger::DebugFundingInfo(&None)
- }
- }
+ ::util::macro_logger::DebugFundingInfo(&$key_storage.get_funding_txo())
}
}
pub(crate) struct DebugRoute<'a>(pub &'a Route);
-impl<'a> std::fmt::Display for DebugRoute<'a> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
- for h in self.0.hops.iter() {
- write!(f, "node_id: {}, short_channel_id: {}, fee_msat: {}, cltv_expiry_delta: {}\n", log_pubkey!(h.pubkey), h.short_channel_id, h.fee_msat, h.cltv_expiry_delta)?;
+impl<'a> core::fmt::Display for DebugRoute<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ for (idx, p) in self.0.paths.iter().enumerate() {
+ writeln!(f, "path {}:", idx)?;
+ for h in p.iter() {
+ writeln!(f, " node_id: {}, short_channel_id: {}, fee_msat: {}, cltv_expiry_delta: {}", log_pubkey!(h.pubkey), h.short_channel_id, h.fee_msat, h.cltv_expiry_delta)?;
+ }
}
Ok(())
}
}
pub(crate) struct DebugTx<'a>(pub &'a Transaction);
-impl<'a> std::fmt::Display for DebugTx<'a> {
- fn fmt(&self, f: &mut std::fmt::Formatter) -> Result<(), std::fmt::Error> {
+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 {
- write!(f, "commitment tx")?;
+ write!(f, "commitment tx ")?;
} else if self.0.input.len() == 1 && self.0.input[0].witness.last().unwrap().len() == 71 {
- write!(f, "closing tx")?;
+ 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 {
- write!(f, "HTLC-timeout tx")?;
+ 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 {
- write!(f, "HTLC-success tx")?;
+ write!(f, "HTLC-success tx ")?;
} else {
for inp in &self.0.input {
if !inp.witness.is_empty() {
else if HTLCType::scriptlen_to_htlctype(inp.witness.last().unwrap().len()) == Some(HTLCType::AcceptedHTLC) { write!(f, "timeout-")?; break }
}
}
- write!(f, "tx")?;
+ write!(f, "tx ")?;
}
} else {
- write!(f, "INVALID TRANSACTION")?;
+ debug_assert!(false, "We should never generate unknown transaction types");
+ write!(f, "unknown tx type ").unwrap();
}
+ write!(f, "with txid {}", self.0.txid())?;
Ok(())
}
}
}
}
+pub(crate) struct DebugSpendable<'a>(pub &'a SpendableOutputDescriptor);
+impl<'a> core::fmt::Display for DebugSpendable<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ match self.0 {
+ &SpendableOutputDescriptor::StaticOutput { ref outpoint, .. } => {
+ write!(f, "StaticOutput {}:{} marked for spending", outpoint.txid, outpoint.index)?;
+ }
+ &SpendableOutputDescriptor::DelayedPaymentOutput(ref descriptor) => {
+ write!(f, "DelayedPaymentOutput {}:{} marked for spending", descriptor.outpoint.txid, descriptor.outpoint.index)?;
+ }
+ &SpendableOutputDescriptor::StaticPaymentOutput(ref descriptor) => {
+ write!(f, "DynamicOutputP2WPKH {}:{} marked for spending", descriptor.outpoint.txid, descriptor.outpoint.index)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+macro_rules! log_spendable {
+ ($obj: expr) => {
+ ::util::macro_logger::DebugSpendable(&$obj)
+ }
+}
+
+/// Create a new Record and log it. You probably don't want to use this macro directly,
+/// but it needs to be exported so `log_trace` etc can use it in external crates.
+#[macro_export]
macro_rules! log_internal {
- ($self: ident, $lvl:expr, $($arg:tt)+) => (
- &$self.logger.log(&::util::logger::Record::new($lvl, format_args!($($arg)+), module_path!(), file!(), line!()));
+ ($logger: expr, $lvl:expr, $($arg:tt)+) => (
+ $logger.log(&$crate::util::logger::Record::new($lvl, format_args!($($arg)+), module_path!(), file!(), line!()));
+ );
+}
+
+/// Logs an entry at the given level.
+#[macro_export]
+macro_rules! log_given_level {
+ ($logger: expr, $lvl:expr, $($arg:tt)+) => (
+ match $lvl {
+ #[cfg(not(any(feature = "max_level_off")))]
+ $crate::util::logger::Level::Error => log_internal!($logger, $lvl, $($arg)*),
+ #[cfg(not(any(feature = "max_level_off", feature = "max_level_error")))]
+ $crate::util::logger::Level::Warn => log_internal!($logger, $lvl, $($arg)*),
+ #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn")))]
+ $crate::util::logger::Level::Info => log_internal!($logger, $lvl, $($arg)*),
+ #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info")))]
+ $crate::util::logger::Level::Debug => log_internal!($logger, $lvl, $($arg)*),
+ #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug")))]
+ $crate::util::logger::Level::Trace => log_internal!($logger, $lvl, $($arg)*),
+
+ #[cfg(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug"))]
+ _ => {
+ // The level is disabled at compile-time
+ },
+ }
);
}
+/// Log an error.
+#[macro_export]
macro_rules! log_error {
- ($self: ident, $($arg:tt)*) => (
- #[cfg(not(any(feature = "max_level_off")))]
- log_internal!($self, $crate::util::logger::Level::Error, $($arg)*);
+ ($logger: expr, $($arg:tt)*) => (
+ log_given_level!($logger, $crate::util::logger::Level::Error, $($arg)*);
)
}
macro_rules! log_warn {
- ($self: ident, $($arg:tt)*) => (
- #[cfg(not(any(feature = "max_level_off", feature = "max_level_error")))]
- log_internal!($self, $crate::util::logger::Level::Warn, $($arg)*);
+ ($logger: expr, $($arg:tt)*) => (
+ log_given_level!($logger, $crate::util::logger::Level::Warn, $($arg)*);
)
}
macro_rules! log_info {
- ($self: ident, $($arg:tt)*) => (
- #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn")))]
- log_internal!($self, $crate::util::logger::Level::Info, $($arg)*);
+ ($logger: expr, $($arg:tt)*) => (
+ log_given_level!($logger, $crate::util::logger::Level::Info, $($arg)*);
)
}
macro_rules! log_debug {
- ($self: ident, $($arg:tt)*) => (
- #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info")))]
- log_internal!($self, $crate::util::logger::Level::Debug, $($arg)*);
+ ($logger: expr, $($arg:tt)*) => (
+ log_given_level!($logger, $crate::util::logger::Level::Debug, $($arg)*);
)
}
+/// Log a trace log.
+#[macro_export]
macro_rules! log_trace {
- ($self: ident, $($arg:tt)*) => (
- #[cfg(not(any(feature = "max_level_off", feature = "max_level_error", feature = "max_level_warn", feature = "max_level_info", feature = "max_level_debug")))]
- log_internal!($self, $crate::util::logger::Level::Trace, $($arg)*);
+ ($logger: expr, $($arg:tt)*) => (
+ log_given_level!($logger, $crate::util::logger::Level::Trace, $($arg)*);
)
}
projects / rust-lightning / blobdiff