Add and link circuit relay spec #6
Conversation
ghost
added
the
ghost
requested a review
from 
| @@ -13,6 +13,10 @@ It is recommended that implementations use one of the many NAT traversal librari | |||
|
|
|||
| Unfortunately, due to symmetric NATs, container and VM NATs, and other impossible-to-bypass NATs, `libp2p` MUST fallback to relaying communication to establish a full connectivity graph. To be complete, implementations MUST support relay, though it SHOULD be optional and able to be turned off by end users. | |||
|
|
|||
| Connection relaying SHOULD be implemented as a transport, in order to be transparent to upper layers. | |||
|
|
|||
| For an instantiation of relaying, see the [/ipfs/relay/circuit transport](transports/circuit-relay.md). | |||
4-architecture.md
Outdated
| @@ -71,6 +71,8 @@ Protocol multiplexing is done through [`multistream`](https://github.com/jbenet/ | |||
|
|
|||
| ### 4.2.6 Relay | |||
|
|
|||
| See [/ipfs/relay/circuit transport](transports/circuit-relay.md). | |||
7-properties.md
Outdated
| multiplex | /mplex/6.7.0 | | ||
| identify | /ipfs/id/1.0.0 | | ||
| ping | /ipfs/ping/1.0.0 | | ||
| relay | /ipfs/relay/line/0.1.0 | discontinued |
There was a problem hiding this comment.
just delete it, as it 'never actually started' :)
|
Still a great fan of the dramatization :) I would say that we should take this opportunity to make sure that the protocol strings are very clear and well scoped (e.g relay is a libp2p thing and not an ipfs one) |
|
@lgierth I've updated the links and the multicodec in the multicodecs table. I understand that his spec is still a WIP, but let's make it a WIP with a placeholder in master, so that we have an entry point for it and then update the spec as the implemention develops. (Trying to avoid having 50 spec fragments everywhere) |
|
Yes totally agree that we should merge this. While the spec is WIP and will be for a while longer, it's definitely good enough to be merged as a first draft. |
Review of the spec itself concluded in libp2p/go-libp2p-circuit#1 -- the additional changes in this PR are purely linking it into place.
I chose to categorize the relay primarily as a transport, since that is what it looks like to the layers using it -- you use it by means of
/p2p-circuitmultiaddrs, just like other transports. The fact that it's also a swarm protocol is an implementation detail from this point of view.