Clean up and improve logs

.changelog/unreleased/improvements/ibc-relayer-cli/1538-clean-logs.md

@@ -0,0 +1,3 @@
+- Clean up the logs emitted by the relayer and add more
+  structured information to the messages recorded in the logs
+  ([#1538](https://github.com/informalsystems/ibc-rs/issues/1538))

modules/src/applications/transfer/acknowledgement.rs

@@ -1,4 +1,4 @@
-use core::fmt::{Display, Formatter};
+use core::fmt::{Display, Error as FmtError, Formatter};
 
 use serde::{Deserialize, Serialize};
 
@@ -51,7 +51,7 @@ impl AsRef<[u8]> for Acknowledgement {
 }
 
 impl Display for Acknowledgement {
-    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         match self {
             Acknowledgement::Success(_) => write!(f, "{}", ACK_SUCCESS_B64),
             Acknowledgement::Error(err_str) => write!(f, "{}", err_str),

modules/src/applications/transfer/denom.rs

@@ -1,4 +1,4 @@
-use core::fmt;
+use core::fmt::{Display, Error as FmtError, Formatter};
 use core::str::FromStr;
 
 use derive_more::{Display, From, Into};
@@ -50,8 +50,8 @@ impl TracePrefix {
     }
 }
 
-impl fmt::Display for TracePrefix {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for TracePrefix {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, "{}/{}", self.port_id, self.channel_id)
     }
 }
@@ -128,8 +128,8 @@ impl FromStr for TracePath {
     }
 }
 
-impl fmt::Display for TracePath {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for TracePath {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         let path = self
             .0
             .iter()
@@ -267,8 +267,8 @@ impl From<BaseDenom> for PrefixedDenom {
     }
 }
 
-impl fmt::Display for PrefixedDenom {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for PrefixedDenom {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         if self.trace_path.0.is_empty() {
             write!(f, "{}", self.base_denom)
         } else {
@@ -349,8 +349,8 @@ impl From<BaseCoin> for PrefixedCoin {
     }
 }
 
-impl fmt::Display for PrefixedCoin {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for PrefixedCoin {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, "{}-{}", self.amount, self.denom)
     }
 }

modules/src/clients/ics07_tendermint/header.rs

@@ -1,5 +1,6 @@
 use alloc::string::ToString;
 use core::cmp::Ordering;
+use core::fmt::{Display, Error as FmtError, Formatter};
 
 use bytes::Buf;
 use ibc_proto::google::protobuf::Any;
@@ -15,6 +16,7 @@ use crate::core::ics02_client::client_type::ClientType;
 use crate::core::ics02_client::error::Error as Ics02Error;
 use crate::core::ics24_host::identifier::ChainId;
 use crate::timestamp::Timestamp;
+use crate::utils::pretty::{PrettySignedHeader, PrettyValidatorSet};
 use crate::Height;
 
 pub const TENDERMINT_HEADER_TYPE_URL: &str = "/ibc.lightclients.tendermint.v1.Header";
@@ -30,11 +32,17 @@ pub struct Header {
 }
 
 impl core::fmt::Debug for Header {
-    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, " Header {{...}}")
     }
 }
 
+impl Display for Header {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(f, "Header {{ signed_header: {}, validator_set: {}, trusted_height: {}, trusted_validator_set: {} }}", PrettySignedHeader(&self.signed_header), PrettyValidatorSet(&self.validator_set), self.trusted_height, PrettyValidatorSet(&self.trusted_validator_set))
+    }
+}
+
 impl Header {
     pub fn height(&self) -> Height {
         Height::new(

modules/src/clients/ics07_tendermint/misbehaviour.rs

@@ -62,7 +62,7 @@ impl core::fmt::Display for Misbehaviour {
     fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
         write!(
             f,
-            "{:?} h1: {:?}-{:?} h2: {:?}-{:?}",
+            "{} h1: {}-{} h2: {}-{}",
             self.client_id,
             self.header1.height(),
             self.header1.trusted_height,

modules/src/core/ics02_client/client_type.rs

@@ -1,5 +1,5 @@
 use crate::prelude::*;
-use core::fmt;
+use core::fmt::{Display, Error as FmtError, Formatter};
 use serde_derive::{Deserialize, Serialize};
 
 use super::error::Error;
@@ -30,8 +30,8 @@ impl ClientType {
     }
 }
 
-impl fmt::Display for ClientType {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for ClientType {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, "ClientType({})", self.as_str())
     }
 }

modules/src/core/ics02_client/error.rs

@@ -209,7 +209,7 @@ define_error! {
                 latest_height: Height
             }
             | e | {
-                format!("received header height ({:?}) is lower than (or equal to) client latest height ({:?})",
+                format!("received header height ({}) is lower than (or equal to) client latest height ({})",
                     e.header_height, e.latest_height)
             },
 

modules/src/core/ics02_client/events.rs

@@ -1,5 +1,6 @@
 //! Types for the IBC events emitted from Tendermint Websocket by the client module.
 
+use core::fmt::{Display, Error as FmtError, Formatter};
 use serde_derive::{Deserialize, Serialize};
 use tendermint::abci::tag::Tag;
 use tendermint::abci::Event as AbciEvent;
@@ -42,6 +43,12 @@ impl NewBlock {
     }
 }
 
+impl Display for NewBlock {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(f, "NewBlock {{ height: {} }}", self.height)
+    }
+}
+
 impl From<NewBlock> for IbcEvent {
     fn from(v: NewBlock) -> Self {
         IbcEvent::NewBlock(v)
@@ -65,6 +72,16 @@ impl Default for Attributes {
     }
 }
 
+impl Display for Attributes {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(
+            f,
+            "Attributes {{ client_id: {}, client_type: {}, consensus_height: {} }}",
+            self.client_id, self.client_type, self.consensus_height
+        )
+    }
+}
+
 /// Convert attributes to Tendermint ABCI tags
 ///
 /// # Note
@@ -91,12 +108,6 @@ impl From<Attributes> for Vec<Tag> {
     }
 }
 
-impl core::fmt::Display for Attributes {
-    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
-        write!(f, "cs_h: {}({})", self.client_id, self.consensus_height)
-    }
-}
-
 /// CreateClient event signals the creation of a new on-chain client (IBC client).
 #[derive(Debug, Serialize, Clone, PartialEq, Eq)]
 pub struct CreateClient(pub Attributes);
