chore(protobuf): cosmetics (#2682)

vladopajic · web-flow · commit 76d50e11a949 · 2026-06-25T17:52:44.000-04:00
diff --git a/libp2p/extended_peer_record.nim b/libp2p/extended_peer_record.nim
@@ -32,7 +32,7 @@ type
     addresses* {.fieldNumber: 3.}: seq[AddressInfo]
     services* {.fieldNumber: 4.}: seq[ServiceInfo]
 
-Protobuf.serializerFor([ServiceInfo, ExtendedPeerRecord])
+Protobuf.serializerFor([ExtendedPeerRecord])
 
 proc init*(
     T: typedesc[ExtendedPeerRecord],
diff --git a/libp2p/protocols/connectivity/autonat/types.nim b/libp2p/protocols/connectivity/autonat/types.nim
@@ -60,5 +60,4 @@ type
 proc isReachable*(self: NetworkReachability): bool =
   self == NetworkReachability.Reachable
 
-Protobuf.serializerFor([AutonatPeerInfo, AutonatDial, AutonatDialResponse])
 Protobuf.serializerFor([AutonatMsg], withMetrics = true, domain = "autonat-v1")
diff --git a/libp2p/protocols/connectivity/autonatv2/types.nim b/libp2p/protocols/connectivity/autonatv2/types.nim
@@ -102,12 +102,7 @@ type
   AutonatV2Msg* {.proto3.} = object
     oneof* {.oneof.}: AutonatV2MsgOneof
 
-Protobuf.serializerFor(
-  [
-    DialRequest, DialResponse, DialBack, DialBackResponse, DialDataRequest,
-    DialDataResponse,
-  ]
-)
+Protobuf.serializerFor([DialBack, DialBackResponse])
 Protobuf.serializerFor([AutonatV2Msg], withMetrics = true, domain = "autonat-v2")
 
 # Custom `==` is needed to ensure consistent comparison with Opt-based fields
diff --git a/libp2p/protocols/connectivity/relay/messages.nim b/libp2p/protocols/connectivity/relay/messages.nim
@@ -49,7 +49,6 @@ type
     dstPeer* {.fieldNumber: 3.}: Opt[RelayPeer]
     status* {.fieldNumber: 4, ext.}: Opt[StatusV1]
 
-Protobuf.serializerFor([RelayPeer])
 Protobuf.serializerFor([RelayMessage], withMetrics = true, domain = "relay-v1")
 
 # Circuit Relay V2 Messages
@@ -106,7 +105,7 @@ type
     limit* {.fieldNumber: 3.}: Opt[Limit]
     status* {.fieldNumber: 4, ext.}: Opt[StatusV2]
 
-Protobuf.serializerFor([Peer, Reservation, Limit, Voucher])
+Protobuf.serializerFor([Voucher])
 Protobuf.serializerFor(
   [StopMessage, HopMessage], withMetrics = true, domain = "relay-v2"
 )
diff --git a/libp2p/protocols/identify.nim b/libp2p/protocols/identify.nim
@@ -75,7 +75,6 @@ type
   IdentifyPush* = ref object of LPProtocol
     identifyHandler: IdentifyPushHandler
 
-Protobuf.serializerFor([Delta])
 Protobuf.serializerFor([IdentifyMsg], withMetrics = true, domain = "identify")
 
 chronicles.expandIt(IdentifyMsg):
diff --git a/libp2p/protocols/kademlia/protobuf.nim b/libp2p/protocols/kademlia/protobuf.nim
@@ -100,7 +100,7 @@ proc hash*(peer: Peer): Hash =
 proc `==`*(a, b: Peer): bool =
   a.id == b.id
 
-Protobuf.serializerFor([Record, Ticket, RegisterMessage, GetAdsMessage])
+Protobuf.serializerFor([Record])
 
 # Peer and Message have custom encode because of additional hideConnectionStatus parameter
 Protobuf.decodeFor([Peer])
diff --git a/libp2p/protocols/pubsub/rpc/protobuf.nim b/libp2p/protocols/pubsub/rpc/protobuf.nim
@@ -8,14 +8,6 @@ import ../../../utils/[protobuf]
 import ../../../[peerid]
 import messages
 
-Protobuf.serializerFor(
-  [
-    PeerInfoMsg, SubOpts, ControlGraft, ControlIHave, ControlIWant, ControlPrune,
-    ControlExtensions, ControlMessage, Preamble, IMReceiving, TestExtensionRPC,
-    PartialMessageExtensionRPC, PingPongExtensionRPC, PreambleExtensionRPC,
-  ]
-)
-
 proc encode*(msg: Message, anonymize: bool): seq[byte] =
   encode(Protobuf, msg.anonymize(anonymize))
 
diff --git a/libp2p/protocols/rendezvous/protobuf.nim b/libp2p/protocols/rendezvous/protobuf.nim
@@ -71,5 +71,4 @@ type
 Protobuf.serializerFor(
   [Cookie, Register, RegisterResponse, Unregister, Discover, DiscoverResponse]
 )
-
 Protobuf.serializerFor([Message], withMetrics = true, domain = "rendezvous")
diff --git a/libp2p/routing_record.nim b/libp2p/routing_record.nim
@@ -22,7 +22,7 @@ type
     seqNo* {.fieldNumber: 2, required, pint.}: uint64
     addresses* {.fieldNumber: 3.}: seq[AddressInfo]
 
-Protobuf.serializerFor([AddressInfo, PeerRecord])
+Protobuf.serializerFor([PeerRecord])
 
 proc init*(
     T: typedesc[PeerRecord],
diff --git a/tests/libp2p/discovery/test_rendezvous_protobuf.nim b/tests/libp2p/discovery/test_rendezvous_protobuf.nim
diff --git a/tests/libp2p/kademlia/test_encoding.nim b/tests/libp2p/kademlia/test_encoding.nim
@@ -2,26 +2,16 @@
 # Copyright (c) Status Research & Development GmbH
 {.used.}
 
-import nimcrypto, results
+import results
 import
   ../../../libp2p/
     [multiaddress, peerid, protocols/kademlia, protocols/kademlia/protobuf]
 import ../../tools/unittest
 import ./utils
 
-template checkEncodeDecode(obj: untyped) =
-  check obj == decode(typeof(obj), obj.encode()).get()
-
 suite "KadDHT Protobuffers":
-  test "encode/decode":
+  test "Message encode/decode":
     let maddrs = @[MultiAddress.init("/ip4/127.0.0.1/tcp/9000").get()]
-    checkEncodeDecode(
-      Record(
-        key: @[1'u8, 2, 3],
-        value: @[4'u8, 5, 6],
-        timeReceived: Opt.some("2025-05-12T12:00:00Z"),
-      )
-    )
     # encode with hideConnectionStatus=false to preserve connection type for round-trip check
     let peer =
       Peer(id: @[1'u8, 2, 3], addrs: maddrs, connection: ConnectionStatus.connected)
@@ -36,14 +26,14 @@ suite "KadDHT Protobuffers":
     )
     check msg == Message.decode(msg.encode(hideConnectionStatus = false)).get()
 
-  test "peer with empty addr list and no connection":
+  test "Peer with empty addr list and no connection":
     let peer = Peer(id: @[0x42'u8], addrs: @[], connection: Opt.none(ConnectionStatus))
     let encoded = peer.encode()
     let decoded = Peer.decode(encoded).get()
     check:
       decoded == peer
 
-  test "peer with multiple multiaddresses":
+  test "Peer with multiple multiaddresses":
     let maddrs = @[
       MultiAddress.init("/ip4/127.0.0.1/tcp/9000").get(),
       MultiAddress.init("/ip4/192.168.1.1/tcp/4001").get(),
@@ -57,7 +47,7 @@ suite "KadDHT Protobuffers":
       decoded == peer
       decoded.addrs == maddrs
 
-  test "message with empty closer/provider peers":
+  test "Message with empty closer/provider peers":
     let msg = Message(
       msgType: MessageType.ping,
       key: @[7'u8],
@@ -70,21 +60,21 @@ suite "KadDHT Protobuffers":
     check:
       decoded == msg
 
-  test "encode peer with hideConnectionStatus=true always emits notConnected":
+  test "Peer encode with hideConnectionStatus=true always emits notConnected":
     let maddrs = @[MultiAddress.init("/ip4/127.0.0.1/tcp/9000").get()]
     for ct in [connected, canConnect, cannotConnect, notConnected]:
       let peer = Peer(id: @[1'u8, 2, 3], addrs: maddrs, connection: ct)
       let decoded = Peer.decode(peer.encode(hideConnectionStatus = true)).get()
       check decoded.connection == Opt.none(ConnectionStatus)
 
-  test "encode peer with hideConnectionStatus=false preserves actual connection type":
+  test "Peer encode with hideConnectionStatus=false preserves actual connection type":
     let maddrs = @[MultiAddress.init("/ip4/127.0.0.1/tcp/9000").get()]
     for ct in [connected, canConnect, cannotConnect, notConnected]:
       let peer = Peer(id: @[1'u8, 2, 3], addrs: maddrs, connection: ct)
       let decoded = Peer.decode(peer.encode(hideConnectionStatus = false)).get()
       check decoded.connection == ct
 
-  test "encode message with hideConnectionStatus=true hides connection in both peer lists":
+  test "Message encode with hideConnectionStatus=true hides connection in both peer lists":
     let maddrs = @[MultiAddress.init("/ip4/127.0.0.1/tcp/9000").get()]
     let msg = Message(
       msgType: MessageType.findNode,
diff --git a/tests/libp2p/protocols/test_autonat_v2.nim b/tests/libp2p/protocols/test_autonat_v2.nim
@@ -45,98 +45,10 @@ proc checkedGetIPAddress(): string =
   except Exception:
     ""
 
-proc checkEncodeDecode[T](msg: T) =
-  # this would be equivalent of doing the following (e.g. for DialBack)
-  # check msg == DialBack.decode(msg.encode()).get()
-  check msg == T.decode(msg.encode()).get()
-
 suite "AutonatV2":
   teardown:
     checkTrackers()
 
-  asyncTest "encode/decode messages":
-    # DialRequest
-    checkEncodeDecode(
-      DialRequest(
-        addrs: @[
-          MultiAddress.init("/ip4/127.0.0.1/tcp/4040").get(),
-          MultiAddress.init("/ip4/127.0.0.1/tcp/4041").get(),
-        ],
-        nonce: 42.uint64,
-      )
-    )
-
-    # DialResponse
-    checkEncodeDecode(
-      DialResponse(
-        status: ResponseStatus.Ok,
-        addrIdx: Opt.some(1.uint32),
-        dialStatus: Opt.some(DialStatus.Ok),
-      )
-    )
-
-    # DialDataRequest
-    checkEncodeDecode(DialDataRequest(addrIdx: 42.AddrIdx, numBytes: 128.uint64))
-
-    # DialDataResponse
-    checkEncodeDecode(DialDataResponse(data: @[1'u8, 2, 3, 4, 5]))
-
-    # AutonatV2Msg - DialRequest
-    checkEncodeDecode(
-      AutonatV2Msg(
-        oneof: AutonatV2MsgOneof(
-          kind: MsgKind.DialRequest,
-          dialRequest: DialRequest(
-            addrs: @[
-              MultiAddress.init("/ip4/127.0.0.1/tcp/4040").get(),
-              MultiAddress.init("/ip4/127.0.0.1/tcp/4041").get(),
-            ],
-            nonce: 42.uint64,
-          ),
-        )
-      )
-    )
-
-    # AutonatV2Msg - DialResponse
-    checkEncodeDecode(
-      AutonatV2Msg(
-        oneof: AutonatV2MsgOneof(
-          kind: MsgKind.DialResponse,
-          dialResponse: DialResponse(
-            status: ResponseStatus.Ok,
-            addrIdx: Opt.some(1.uint32),
-            dialStatus: Opt.some(DialStatus.Ok),
-          ),
-        )
-      )
-    )
-
-    # AutonatV2Msg - DialDataRequest
-    checkEncodeDecode(
-      AutonatV2Msg(
-        oneof: AutonatV2MsgOneof(
-          kind: MsgKind.DialDataRequest,
-          dialDataRequest: DialDataRequest(addrIdx: 42.AddrIdx, numBytes: 128.uint64),
-        )
-      )
-    )
-
-    # AutonatV2Msg - DialDataResponse
-    checkEncodeDecode(
-      AutonatV2Msg(
-        oneof: AutonatV2MsgOneof(
-          kind: MsgKind.DialDataResponse,
-          dialDataResponse: DialDataResponse(data: @[1'u8, 2, 3, 4, 5]),
-        )
-      )
-    )
-
-    # DialBack
-    checkEncodeDecode(DialBack(nonce: 123456.uint64))
-
-    # DialBackResponse
-    checkEncodeDecode(DialBackResponse(status: DialBackStatus.Ok))
-
   asyncTest "asNetworkReachability":
     check asNetworkReachability(DialResponse(status: EInternalError)) == Unknown
     check asNetworkReachability(DialResponse(status: ERequestRejected)) == Unknown
diff --git a/tests/libp2p/utils/test_protobuf_metrics.nim b/tests/libp2p/utils/test_protobuf_metrics.nim
@@ -5,8 +5,10 @@
 
 when defined(libp2p_protobuf_metrics):
   import protobuf_serialization
-  import ../../../libp2p/[routing_record, utils/protobuf, utils/protobuf_metrics]
-  import ../../tools/[unittest]
+  import
+    ../../../libp2p/
+      [routing_record, utils/protobuf, utils/protobuf_metrics, crypto/crypto]
+  import ../../tools/[unittest, crypto]
 
   # A type that explicitly opts into metrics tracking.
   type MetricsTestMsg* {.proto2.} = object
@@ -20,22 +22,25 @@ when defined(libp2p_protobuf_metrics):
     except exceptions.KeyError:
       0.0
 
+  proc makePeerRecord(): PeerRecord =
+    PeerRecord.init(
+      PeerId.random(rng()).get(), @[MultiAddress.init("/ip4/127.0.0.1/tcp/1234").get()]
+    )
+
   suite "protobuf_metrics":
-    test "AddressInfo encode does not increment write counter (withMetrics = false)":
-      let ma = MultiAddress.init("/ip4/127.0.0.1/tcp/1234").tryGet()
-      let record = AddressInfo(address: ma)
-      let before = counterValue(libp2p_protobuf_bytes_write, "AddressInfo")
+    test "PeerRecord encode does not increment write counter (withMetrics = false)":
+      let record = makePeerRecord()
+      let before = counterValue(libp2p_protobuf_bytes_write, "PeerRecord")
       discard encode(record)
-      let after = counterValue(libp2p_protobuf_bytes_write, "AddressInfo")
+      let after = counterValue(libp2p_protobuf_bytes_write, "PeerRecord")
       check after == before
 
-    test "AddressInfo decode does not increment read counter (withMetrics = false)":
-      let ma = MultiAddress.init("/ip4/127.0.0.1/tcp/1234").tryGet()
-      let record = AddressInfo(address: ma)
+    test "PeerRecord decode does not increment read counter (withMetrics = false)":
+      let record = makePeerRecord()
       let encoded = encode(record)
-      let before = counterValue(libp2p_protobuf_bytes_read, "AddressInfo")
-      discard AddressInfo.decode(encoded)
-      let after = counterValue(libp2p_protobuf_bytes_read, "AddressInfo")
+      let before = counterValue(libp2p_protobuf_bytes_read, "PeerRecord")
+      discard PeerRecord.decode(encoded)
+      let after = counterValue(libp2p_protobuf_bytes_read, "PeerRecord")
       check after == before
 
     test "write counter incremented on encode":
@@ -89,10 +94,10 @@ when defined(libp2p_protobuf_metrics):
     test "counters track bytes per type label independently":
       let msg = MetricsTestMsg(value: 42)
       let beforeMsg = counterValue(libp2p_protobuf_bytes_write, "MetricsTestMsg")
-      let beforeOther = counterValue(libp2p_protobuf_bytes_write, "AddressInfo")
+      let beforeOther = counterValue(libp2p_protobuf_bytes_write, "PeerRecord")
       discard encode(msg)
       let afterMsg = counterValue(libp2p_protobuf_bytes_write, "MetricsTestMsg")
-      let afterOther = counterValue(libp2p_protobuf_bytes_write, "AddressInfo")
+      let afterOther = counterValue(libp2p_protobuf_bytes_write, "PeerRecord")
       check afterMsg > beforeMsg
       check afterOther == beforeOther
 

Original file line number	Diff line number	Diff line change
`@@ -71,5 +71,4 @@ type`
`71`	`71`	`Protobuf.serializerFor(`
`72`	`72`	`[Cookie, Register, RegisterResponse, Unregister, Discover, DiscoverResponse]`
`73`	`73`	`)`
`74`		`-`
`75`	`74`	`Protobuf.serializerFor([Message], withMetrics = true, domain = "rendezvous")`