-
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
Changes from 1 commit
9d41f5c
04ca78f
1967874
0cfa33c
83c49a2
173e823
53360ca
c4ae6e4
3d40130
f60ad46
92188ad
bbd783e
bd1e117
dbe73b7
f2668f3
0d3dcd0
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,82 @@ | ||||||
// 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
|
||||||
//! "/ip4/0.0.0.0/tcp/24915"` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Let's not use a wildcard address here. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Given that we called |
||||||
//! | ||||||
//! 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 peer id of the node it is sending identify info to | ||||||
dadepo marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
//! The other node prints out the received identify info | ||||||
dadepo marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
||||||
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 | ||||||
dadepo marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
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), | ||||||
_ => {} | ||||||
} | ||||||
} | ||||||
} |
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.