@@ -107,6 +118,12 @@ impl CreateClient {
     }
 }
 
+impl Display for CreateClient {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(f, "CreateClient {{ {} }}", self.0)
+    }
+}
+
 impl From<Attributes> for CreateClient {
     fn from(attrs: Attributes) -> Self {
         CreateClient(attrs)
@@ -129,14 +146,8 @@ impl From<CreateClient> for AbciEvent {
     }
 }
 
-impl core::fmt::Display for CreateClient {
-    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
-        write!(f, "{}", self.0)
-    }
-}
-
 /// UpdateClient event signals a recent update of an on-chain client (IBC Client).
-#[derive(Serialize, Clone, PartialEq)]
+#[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct UpdateClient {
     pub common: Attributes,
     pub header: Option<Box<dyn Header>>,
@@ -156,6 +167,17 @@ impl UpdateClient {
     }
 }
 
+impl Display for UpdateClient {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        // TODO Display: Check for a solution for Box<dyn Header>
+        write!(
+            f,
+            "UpdateClient {{ common: {}, header: None }}",
+            self.common
+        )
+    }
+}
+
 impl From<Attributes> for UpdateClient {
     fn from(attrs: Attributes) -> Self {
         UpdateClient {
@@ -188,18 +210,6 @@ impl From<UpdateClient> for AbciEvent {
     }
 }
 
-impl core::fmt::Display for UpdateClient {
-    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
-        write!(f, "{}", self.common)
-    }
-}
-
-impl core::fmt::Debug for UpdateClient {
-    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
-        write!(f, "{}", self.common)
-    }
-}
-
 /// ClientMisbehaviour event signals the update of an on-chain client (IBC Client) with evidence of
 /// misbehaviour.
 #[derive(Debug, Serialize, Clone, PartialEq, Eq)]
@@ -211,6 +221,12 @@ impl ClientMisbehaviour {
     }
 }
 
+impl Display for ClientMisbehaviour {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(f, "ClientMisbehaviour {{ {} }}", self.0)
+    }
+}
+
 impl From<Attributes> for ClientMisbehaviour {
     fn from(attrs: Attributes) -> Self {
         ClientMisbehaviour(attrs)
@@ -243,6 +259,12 @@ impl UpgradeClient {
     }
 }
 
+impl Display for UpgradeClient {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
+        write!(f, "UpgradeClient {{ {} }}", self.0)
+    }
+}
+
 impl From<Attributes> for UpgradeClient {
     fn from(attrs: Attributes) -> Self {
         UpgradeClient(attrs)

modules/src/core/ics02_client/trust_threshold.rs

@@ -2,7 +2,10 @@
 //! represented as a fraction with valid values in the
 //! range `[0, 1)`.
 
-use core::{convert::TryFrom, fmt};
+use core::{
+    convert::TryFrom,
+    fmt::{Display, Error as FmtError, Formatter},
+};
 
 use ibc_proto::protobuf::Protobuf;
 use serde::{Deserialize, Serialize};
@@ -123,8 +126,8 @@ impl Default for TrustThreshold {
     }
 }
 
-impl fmt::Display for TrustThreshold {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for TrustThreshold {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, "{}/{}", self.numerator, self.denominator)
     }
 }

modules/src/core/ics03_connection/connection.rs

@@ -2,7 +2,10 @@ use crate::prelude::*;
 
 use core::str::FromStr;
 use core::time::Duration;
-use core::{fmt, u64};
+use core::{
+    fmt::{Display, Error as FmtError, Formatter},
+    u64,
+};
 
 use ibc_proto::protobuf::Protobuf;
 use serde::{Deserialize, Serialize};
@@ -366,8 +369,8 @@ impl State {
     }
 }
 
-impl fmt::Display for State {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+impl Display for State {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), FmtError> {
         write!(f, "{}", self.as_str())
     }
 }