Here's a pre-spec #1

ghost · 2017-01-26T03:29:42Z

Q: how did you draw the ascii art?
A: by hand, with love

ghost · 2017-01-26T03:30:56Z

Rendered view: https://github.com/libp2p/go-libp2p-relay/blob/feat/prespec/README.md

ghost · 2017-01-26T03:32:18Z

The section on addressing is still a bit rough around the edges, but I think it all captures the general idea.

jbenet · 2017-01-26T06:42:36Z

README.md

+[go-libp2p-nat]: https://github.com/libp2p/go-libp2p-nat
+
+
+## Dramatization


jbenet · 2017-01-26T06:43:25Z

README.md

+This helps in situations where nodes are behind NAT or reverse proxies,
+or simply don't support the same transports (e.g. go-ipfs vs. browser-ipfs).
+libp2p already has modules for NAT ([go-libp2p-nat][go-libp2p-nat]),
+but these don't always do the job, just because NAT traversal is a clusterfuck.


clusterfuck

technical term :D

we'll want to remove before merging for benefit of more proper readers

yes, did this in the spirit of banana-driven writing. if you can't come up with a good term, insert one which is so bad you have to replace it :)

jbenet · 2017-01-26T06:44:11Z

README.md

+One node asks a relay node to connect to another node on behalf of the first node.
+The relay node shortcircuits its streams to the two nodes,
+and they are then connected through the relay.
+This connection quaks and behaves just like a direct connection would,


rm "quaks and"

jbenet · 2017-01-26T06:45:21Z

README.md

+-------+                                        +---------+                               +-------+
+      ^                                            +-----+                                    ^
+      |                                            |     |                                    |
+      |        /libp2p-circuit-relay/QmTwo         |     |                                    |


can we come up with a shorter protocol name? like p2p-circuit or p2pcr or something?

I'm open to anything here -- in a similar fashion we already have /libp2p-webrtc-star and /libp2p-webrtc-direct

yeah, we can short all the libp2p specific transports to only use p2p, at the same time we drop /ipfs/ and use /p2p/ for addrs

/p2p-circuit then?

jbenet · 2017-01-26T06:48:44Z

README.md

+- QmOne is configured to use QmRelay for relaying.
+- QmOne automatically added `/libp2p-circuit-relay/ipfs/QmTwo` to its set of QmTwo addresses.
+- QmOne tries to connect via relaying, because it shares this transport with QmTwo.
+- A lively and prolonged dialogue ensues.


expand with:

Scene 3:

QmOne connects to QmRelay, establishing a secure connection.

QmOne asks QmRelay to connect to /ipfs/QmTwo

QmRelay can do so, and dials QmTwo, establishing a secure connection.

QmRelay then plugs the connections together, letting QmOne speak to QmTwo.

QmOne and QmTwo want to speak privately, so they, too, establish a secure connection over the relayed transport.

A lively and secure dialogue ensues.

👍 Yeah, this is why we need Relay as a Mounted protocol

jbenet · 2017-01-26T06:50:30Z

README.md

+
+```
+/ipfs/relay/circuit/0.1.0
+QmOne


/ipfs/QmOne ?

and it should be /p2p once we make that switch

You're right, changing it to /p2p

jbenet · 2017-01-26T06:50:39Z

README.md

+```
+<multistream-header>
+<src>
+<dst>


<dst-multiaddr> ?

jbenet · 2017-01-26T06:51:22Z

README.md

+- `multistream-header`: This field is not strictly part of the relay stream.
+  - Multistreams are prefixed with a multicodec field identifying the protocol used for the stream.
+- `src`: The PeerID of the node opening the connection.
+- `dst`: The PeerID of the node that `src` wants to connect to.


hmmm i may be fine if this is a peer-only thing. then it works differently than the circuit relay thing i had made, which dials to multiaddrs. (i.e. i tell A what to dial to connect to the next step)

jbenet · 2017-01-26T06:52:10Z

README.md

