waku-org
/
specs
mirror of https://github.com/waku-org/specs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update peer-exchange.md

This commit is contained in:
Jimmy Debe 2024-02-05 14:29:06 -05:00 committed by GitHub
parent 30cd4bc29f
commit c9b5fd5cc4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
standards/core/peer-exchange/peer-exchange.md
View File

@ -31,10 +31,10 @@ This protocol SHOULD only be used if [33/WAKU2-DISCV5](/spec/33/) is infeasible.
The peer exchange protocol specified in this document is a simple request-response protocol. The peer exchange protocol specified in this document is a simple request-response protocol.
As Figure 1 illustrates, the requesting node sends a request to a peer, which acts as the responder. As Figure 1 illustrates, the requesting node sends a request to a peer, which acts as the responder.
The responder replies with a list of ENRs as specified in [31/WAKU2-ENR](/spec/31/). The responder replies with a list of ENRs as specified in [WAKU2-ENR](../enr.md).
The [multiaddresses](https://docs.libp2p.io/concepts/addressing/) used to connect to the respective peers can be extracted from the ENRs. The [multiaddresses](https://docs.libp2p.io/concepts/addressing/) used to connect to the respective peers can be extracted from the ENRs.
![Figure 1: The responder provides a list of ENRs to the requester. These ENRs contain the information necessary for connecting to the respective peers.](/rfcs/34/protocol.svg) ![Figure 1: The responder provides a list of ENRs to the requester. These ENRs contain the information necessary for connecting to the respective peers.](./images/protocol.svg)
In order to protect its anonymity, the responder MUST NOT provide peers from its actively used peer list as this opens pathways to *Neighbourhood Surveillance* attacks, as described in the In order to protect its anonymity, the responder MUST NOT provide peers from its actively used peer list as this opens pathways to *Neighbourhood Surveillance* attacks, as described in the
[Security/Privacy Considerations Section](#securityprivacy-considerations). [Security/Privacy Considerations Section](#securityprivacy-considerations).
@ -81,7 +81,7 @@ message PeerExchangeRPC {
``` ```
The `enr` field contains a Waku ENR as specified in [31/WAKU2-ENR](/spec/31/). The `enr` field contains a Waku ENR as specified in [WAKU2-ENR](../enr.md).
Requesters send a `PeerExchangeQuery` to a peer. Requesters send a `PeerExchangeQuery` to a peer.
Responders SHOULD include a maximum of `num_peers` `PeerInfo` instances into a response. Responders SHOULD include a maximum of `num_peers` `PeerInfo` instances into a response.
@ -146,7 +146,7 @@ Still, frequent queries can tigger the refresh cycle more often. The `seen cache
### Further Considerations ### Further Considerations
The response field contains ENRs as specified in [31/WAKU2-ENR](/spec/31/). The response field contains ENRs as specified in [WAKU2-ENR](../enr.md).
While ENRs contain signatures, they do not violate the [Waku relay no-sign policy](/spec/11/#signature-policy)), While ENRs contain signatures, they do not violate the [Waku relay no-sign policy](/spec/11/#signature-policy)),
because they are part of the discovery domain and are not propagated in the relay domain. because they are part of the discovery domain and are not propagated in the relay domain.
However, there might still be some form of leakage: However, there might still be some form of leakage:
@ -160,7 +160,7 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
## References ## References
* [33/WAKU2-DISCV5](/spec/33/) * [33/WAKU2-DISCV5](/spec/33/)
* [31/WAKU2-ENR](/spec/31/) * [WAKU2-ENR](../enr.md)
* [multiaddress](https://docs.libp2p.io/concepts/addressing/) * [multiaddress](https://docs.libp2p.io/concepts/addressing/)
* [libp2p discovery interface](https://github.com/status-im/nim-libp2p/issues/140) * [libp2p discovery interface](https://github.com/status-im/nim-libp2p/issues/140)
* [libp2p gossipsub](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md) * [libp2p gossipsub](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md)