protocols/relay/examples: Add client server instructions #2060
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add instructions on how to run a three node example where a listening relay client listens via a relay server and a dialing relay client dials the listening relay client via the relay server.
r-zig
suggested changes
Apr 28, 2021
r-zig
suggested changes
Apr 28, 2021
protocols/relay/examples/relay.rs
Outdated
| //! - `<peer-id-relay-server>` is replaced by the peer id of the relay server. | ||
| //! | ||
| //! 3. To start the dialing relay client run `cargo run --example relay -- client-listen | ||
| //! <addr-relay-server>/p2p/<peer-id-relay-server>/p2p-circuit/<peer-id-listening-relay-client>` in |
There was a problem hiding this comment.
suppose that the relay peer id is: QmRelay and the relay peer address is /ip6/::1/tcp/54443
the listening peer id is: QmListenPeer
cargo run --example relay -- client-dial /ip6/::1/tcp/54443/p2p/QmRelay/p2p-circuit/p2p/QmListenPeer
|
Good catch @r-zig. I pushed another commit. Want to take another look? |
r-zig
approved these changes
Apr 30, 2021
|
@vmx could you give this pull request a review as a member of the libp2p Rust team? |
vmx
reviewed
May 10, 2021
protocols/relay/examples/relay.rs
Outdated
| //! 2. To start the listening relay client run `cargo run --example relay -- client-listen | ||
| //! <addr-relay-server>/p2p/<peer-id-relay-server>/p2p-circuit` in a second terminal where: | ||
| //! | ||
| //! - `<addr-relay-server>` is replaced by one of the listening addresses of the relay server. |
There was a problem hiding this comment.
This is a language thing. I read "is replaced" as "it will automatically be replaced". I would write something like
<addr-relay-server>: one of the addresses the relay server is listening on<peer-id-relay-server>: the local peer id of the relay server
This would also repeat the exact words the output of step 1 is using:
Local peer id: PeerId("12D3KooWAP5X5k9DS94n7AsiUAsaiso59Kioh14j2c13fCiudjdZ")
Listening on "/ip6/::1/tcp/36537"
…
(such example output could also be added to step 1).
|
@vmx thanks for the review as well as testing this out! Would you mind taking another look? |
vmx
approved these changes
May 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add instructions on how to run a three node example where a listening
relay client listens via a relay server and a dialing relay client dials
the listening relay client via the relay server.
//CC @r-zig