Updated "chat" example. Now includes peer discovery [autoconnect] #6
Conversation
|
@Stebalien Can you please review this PR. Thanks. |
chat/README.md
Outdated
| @@ -1,49 +1,126 @@ | |||
| # p2p chat app with libp2p | |||
| # p2p chat app with ```libp2p``` | |||
There was a problem hiding this comment.
No need for the triple quotes.
chat/README.md
Outdated
|
|
||
| Usage: Run `./chat -sp <SOURCE_PORT>` on host 'B' where <SOURCE_PORT> can be any port number. Now run `./chat -d <MULTIADDR_B>` on node 'A' [`<MULTIADDR_B>` is multiaddress of host 'B' which can be obtained from host 'B' console]. | ||
| ``` | ||
| git clone github.com/libp2p/go-libp2p-examples |
There was a problem hiding this comment.
Might as well just use go get github.com/libp2p/go-libp2p-examples/chat.
chat/README.md
Outdated
|
|
||
| To build the example, first run `make deps` in the root directory. | ||
| Use two different terminal windows to excute |
chat/README.md
Outdated
|
|
||
| ```dht.Provide``` makes this node announce that it can provide a value for the given key. Where a key in this case is ```rendezvousPoint```. Other peers will hit the same key to find other peers. |
There was a problem hiding this comment.
This is really not the right way to do this. We've been working on an actual rendezvous protocol here:: libp2p/specs#56.
However, given that we already use this hack in pubsub, I won't object too strongly. We should still at least tell users that this is a hack.
There was a problem hiding this comment.
@Stebalien Sure. As go-libp2p-rendezvous is in development I can submit a PR later which includes go-libp2p-rendezvous for peer discovery.
There was a problem hiding this comment.
I have included a note after explaining provide and findProvider.
chat/README.md
Outdated
| This function is called on the local peer when a remote peer initiate a connection and starts a stream with the local peer. | ||
| ```go | ||
| // Set a function as stream handler. | ||
| host.SetStreamHandler("chat/1.1.0", handleStream) |
There was a problem hiding this comment.
We usually start protocols with a leading /.
chat/README.md
Outdated
| host.SetStreamHandler("chat/1.1.0", handleStream) | ||
| ``` | ||
|
|
||
| ```handleStream``` is executed for each new stream incoming to the local peer. ```s new.Stream``` is used to exchange data between local and remote peer. This example uses non blocking functions for reading anf writing from this stream. |
There was a problem hiding this comment.
Is s new.Stream a typo? (also can use a single backtick).
There was a problem hiding this comment.
yup 😛 .
also can use a single backtick
next time 👍
chat/README.md
Outdated
|
|
||
| ```go | ||
| dht := dht.NewDHTClient(ctx, host, datastore.NewMapDatastore()) |
There was a problem hiding this comment.
We're deprecating this constructor in favor of dht.New(ctx, host) (if you don't pass a datastore, it'll construct a map datastore automatically).
There was a problem hiding this comment.
modified it. Now using dht.New
chat/README.md
Outdated
|
|
||
| ```go | ||
| for _, p := range peers { | ||
| if err := host.Connect(tctx, p); err != nil { |
There was a problem hiding this comment.
FYI, we actually stash the peer addresses in the peerstore. You can skip this step and open a stream directly (it'll automatically connect).
|
@Stebalien Thanks for the review. |
|
if this is good to go, i'll merge @upperwal |
|
Yeah, you can merge it. Thanks. |
ghost
assigned 
|
hey @raulk, thanks 😄 |
Resolves: #3. This PR adds peer discovery using dht. Now, all the nodes will auto-connect given a rendezvous string.