feat(discv5): filter out peers without any listed capability (#2186)

waku-org · Nov 6, 2023 · 200a11d · 200a11d
1 parent b9563ae
commit 200a11d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 15 deletions.
diff --git a/tests/test_waku_discv5.nim b/tests/test_waku_discv5.nim
@@ -320,6 +320,7 @@ procSuite "Waku Discovery v5":
 
       var builder = EnrBuilder.init(enrPrivKey, seqNum = enrSeqNum)
       require builder.withWakuRelaySharding(shardsTopics).isOk()
+      builder.withWakuCapabilities(Relay)
 
       let recordRes = builder.build()
       require recordRes.isOk()
@@ -338,6 +339,7 @@ procSuite "Waku Discovery v5":
 
       var builder = EnrBuilder.init(enrPrivKey, seqNum = enrSeqNum)
       require builder.withWakuRelaySharding(shardsTopics).isOk()
+      builder.withWakuCapabilities(Relay)
 
       let recordRes = builder.build()
       require recordRes.isOk()
@@ -356,6 +358,7 @@ procSuite "Waku Discovery v5":
 
       var builder = EnrBuilder.init(enrPrivKey, seqNum = enrSeqNum)
       require builder.withWakuRelaySharding(shardsTopics).isOk()
+      builder.withWakuCapabilities(Relay)
 
       let recordRes = builder.build()
       require recordRes.isOk()

diff --git a/waku/waku_discv5.nim b/waku/waku_discv5.nim
@@ -52,25 +52,19 @@ type WakuDiscoveryV5* = ref object
 
 proc shardingPredicate*(record: Record): Option[WakuDiscv5Predicate] =
   ## Filter peers based on relay sharding information
+  let typedRecord = record.toTyped().valueOr:
+    debug "peer filtering failed", reason=error
+    return none(WakuDiscv5Predicate)
 
-  let typeRecordRes = record.toTyped()
-  let typedRecord =
-    if typeRecordRes.isErr():
-      debug "peer filtering failed", reason= $typeRecordRes.error
-      return none(WakuDiscv5Predicate)
-    else: typeRecordRes.get()
-
-  let nodeShardOp = typedRecord.relaySharding()
-  let nodeShard =
-    if nodeShardOp.isNone():
-      debug "no relay sharding information, peer filtering disabled"
-      return none(WakuDiscv5Predicate)
-    else: nodeShardOp.get()
-
+  let nodeShard = typedRecord.relaySharding().valueOr:
+    debug "no relay sharding information, peer filtering disabled"
+    return none(WakuDiscv5Predicate)
+
   debug "peer filtering updated"
 
   let predicate = proc(record: waku_enr.Record): bool =
-      nodeShard.shardIds.anyIt(record.containsShard(nodeShard.clusterId, it))
+      record.getCapabilities().len > 0 and #RFC 31 requirement
+      nodeShard.shardIds.anyIt(record.containsShard(nodeShard.clusterId, it)) #RFC 64 guideline
 
   return some(predicate)