Logging cleanups (#3643)

Remove unnecessary logging intermediate include and make sure the right
serializers are available

Author: arnetheduck

execution_chain/beacon/api_handler/api_forkchoice.nim

@@ -11,8 +11,8 @@ import
   std/[typetraits],
   results,
   chronos,
-  eth/common/[headers, hashes, times],
-  web3/execution_types,
+  eth/common/[eth_types_json_serialization, headers, hashes, times],
+  web3/[conversions, execution_types],
   json_rpc/errors,
   chronicles,
   ../../core/tx_pool,

execution_chain/common/chain_config.nim

@@ -15,7 +15,8 @@ import
   eth/common/eth_types_rlp,
   stint, stew/[byteutils],
   json_serialization, chronicles,
-  json_serialization/stew/results,
+  json_serialization/pkg/results,
+  json_serialization/std/tables,
   json_serialization/lexer,
   ./[genesis_alloc, hardforks]
 
@@ -674,3 +675,29 @@ func `==`*(a, b: ChainConfig): bool =
   if a.isNil and not b.isNil: return false
   if not a.isNil and b.isNil: return false
   a[] == b[]
+
+template toLog(it: Genesis): auto =
+  # Avoid logging entire genesis allocation table
+  (
+    nonce: it.nonce,
+    timestamp: it.timestamp,
+    extraData: it.extraData,
+    gasLimit: it.gasLimit,
+    difficulty: it.difficulty,
+    mixHash: it.mixHash,
+    coinbase: it.coinbase,
+    alloc: it.alloc.len,
+    number: it.number,
+    gasUser: it.gasUser,
+    parentHash: it.parentHash,
+    baseFeePerGas: it.baseFeePerGas,
+    blobGasUsed: it.blobGasUsed,
+    excessBlobGas: it.excessBlobGas,
+    parentBeaconBlockRoot: it.parentBeaconBlockRoot,
+  )
+
+# TODO formatIt doesn't work for nested Json objects
+chronicles.formatIt(Genesis):
+  toLog(it)
+proc writeValue*(w: var JsonWriter, value: Genesis) {.raises: [IOError].} =
+  w.writeValue(toLog(value))

execution_chain/common/common.nim

@@ -11,7 +11,7 @@
 
 import
   chronicles,
-  logging,
+  eth/common/eth_types_json_serialization,
   ../db/[core_db, ledger, storage_types, fcu_db],
   ../utils/[utils],
   ".."/[constants, errors, version_info],
@@ -23,12 +23,12 @@ export
   core_db,
   constants,
   errors,
+  eth_types_json_serialization,
   evmforks,
-  hardforks,
   genesis,
-  utils,
+  hardforks,
   taskpools,
-  logging
+  utils
 
 type
   HeaderChainUpdateCB* = proc(hdr: Header; fin: Hash32) {.gcsafe, raises: [].}

execution_chain/common/logging.nim

@@ -23,6 +23,7 @@ import
     confutils/defs,
     confutils/std/net as confnet,
     confutils/toml/defs as tomldefs,
+    confutils/json/defs as jsdefs,
     json_serialization/std/net as jsnet,
     toml_serialization/std/net as tomlnet,
     results,
@@ -36,7 +37,8 @@ import
   ./common/chain_config,
   ./db/opts
 
-export net, defs, jsnet, nimbus_binary_common
+export net, defs, jsdefs, jsnet, nimbus_binary_common
+
 const
 
   # e.g.:

execution_chain/config.nim

@@ -12,9 +12,10 @@
 import
   std/[uri, strutils, net],
   pkg/chronicles,
-  eth/common/keys
+  eth/common/keys,
+  json_serialization/writer
 
-export keys
+export keys, writeValue
 
 type
   ENodeError* = enum
@@ -34,7 +35,10 @@ type
     tcpPort*: Port        ## TCP port number
 
   ENode* = object
-    ## ENode object
+    ## ENode is a legacy URL-style identifier for Ethereum node that supports
+    ## a pubkey, IP address/port and an optional discovery port - it has mostly
+    ## been superseded by ENR.
+    ## https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enode
     pubkey*: PublicKey    ## Node public key
     address*: Address     ## Node address
 
@@ -134,5 +138,8 @@ proc `$`*(a: Address): string =
   result.add(":" & $a.udpPort)
   result.add(":" & $a.tcpPort)
 
-chronicles.formatIt(Address): $it
-chronicles.formatIt(ENode): $it
+proc writeValue*(w: var JsonWriter, a: Address) {.raises: [IOError].} =
+  w.writeValue $a
+
+proc writeValue*(w: var JsonWriter, a: ENode) {.raises: [IOError].} =
+  w.writeValue $a

execution_chain/networking/discoveryv4/enode.nim

@@ -14,7 +14,7 @@ import
   eth/common/keys, eth/p2p/discoveryv5/random2,
   ./enode
 
-export sets # TODO: This should not be needed, but compilation fails otherwise
+export enode, sets
 
 declareGauge discv4_routing_table_nodes,
   "Discovery v4 routing table nodes"

execution_chain/networking/discoveryv4/kademlia.nim

@@ -12,6 +12,7 @@
 import
   std/sequtils,
   chronos,
+  chronicles/formats as chronicles,
   results,
   ./p2p_enums,
   ./p2p_protocols,
@@ -80,6 +81,9 @@ func id*(peer: PeerRef): NodeId =
 func `$`*(peer: PeerRef): string =
   $peer.remote
 
+chronicles.formatIt(PeerRef):
+  $it
+
 func `$`*(x: DisconnectPeer): string =
   if x.isNil: "DisconnectPeer(nil)"
   else: "DisconnectPeer(cb)"

execution_chain/networking/p2p_peers.nim

@@ -15,11 +15,12 @@ import
   ./rlpx/rlpxtransport,
   ./discoveryv4/[enode, kademlia],
   ./p2p_peers,
-  ./peer_pool
+  ./peer_pool,
+  json_serialization/std/net as jsnet
 
 export
   base.NetworkId, rlpxtransport, kademlia,
-  p2p_peers
+  p2p_peers, jsnet
 
 type
   Peer* = PeerRef[EthereumNode]

execution_chain/networking/p2p_types.nim

@@ -18,7 +18,6 @@ import
   ./broadcast,
   ./trace_config,
   ../../utils/utils,
-  ../../common/logging,
   ../../core/pooled_txs_rlp,
   ../../networking/p2p_types