refactor: more renaming of the term peer id to node id (#1789)

## Description

some more purging of the term peer id to be consistent

## Notes & open questions

1. There are some structs like PeerIdBytes.
- Do we need them at all, now that PeerId is also 32 bytes?
- Should they also be renamed?

2. There are some places where I kept the term peer id, e.g. the p2p tls
stuff. Also change? It is very internal, so maybe leave it?

iroh-gossip/examples/chat.rs

@@ -25,15 +25,15 @@ use url::Url;
 /// This broadcasts signed messages over iroh-gossip and verifies signatures
 /// on received messages.
 ///
-/// By default a new peer id is created when starting the example. To reuse your identity,
+/// By default a new node id is created when starting the example. To reuse your identity,
 /// set the `--secret-key` flag with the secret key printed on a previous invocation.
 ///
 /// By default, the DERP server run by n0 is used. To use a local DERP server, run
 ///     cargo run --bin derper --features derper -- --dev
 /// in another terminal and then set the `-d http://localhost:3340` flag on this example.
 #[derive(Parser, Debug)]
 struct Args {
-    /// secret key to derive our peer id from.
+    /// secret key to derive our node id from.
     #[clap(long)]
     secret_key: Option<String>,
     /// Set a custom DERP server. By default, the DERP server hosted by n0 will be used.
@@ -131,7 +131,7 @@ async fn main() -> anyhow::Result<()> {
         })
         .bind(args.bind_port)
         .await?;
-    println!("> our peer id: {}", endpoint.peer_id());
+    println!("> our node id: {}", endpoint.node_id());
 
     // wait for a first endpoint update so that we know about our endpoint addresses
     notify.notified().await;
@@ -142,7 +142,7 @@ async fn main() -> anyhow::Result<()> {
     // insert the gossip handle into the gossip cell to be used in the endpoint callbacks above
     gossip_cell.set(gossip.clone()).unwrap();
 
-    // print a ticket that includes our own peer id and endpoint addresses
+    // print a ticket that includes our own node id and endpoint addresses
     let ticket = {
         let me = endpoint.my_addr().await?;
         let peers = peers.iter().cloned().chain([me]).collect();
@@ -206,12 +206,12 @@ async fn subscribe_loop(gossip: Gossip, topic: TopicId) -> anyhow::Result<()> {
             match message {
                 Message::AboutMe { name } => {
                     names.insert(from, name.clone());
-                    println!("> {} is now known as {}", fmt_peer_id(&from), name);
+                    println!("> {} is now known as {}", fmt_node_id(&from), name);
                 }
                 Message::Message { text } => {
                     let name = names
                         .get(&from)
-                        .map_or_else(|| fmt_peer_id(&from), String::to_string);
+                        .map_or_else(|| fmt_node_id(&from), String::to_string);
                     println!("{}: {}", name, text);
                 }
             }
@@ -320,7 +320,7 @@ impl FromStr for Ticket {
 
 // helpers
 
-fn fmt_peer_id(input: &PublicKey) -> String {
+fn fmt_node_id(input: &PublicKey) -> String {
     base32::fmt_short(input.as_bytes())
 }
 fn parse_secret_key(secret: &str) -> anyhow::Result<SecretKey> {

iroh-gossip/src/net.rs

@@ -4,7 +4,9 @@ use anyhow::{anyhow, Context};
 use bytes::{Bytes, BytesMut};
 use futures::{stream::Stream, FutureExt};
 use genawaiter::sync::{Co, Gen};
-use iroh_net::{key::PublicKey, magic_endpoint::get_peer_id, AddrInfo, MagicEndpoint, NodeAddr};
+use iroh_net::{
+    key::PublicKey, magic_endpoint::get_remote_node_id, AddrInfo, MagicEndpoint, NodeAddr,
+};
 use rand::rngs::StdRng;
 use rand_core::SeedableRng;
 use std::{collections::HashMap, future::Future, sync::Arc, task::Poll, time::Instant};
@@ -80,7 +82,7 @@ impl Gossip {
         config: proto::Config,
         my_addr: &AddrInfo,
     ) -> Self {
-        let peer_id = endpoint.peer_id();
+        let peer_id = endpoint.node_id();
         let dialer = Dialer::new(endpoint.clone());
         let state = proto::State::new(
             peer_id,
@@ -92,7 +94,7 @@ impl Gossip {
         let (in_event_tx, in_event_rx) = mpsc::channel(IN_EVENT_CAP);
         let (on_endpoints_tx, on_endpoints_rx) = mpsc::channel(ON_ENDPOINTS_CAP);
 
-        let me = endpoint.peer_id().fmt_short();
+        let me = endpoint.node_id().fmt_short();
         let actor = Actor {
             endpoint,
             state,
@@ -228,7 +230,7 @@ impl Gossip {
     ///
     /// Make sure to check the ALPN protocol yourself before passing the connection.
     pub async fn handle_connection(&self, conn: quinn::Connection) -> anyhow::Result<()> {
-        let peer_id = get_peer_id(&conn)?;
+        let peer_id = get_remote_node_id(&conn)?;
         self.send(ToActor::ConnIncoming(peer_id, ConnOrigin::Accept, conn))
             .await?;
         Ok(())
@@ -714,10 +716,10 @@ mod test {
         let go1 = Gossip::from_endpoint(ep1.clone(), Default::default(), &addr1);
         let go2 = Gossip::from_endpoint(ep2.clone(), Default::default(), &addr2);
         let go3 = Gossip::from_endpoint(ep3.clone(), Default::default(), &addr3);
-        debug!("peer1 {:?}", ep1.peer_id());
-        debug!("peer2 {:?}", ep2.peer_id());
-        debug!("peer3 {:?}", ep3.peer_id());
-        let pi1 = ep1.peer_id();
+        debug!("peer1 {:?}", ep1.node_id());
+        debug!("peer2 {:?}", ep2.node_id());
+        debug!("peer3 {:?}", ep3.node_id());
+        let pi1 = ep1.node_id();
 
         let cancel = CancellationToken::new();
         let tasks = [

iroh-net/bench/src/lib.rs

@@ -33,7 +33,7 @@ pub fn server_endpoint(rt: &tokio::runtime::Runtime, opt: &Opt) -> (NodeAddr, Ma
             .unwrap();
         let addr = ep.local_addr().unwrap();
         let addr = SocketAddr::new("127.0.0.1".parse().unwrap(), addr.0.port());
-        let addr = NodeAddr::new(ep.peer_id()).with_direct_addresses([addr]);
+        let addr = NodeAddr::new(ep.node_id()).with_direct_addresses([addr]);
         (addr, ep)
     })
 }

iroh-net/examples/magic.rs

@@ -66,10 +66,10 @@ async fn main() -> anyhow::Result<()> {
         .bind(args.bind_port)
         .await?;
 
-    let me = endpoint.peer_id();
+    let me = endpoint.node_id();
     let local_addr = endpoint.local_addr()?;
     println!("magic socket listening on {local_addr:?}");
-    println!("our peer id: {me}");
+    println!("our node id: {me}");
 
     match args.command {
         Command::Listen => {

iroh-net/src/derp/client_conn.rs

@@ -228,7 +228,7 @@ impl ClientConnManager {
 ///     - receive a ping and write a pong back
 ///     - notify the server to send a packet to another peer on behalf of the client
 ///     - note whether the client is `preferred`, aka this client is the preferred way
-///     to speak to the peer ID associated with that client.
+///     to speak to the node ID associated with that client.
 ///
 /// If the `ClientConnIo` `can_mesh` that means that the associated [`super::client::Client`] is connected to
 /// a derp [`super::server::Server`] that is apart of the same mesh network as this [`super::server::Server`]. It can:

iroh-net/src/derp/metrics.rs

@@ -60,7 +60,7 @@ pub struct Metrics {
     pub accepts: Counter,
     /// Number of connections we have removed because of an error
     pub disconnects: Counter,
-    // TODO: enable when we can have multiple connections for one peer id
+    // TODO: enable when we can have multiple connections for one node id
     // pub duplicate_client_keys: Counter,
     // pub duplicate_client_conns: Counter,
     // TODO: only important stat that we cannot track right now
@@ -115,7 +115,7 @@ impl Default for Metrics {
 
             accepts: Counter::new("Number of times this server has accepted a connection."),
             disconnects: Counter::new("Number of clients that have then disconnected."),
-            // TODO: enable when we can have multiple connections for one peer id
+            // TODO: enable when we can have multiple connections for one node id
             // pub duplicate_client_keys: Counter::new("Number of dupliate client keys."),
             // pub duplicate_client_conns: Counter::new("Number of duplicate client connections."),
             // TODO: only important stat that we cannot track right now

iroh-net/src/magic_endpoint.rs

@@ -348,8 +348,8 @@ impl MagicEndpoint {
         self.endpoint.accept()
     }
 
-    /// Get the peer id of this endpoint.
-    pub fn peer_id(&self) -> PublicKey {
+    /// Get the node id of this endpoint.
+    pub fn node_id(&self) -> PublicKey {
         self.secret_key.public()
     }
 
@@ -392,14 +392,14 @@ impl MagicEndpoint {
         let addrs = self.local_endpoints().await?;
         let derp = self.my_derp();
         let addrs = addrs.into_iter().map(|x| x.addr).collect();
-        Ok(NodeAddr::from_parts(self.peer_id(), derp, addrs))
+        Ok(NodeAddr::from_parts(self.node_id(), derp, addrs))
     }
 
     /// Get the [`NodeAddr`] for this endpoint, while providing the endpoints.
     pub fn my_addr_with_endpoints(&self, eps: Vec<config::Endpoint>) -> Result<NodeAddr> {
         let derp = self.my_derp();
         let addrs = eps.into_iter().map(|x| x.addr).collect();
-        Ok(NodeAddr::from_parts(self.peer_id(), derp, addrs))
+        Ok(NodeAddr::from_parts(self.node_id(), derp, addrs))
     }
 
     /// Get information on all the nodes we have connection information about.
@@ -573,7 +573,7 @@ pub async fn accept_conn(
 ) -> Result<(PublicKey, String, quinn::Connection)> {
     let alpn = get_alpn(&mut conn).await?;
     let conn = conn.await?;
-    let peer_id = get_peer_id(&conn)?;
+    let peer_id = get_remote_node_id(&conn)?;
     Ok((peer_id, alpn, conn))
 }
 
@@ -590,7 +590,7 @@ pub async fn get_alpn(connecting: &mut quinn::Connecting) -> Result<String> {
 }
 
 /// Extract the [`PublicKey`] from the peer's TLS certificate.
-pub fn get_peer_id(connection: &quinn::Connection) -> Result<PublicKey> {
+pub fn get_remote_node_id(connection: &quinn::Connection) -> Result<PublicKey> {
     let data = connection.peer_identity();
     match data {
         None => anyhow::bail!("no peer certificate found"),
@@ -788,7 +788,7 @@ mod tests {
                         .await
                         .unwrap();
                     let eps = ep.local_addr().unwrap();
-                    info!(me = %ep.peer_id().fmt_short(), ipv4=%eps.0, ipv6=?eps.1, "server bound");
+                    info!(me = %ep.node_id().fmt_short(), ipv4=%eps.0, ipv6=?eps.1, "server bound");
                     for i in 0..n_iters {
                         let now = Instant::now();
                         println!("[server] round {}", i + 1);
@@ -829,7 +829,7 @@ mod tests {
                         .await
                         .unwrap();
                     let eps = ep.local_addr().unwrap();
-                    info!(me = %ep.peer_id().fmt_short(), ipv4=%eps.0, ipv6=?eps.1, t = ?start.elapsed(), "client bound");
+                    info!(me = %ep.node_id().fmt_short(), ipv4=%eps.0, ipv6=?eps.1, t = ?start.elapsed(), "client bound");
                     let node_addr = NodeAddr::new(server_node_id).with_derp_region(region_id);
                     info!(to = ?node_addr, "client connecting");
                     let t = Instant::now();
@@ -866,10 +866,10 @@ mod tests {
     //     setup_logging();
     //     let (ep1, ep2, cleanup) = setup_pair().await.unwrap();
 
-    //     let peer_id_1 = ep1.peer_id();
-    //     eprintln!("peer id 1 {peer_id_1}");
-    //     let peer_id_2 = ep2.peer_id();
-    //     eprintln!("peer id 2 {peer_id_2}");
+    //     let peer_id_1 = ep1.node_id();
+    //     eprintln!("node id 1 {peer_id_1}");
+    //     let peer_id_2 = ep2.node_id();
+    //     eprintln!("node id 2 {peer_id_2}");
 
     //     let endpoint = ep2.clone();
     //     let p2_connect = tokio::spawn(async move {

iroh-net/src/magicsock.rs

@@ -2860,7 +2860,7 @@ pub(crate) mod tests {
 
                 let a_addr = b.endpoint.magic_sock().get_mapping_addr(&a.public()).await.unwrap();
                 let b_addr = a.endpoint.magic_sock().get_mapping_addr(&b.public()).await.unwrap();
-                let b_node_id = b.endpoint.peer_id();
+                let b_node_id = b.endpoint.node_id();
 
                 println!("{}: {}, {}: {}", a_name, a_addr, b_name, b_addr);
 

iroh-sync/src/net.rs

@@ -5,7 +5,7 @@ use std::{
     time::{Duration, Instant},
 };
 
-use iroh_net::{key::PublicKey, magic_endpoint::get_peer_id, MagicEndpoint, NodeAddr};
+use iroh_net::{key::PublicKey, magic_endpoint::get_remote_node_id, MagicEndpoint, NodeAddr};
 use serde::{Deserialize, Serialize};
 use tracing::{debug, error_span, trace, Instrument};
 
@@ -115,7 +115,7 @@ where
 {
     let t_start = Instant::now();
     let connection = connecting.await.map_err(AcceptError::connect)?;
-    let peer = get_peer_id(&connection).map_err(AcceptError::connect)?;
+    let peer = get_remote_node_id(&connection).map_err(AcceptError::connect)?;
     let (mut send_stream, mut recv_stream) = connection
         .accept_bi()
         .await

iroh-sync/src/sync.rs

@@ -62,7 +62,7 @@ pub enum Event {
 pub enum InsertOrigin {
     /// The entry was inserted locally.
     Local,
-    /// The entry was received from the remote peer identified by [`PeerIdBytes`].
+    /// The entry was received from the remote node identified by [`PeerIdBytes`].
     Sync {
         /// The peer from which we received this entry.
         from: PeerIdBytes,

iroh/examples/client.rs

@@ -1,7 +1,7 @@
 //! This example shows the shortest path to working with documents in iroh. This example creates a
 //! document and sets an entry with key: "hello", value: "world". The document is completely local.
 //!
-//! The iroh node that creates the document is backed by an in-memory database and a random peer ID
+//! The iroh node that creates the document is backed by an in-memory database and a random node ID
 //!
 //! run this example from the project root:
 //!     $ cargo run --example client

iroh/examples/collection.rs

@@ -3,7 +3,7 @@
 //! Since this is using the default iroh collection format, it can be downloaded
 //! recursively using the iroh CLI.
 //!
-//! This is using an in memory database and a random peer id.
+//! This is using an in memory database and a random node id.
 //! run this example from the project root:
 //!     $ cargo run -p collection
 use iroh::bytes::util::runtime;

iroh/examples/hello-world.rs

@@ -2,7 +2,7 @@
 //!
 //! This can be downloaded using the iroh CLI.
 //!
-//! This is using an in memory database and a random peer id.
+//! This is using an in memory database and a random node id.
 //! run this example from the project root:
 //!     $ cargo run --example hello-world
 use iroh::bytes::util::runtime;

iroh/examples/rpc.rs

@@ -61,7 +61,7 @@ async fn run(db: impl Store) -> anyhow::Result<()> {
         .spawn()
         .await?;
     // print some info about the node
-    let peer = node.peer_id();
+    let peer = node.node_id();
     let addrs = node.local_endpoint_addresses().await?;
     println!("node PeerID:     {peer}");
     println!("node listening addresses:");

iroh/src/commands/doctor.rs

@@ -91,7 +91,7 @@ pub enum Commands {
     },
     /// Connect to an iroh doctor accept node.
     Connect {
-        /// hex peer id of the node to connect to
+        /// hex node id of the node to connect to
         dial: PublicKey,
 
         /// One or more remote endpoints to use when dialing
@@ -535,7 +535,7 @@ async fn passive_side(
     endpoint: MagicEndpoint,
     connection: quinn::Connection,
 ) -> anyhow::Result<()> {
-    let remote_peer_id = magic_endpoint::get_peer_id(&connection)?;
+    let remote_peer_id = magic_endpoint::get_remote_node_id(&connection)?;
     let gui = Gui::new(endpoint, remote_peer_id);
     loop {
         match connection.accept_bi().await {
@@ -679,7 +679,8 @@ async fn accept(
             match connecting.await {
                 Ok(connection) => {
                     if n == 0 {
-                        let Ok(remote_peer_id) = magic_endpoint::get_peer_id(&connection) else {
+                        let Ok(remote_peer_id) = magic_endpoint::get_remote_node_id(&connection)
+                        else {
                             return;
                         };
                         println!("Accepted connection from {}", remote_peer_id);

iroh/src/commands/node.rs

@@ -162,7 +162,7 @@ async fn spawn_daemon_node<B: iroh_bytes::store::Store, D: iroh_sync::store::Sto
         "DERP Region: {}",
         region.map_or("None".to_string(), |r| r.to_string())
     );
-    println!("PeerID: {}", provider.peer_id());
+    println!("PeerID: {}", provider.node_id());
     println!();
     Ok(provider)
 }

iroh/src/downloader.rs

@@ -228,7 +228,7 @@ impl Downloader {
     where
         S: Store,
     {
-        let me = endpoint.peer_id().fmt_short();
+        let me = endpoint.node_id().fmt_short();
         let (msg_tx, msg_rx) = mpsc::channel(SERVICE_CHANNEL_CAPACITY);
         let dialer = iroh_gossip::net::util::Dialer::new(endpoint);
 

iroh/src/node.rs

@@ -373,7 +373,7 @@ where
             let handler = RpcHandler {
                 inner: inner.clone(),
             };
-            let me = endpoint.peer_id().fmt_short();
+            let me = endpoint.node_id().fmt_short();
             rt2.main().spawn(
                 async move {
                     Self::run(
@@ -448,7 +448,7 @@ where
         // is only initialized once the endpoint is fully bound
         if let Ok(local_endpoints) = server.local_endpoints().await {
             if !local_endpoints.is_empty() {
-                debug!(me = ?server.peer_id(), "gossip initial update: {local_endpoints:?}");
+                debug!(me = ?server.node_id(), "gossip initial update: {local_endpoints:?}");
                 gossip.update_endpoints(&local_endpoints).ok();
             }
         }
@@ -719,7 +719,7 @@ impl<D: ReadableStore> Node<D> {
     }
 
     /// Returns the [`PublicKey`] of the node.
-    pub fn peer_id(&self) -> PublicKey {
+    pub fn node_id(&self) -> PublicKey {
         self.inner.secret_key.public()
     }
 

iroh/src/rpc_protocol.rs

@@ -341,7 +341,7 @@ impl RpcMsg<ProviderService> for NodeStatusRequest {
 /// The response to a version request
 #[derive(Serialize, Deserialize, Debug)]
 pub struct NodeStatusResponse {
-    /// The peer id and socket addresses of this node.
+    /// The node id and socket addresses of this node.
     pub addr: NodeAddr,
     /// The bound listening addresses of the node
     pub listen_addrs: Vec<SocketAddr>,