Add comments

vacp2p · Jun 13, 2023 · 3786b00 · 3786b00
1 parent 489982c
commit 3786b00
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/libp2p/protocols/pubsub/gossipsub/types.nim b/libp2p/protocols/pubsub/gossipsub/types.nim
@@ -45,7 +45,7 @@ const
 
 const
   BackoffSlackTime* = 2 # seconds
-  PingsPeerBudget* = 1000 # maximum 10kbit/s
+  PingsPeerBudget* = 100 # maximum of 6.4kb/heartbeat (6.4kb/s with default 1 second/hb)
   IHavePeerBudget* = 10
   # the max amount of IHave to expose, not by spec, but go as example
   # rust sigp: https://github.com/sigp/rust-libp2p/blob/f53d02bc873fef2bf52cd31e3d5ce366a41d8a8c/protocols/gossipsub/src/config.rs#L572

diff --git a/libp2p/protocols/pubsub/rpc/protobuf.nim b/libp2p/protocols/pubsub/rpc/protobuf.nim
@@ -316,6 +316,8 @@ proc encodeRpcMsg*(msg: RPCMsg, anonymize: bool): seq[byte] =
     pb.write(2, item, anonymize)
   if msg.control.isSome():
     pb.write(3, msg.control.get())
+  # nim-libp2p extension, using fields which are unlikely to be used
+  # by other extensions
   if msg.ping.len > 0:
     pb.write(60, msg.ping)
   if msg.pong.len > 0: