From d584591ded1ea8d40a59c2e9d28169efa0c5603e Mon Sep 17 00:00:00 2001
From: Jacek Sieka <jacek@status.im>
Date: Sun, 6 Sep 2020 10:39:25 +0200
Subject: [PATCH] simplify libp2p logging (#1605)

and a few other small logging fixes
---
 beacon_chain/beacon_node_types.nim             | 2 +-
 beacon_chain/block_pools/block_pools_types.nim | 4 ++--
 beacon_chain/eth2_network.nim                  | 9 ++++-----
 beacon_chain/libp2p_json_serialization.nim     | 2 +-
 beacon_chain/libp2p_streams_backend.nim        | 2 +-
 beacon_chain/mainchain_monitor.nim             | 2 +-
 beacon_chain/sync_protocol.nim                 | 2 +-
 7 files changed, 11 insertions(+), 12 deletions(-)

diff --git a/beacon_chain/beacon_node_types.nim b/beacon_chain/beacon_node_types.nim
index 8f651790e..e82fc563e 100644
--- a/beacon_chain/beacon_node_types.nim
+++ b/beacon_chain/beacon_node_types.nim
@@ -90,4 +90,4 @@ type
   ValidatorPool* = object
     validators*: Table[ValidatorPubKey, AttachedValidator]
 
-proc shortLog*(v: AttachedValidator): string = shortLog(v.pubKey)
+func shortLog*(v: AttachedValidator): string = shortLog(v.pubKey)
diff --git a/beacon_chain/block_pools/block_pools_types.nim b/beacon_chain/block_pools/block_pools_types.nim
index 95c971d01..b01195f2b 100644
--- a/beacon_chain/block_pools/block_pools_types.nim
+++ b/beacon_chain/block_pools/block_pools_types.nim
@@ -197,13 +197,13 @@ type
 
 template validator_keys*(e: EpochRef): untyped = e.validator_key_store[1][]
 
-proc shortLog*(v: BlockSlot): string =
+func shortLog*(v: BlockSlot): string =
   if v.blck.slot == v.slot:
     &"{v.blck.root.data.toOpenArray(0, 3).toHex()}:{v.blck.slot}"
   else: # There was a gap - log it
     &"{v.blck.root.data.toOpenArray(0, 3).toHex()}:{v.blck.slot}@{v.slot}"
 
-proc shortLog*(v: BlockRef): string =
+func shortLog*(v: BlockRef): string =
   if v == nil:
     "BlockRef(nil)"
   else:
diff --git a/beacon_chain/eth2_network.nim b/beacon_chain/eth2_network.nim
index 0b6cf3f05..b63a10dd6 100644
--- a/beacon_chain/eth2_network.nim
+++ b/beacon_chain/eth2_network.nim
@@ -17,7 +17,7 @@ import
   libp2p/protocols/secure/[secure, secio],
   libp2p/protocols/pubsub/[pubsub, floodsub, gossipsub, rpc/message, rpc/messages],
   libp2p/transports/tcptransport,
-  libp2p/stream/lpstream,
+  libp2p/stream/connection,
   eth/[keys, async_utils], eth/p2p/p2p_protocol_dsl,
   eth/net/nat, eth/p2p/discoveryv5/[enr, node],
   # Beacon node modules
@@ -26,7 +26,7 @@ import
   peer_pool, spec/[datatypes, network], ./time
 
 export
-  version, multiaddress, peer_pool, peerinfo, p2pProtocol,
+  version, multiaddress, peer_pool, peerinfo, p2pProtocol, connection,
   libp2p_json_serialization, ssz_serialization, results
 
 logScope:
@@ -266,9 +266,8 @@ when libp2p_pki_schemes != "secp256k1":
 
 template libp2pProtocol*(name: string, version: int) {.pragma.}
 
-template `$`*(peer: Peer): string = id(peer.info)
-chronicles.formatIt(Peer): $it
-chronicles.formatIt(PeerID): $it
+func shortLog*(peer: Peer): string = shortLog(peer.info.peerId)
+chronicles.formatIt(Peer): shortLog(it)
 
 template remote*(peer: Peer): untyped =
   peer.info.peerId
diff --git a/beacon_chain/libp2p_json_serialization.nim b/beacon_chain/libp2p_json_serialization.nim
index d6199451d..2336a872a 100644
--- a/beacon_chain/libp2p_json_serialization.nim
+++ b/beacon_chain/libp2p_json_serialization.nim
@@ -2,7 +2,7 @@ import libp2p/daemon/daemonapi, json_serialization
 export json_serialization
 
 proc writeValue*(writer: var JsonWriter, value: PeerID) {.inline.} =
-  writer.writeValue value.pretty
+  writer.writeValue $value
 
 proc readValue*(reader: var JsonReader, value: var PeerID) {.inline.} =
   let res = PeerID.init reader.readValue(string)
diff --git a/beacon_chain/libp2p_streams_backend.nim b/beacon_chain/libp2p_streams_backend.nim
index e3a8a374e..e1d37adeb 100644
--- a/beacon_chain/libp2p_streams_backend.nim
+++ b/beacon_chain/libp2p_streams_backend.nim
@@ -121,7 +121,7 @@ proc readChunkPayload(conn: Connection, peer: Peer,
                               uint64(10 + size))
     return ok SSZ.decode(data.get(), MsgType)
   else:
-    debug "Snappy decompression/read failed", msg = $data.error, conn = $conn
+    debug "Snappy decompression/read failed", msg = $data.error, conn
     return neterr InvalidSnappyBytes
 
 proc readResponseChunk(conn: Connection, peer: Peer,
diff --git a/beacon_chain/mainchain_monitor.nim b/beacon_chain/mainchain_monitor.nim
index 10e4cbf4b..f799fe3d1 100644
--- a/beacon_chain/mainchain_monitor.nim
+++ b/beacon_chain/mainchain_monitor.nim
@@ -125,7 +125,7 @@ func asEth2Digest*(x: BlockHash): Eth2Digest =
 template asBlockHash(x: Eth2Digest): BlockHash =
   BlockHash(x.data)
 
-func shortLog(b: Eth1Block): string =
+func shortLog*(b: Eth1Block): string =
   &"{b.number}:{shortLog b.voteData.block_hash}"
 
 func getDepositsInRange(eth1Chain: Eth1Chain,
diff --git a/beacon_chain/sync_protocol.nim b/beacon_chain/sync_protocol.nim
index a0acbd52e..d16ed6340 100644
--- a/beacon_chain/sync_protocol.nim
+++ b/beacon_chain/sync_protocol.nim
@@ -45,7 +45,7 @@ type
 
   BlockRootsList* = List[Eth2Digest, Limit MAX_REQUEST_BLOCKS]
 
-proc shortLog*(s: StatusMsg): auto =
+func shortLog*(s: StatusMsg): auto =
   (
     forkDigest: s.forkDigest,
     finalizedRoot: shortLog(s.finalizedRoot),