+
+  AllowRelaying(bool whetherToRelayOthersConnections)
+}
+```


I cant comment on the interfaces because i havent used them :)

jbenet · 2017-01-26T06:54:29Z

README.md

+- *Not capable of *connecting* via relaying.*
+
+Since the existing protocol is incomplete, insecure, and certainly not used,
+we can safely remove it.


Hm, we do need to be able to dial multiaddrs that the relaying node does not previously know. I think this is two things.

(1) a circuit relay that dials other multiaddrs.

(2) a circuit relay that understands /{ipfs, p2p}/<peerid> multiaddrs, and can dial to those with its own routing.

it would be useful to setup a bunch of boxes that do (1) kind of relay without dht or anything else. just dumb pipes.

Yes agreed, in the addressing section i wrote:

Relay addresses can be encapsulated "infinitely",
so that one can construct onion-like relay chains:
/libp2p-circuit-relay/ipfs/QmFoo/libp2p-circuit-relay/ipfs/QmBar

Relay addresses can encapsulated in an /ipfs address to signal a specific relay node to use:
/ipfs/QmRelay/libp2p-circuit-relay/ipfs/QmFoo
or /dns6/relay.libp2p.io/ipfs/QmRelay/libp2p-circuit-relay/ipfs/QmFoo

the stream protocol could understand any of these.

daviddias · 2017-01-26T15:19:22Z

README.md

-# go-libp2p-relay
-Circuit Switching for libp2p
+# go-libp2p-circuit-relay
+> Circuit Switching in libp2p


The spec should be a libp2p spec inside the specs folder, it applies to any language (or at least, it should)

agreed, gonna move it there eventually

Thank you for moving it :)

daviddias · 2017-01-26T15:22:32Z

README.md

+      +--------------------------------------------+     +------------------------------------+
+```
+
+[go-libp2p-nat]: https://github.com/libp2p/go-libp2p-nat


Why is this link here?

It's a footnote link, the actual link is within the paragraphs above. I'll inline it.

daviddias · 2017-01-26T15:23:00Z

README.md

+- QmOne wants to connect to QmTwo,
+  and through peer routing has acquired a set of addresses of QmTwo.
+- QmTwo doesn't support any of the transports used by QmOne.
+- Awkward silence.


daviddias · 2017-01-26T15:26:03Z

README.md

+or `/dns6/relay.libp2p.io/ipfs/QmRelay/libp2p-circuit-relay/ipfs/QmFoo`
+
+
+### /ipfs/relay/circuit stream protocol


can we do /p2p-circuit-relay/ instead? /ipfs/relay relay would make it specific to IPFS and could also mean other types of relay

This is the protocol multicodec, not the multiaddr, as in: https://github.com/libp2p/specs/blob/master/7-properties.md#757-protocol-multicodecs

ghost · 2017-01-27T02:16:59Z

I think I've addressed all comments, plus the addressing and wire sections got a big makeover and are a lot better now. (I'm not sure yet how to fit in the "Scene 3" as suggested.)

dignifiedquire · 2017-01-27T11:22:52Z

README.md

+
+## Addressing
+
+`/p2p-circuit` multiaddrs don't carry any meaning of their own.


Once we move ipfs to p2p this starts looking pretty odd having p2p twice in there.

I'm not sure how to avoid that:

multiaddrs are meant to be as verbose as neccessary.

some kind of prefix for libp2p-specific protocols (other example: /libp2p-webrtc-star) is likely helpful to open up development to other projects and communities.

I also don't mind it much really :)

given that I don't have any good ideas I'm withdrawing my concerns :)

daviddias · 2017-01-29T20:30:02Z

Humble request - Can this be moved to libp2p/specs?

ghost · 2017-01-29T20:33:03Z

Yes if it looks good to you? I just didn't wanna interrupt the PR in the middle of it

ghost · 2017-02-08T02:40:43Z

Got positive feedback from @whyrusleeping too -- closing this PR in favor of moving the document into libp2p/specs.

ghost requested review from jbenet, daviddias and whyrusleeping January 26, 2017 03:29

ghost mentioned this pull request Jan 26, 2017

Sprint: Browser accesses go-ipfs content ipfs/team-mgmt#310

Closed

50 tasks

jbenet suggested changes Jan 26, 2017

View reviewed changes

daviddias reviewed Jan 26, 2017

View reviewed changes

ghost force-pushed the feat/prespec branch 3 times, most recently from 05c1aa2 to 80b1b29 Compare January 27, 2017 02:02

Here's a pre-spec

25e8fee

ghost force-pushed the feat/prespec branch from 80b1b29 to 25e8fee Compare January 27, 2017 02:13

dignifiedquire reviewed Jan 27, 2017

View reviewed changes

Fine-tune copy

6b5b876

ghost closed this Feb 8, 2017

ghost mentioned this pull request Feb 8, 2017

Add and link circuit relay spec libp2p/specs#6

Merged

daviddias deleted the feat/prespec branch February 9, 2017 00:58

This pull request was closed.

		[go-libp2p-nat]: https://github.com/libp2p/go-libp2p-nat


		## Dramatization

		or `/dns6/relay.libp2p.io/ipfs/QmRelay/libp2p-circuit-relay/ipfs/QmFoo`


		### /ipfs/relay/circuit stream protocol


		## Addressing

		`/p2p-circuit` multiaddrs don't carry any meaning of their own.

Here's a pre-spec #1

Here's a pre-spec #1

Conversation

ghost commented Jan 26, 2017 • edited by ghost Loading

ghost commented Jan 26, 2017

ghost commented Jan 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jan 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

daviddias commented Jan 29, 2017

ghost commented Jan 29, 2017

ghost commented Feb 8, 2017

ghost commented Jan 26, 2017 •

edited by ghost

Loading