-
Notifications
You must be signed in to change notification settings - Fork 939
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adding example for Identify protocol #2689
Merged
Merged
Changes from 9 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
9d41f5c
Added identify example
dadepo 04ca78f
Update examples/identify.rs
dadepo 1967874
Update examples/identify.rs
dadepo 0cfa33c
Update examples/identify.rs
dadepo 83c49a2
Update examples/identify.rs
dadepo 173e823
Update examples/identify.rs
dadepo 53360ca
Update examples/identify.rs
dadepo c4ae6e4
Start the comment with upper case
dadepo 3d40130
Merge branch 'master' into extend-examples
dadepo f60ad46
Update examples/identify.rs
dadepo 92188ad
Moved identify example to the identify crate
dadepo bbd783e
Merge branch 'master' into extend-examples
dadepo bd1e117
Ran rustfmt and added libp2p as an explicit dev-dependency
dadepo dbe73b7
Merge branch 'master' into extend-examples
dadepo f2668f3
Updated comments to be more accurate
dadepo 0d3dcd0
Merge branch 'master' into extend-examples
dadepo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
// Copyright 2018 Parity Technologies (UK) Ltd. | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a | ||
// copy of this software and associated documentation files (the "Software"), | ||
// to deal in the Software without restriction, including without limitation | ||
// the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
// and/or sell copies of the Software, and to permit persons to whom the | ||
// Software is furnished to do so, subject to the following conditions: | ||
// | ||
// The above copyright notice and this permission notice shall be included in | ||
// all copies or substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS | ||
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
// DEALINGS IN THE SOFTWARE. | ||
|
||
//! identify example | ||
//! | ||
//! In the first terminal window, run: | ||
//! | ||
//! ```sh | ||
//! cargo run --example identify | ||
//! ``` | ||
//! It will print the `PeerId` and the listening addresses, e.g. `Listening on | ||
dadepo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
//! "/ip6/2001:db8:: /tcp/24915"` | ||
//! | ||
//! In the second terminal window, start a new instance of the example with: | ||
//! | ||
//! ```sh | ||
//! cargo run --example identify -- /ip4/127.0.0.1/tcp/24915 | ||
//! ``` | ||
//! The two nodes establish a connection, negotiate the identify protocol | ||
//! The dialing node prints out the `PeerId` of the node it is sending identify info to | ||
//! The other node prints out the received identify info. | ||
|
||
use futures::prelude::*; | ||
use libp2p::swarm::{Swarm, SwarmEvent}; | ||
use libp2p::{identity, Multiaddr, PeerId}; | ||
use std::error::Error; | ||
use libp2p_identify::{Identify, IdentifyConfig, IdentifyEvent}; | ||
|
||
#[async_std::main] | ||
async fn main() -> Result<(), Box<dyn Error>> { | ||
let local_key = identity::Keypair::generate_ed25519(); | ||
let local_peer_id = PeerId::from(local_key.public()); | ||
println!("Local peer id: {:?}", local_peer_id); | ||
|
||
let transport = libp2p::development_transport(local_key.clone()).await?; | ||
|
||
// Create a identify network behaviour. | ||
let behaviour = Identify::new(IdentifyConfig::new("/ipfs/id/1.0.0".to_string(), local_key.public())); | ||
|
||
let mut swarm = Swarm::new(transport, behaviour, local_peer_id); | ||
|
||
// Tell the swarm to listen on all interfaces and a random, OS-assigned | ||
// port. | ||
swarm.listen_on("/ip4/0.0.0.0/tcp/0".parse()?)?; | ||
|
||
// Dial the peer identified by the multi-address given as the second | ||
// command-line argument, if any. | ||
if let Some(addr) = std::env::args().nth(1) { | ||
let remote: Multiaddr = addr.parse()?; | ||
swarm.dial(remote)?; | ||
println!("Dialed {}", addr) | ||
} | ||
|
||
dadepo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
loop { | ||
match swarm.select_next_some().await { | ||
SwarmEvent::NewListenAddr { address, .. } => println!("Listening on {:?}", address), | ||
// Prints peer id identify info is being sent to. | ||
SwarmEvent::Behaviour(IdentifyEvent::Sent {peer_id , ..}) => println!("Sent identify info to {:?}", peer_id), | ||
// Prints out the info received via the identify event | ||
SwarmEvent::Behaviour(IdentifyEvent::Received {info , ..}) => println!("Received {:?}", info), | ||
_ => {} | ||
} | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that this example is focused on
libp2p-identify
, how about moving it toprotocols/identify/examples/
? To make sure one can still discover it, it can be mentioned in https://github.com/libp2p/rust-libp2p/blob/master/examples/README.md.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was not even aware that there are some examples placed together with some of the individual protocols. Is there a reason why not to have all the examples listed in
https://github.com/libp2p/rust-libp2p/tree/master/examples/*
?Having one canonical place where all the examples are listed, IMHO makes discovery easier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No strong opinion on my end. I see
/examples
as a folder for examples that combine many protocols andprotocols/xxx/examples
as a folder for examples targeting a single protocol.I see your point.
Maybe @elenaf9 or @thomaseizinger have an opinion here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am leaning towards having examples focused on a single protocol in that protocol's folder. Since they are individual crates, imo they should "own" their own examples.
We should definitely mention this in the top-level
examples/README.md
, which is currently not the case.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I share the same view. These protocols are individual crates and I think we should follow cargo conventions despite this being a large workspace.
Another solution to this would be to do away with the current meta crate being "special" by being a workspace manifest and a crate at the same time. i.e. we could create a directory
meta
which could house thelibp2p
crate. This would also move the top-levelexamples/
directory which might make it more obvious to users that they will find examples within each crate.