refactor: Move iroh-router into iroh-net and rename iroh-net to iroh (#2973)

## Description

<!-- A summary of what this pull request achieves and a rough list of
changes. -->
This merges `iroh-net`, `iroh-router` and `iroh` into simply one crate:
`iroh`.

Also adjusts README and documentation messages.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

- `iroh-net` got renamed to `iroh`
- `iroh-router` moved into `iroh`
- `iroh-router::ProtocolHandler` is now
`iroh::protocol::ProtocolHandler`
- `iroh-router::ProtocolMap` is now `iroh::protocol::ProtocolMap`
- `iroh-router::Router` is now `iroh::router::Router`
- `iroh-router::RouterBuilder` is now `iroh::router::RouterBuilder`

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->
Minor Q: Do the `iroh::protocol` and `iroh::router` modules make sense?

## Change checklist

- [ ] Fix "TODO(matheus23): docs" for `Router` etc.
- [ ] Self-review.
- [ ] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.

---------

Co-authored-by: dignifiedquire <[email protected]>

Author: matheus23

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "iroh-node-util"
-description = "Utilities to build binaries containing an iroh-net endpoint"
+description = "Utilities to build binaries containing an iroh endpoint"
 readme = "README.md"
 license = "MIT OR Apache-2.0"
 version = "0.28.0"
@@ -19,7 +19,7 @@ workspace = true
 anyhow = "1"
 clap = { version = "4", features = ["derive"], optional = true }
 tokio = "1"
-iroh-net = { path = "../iroh-net" }
+iroh = { path = "../iroh" }
 tempfile = "3"
 strum = "0.26"
 nested_enum_utils = "0.1.0"

README.md

@@ -1,6 +1,6 @@
 # iroh-node-util
 
-This crate provides utilities to build binaries containing an iroh-net endpoint.
+This crate provides utilities to build binaries containing an iroh endpoint.
 
 # License
 

src/cli/net.rs

@@ -7,7 +7,7 @@ use colored::Colorize;
 use comfy_table::{presets::NOTHING, Cell, Table};
 use futures_lite::{Stream, StreamExt};
 use human_time::ToHumanTimeString;
-use iroh_net::{
+use iroh::{
     endpoint::{DirectAddrInfo, RemoteInfo},
     NodeAddr, NodeId, RelayUrl,
 };

src/fs.rs

@@ -3,7 +3,7 @@
 use std::path::PathBuf;
 
 use anyhow::Context;
-use iroh_net::key::SecretKey;
+use iroh::key::SecretKey;
 use tokio::io::AsyncWriteExt;
 
 /// Loads a [`SecretKey`] from the provided file, or stores a newly generated one

src/lib.rs

@@ -17,7 +17,7 @@ pub mod fs;
 use std::path::PathBuf;
 
 use anyhow::Context;
-use iroh_net::key::SecretKey;
+use iroh::key::SecretKey;
 use tokio::io::AsyncWriteExt;
 
 /// Loads a [`SecretKey`] from the provided file, or stores a newly generated one

src/rpc.rs

@@ -1,4 +1,4 @@
-//! RPC client, server and protocol to control iroh-net endpoints and iroh nodes
+//! RPC client, server and protocol to control iroh endpoints and iroh nodes
 pub mod client;
 pub mod proto;
 pub mod server;

src/rpc/client/net.rs

@@ -11,7 +11,7 @@ use std::net::SocketAddr;
 
 use anyhow::Result;
 use futures_lite::{Stream, StreamExt};
-use iroh_net::{endpoint::RemoteInfo, relay::RelayUrl, NodeAddr, NodeId};
+use iroh::{endpoint::RemoteInfo, relay::RelayUrl, NodeAddr, NodeId};
 use quic_rpc::RpcClient;
 use serde::{Deserialize, Serialize};
 
@@ -49,47 +49,47 @@ impl Client {
     /// This streams a *current snapshot*. It does not keep the stream open after finishing
     /// transferring the snapshot.
     ///
-    /// See also [`Endpoint::remote_info_iter`](iroh_net::Endpoint::remote_info_iter).
+    /// See also [`Endpoint::remote_info_iter`](iroh::Endpoint::remote_info_iter).
     pub async fn remote_info_iter(&self) -> Result<impl Stream<Item = Result<RemoteInfo>>> {
         let stream = self.rpc.server_streaming(RemoteInfosIterRequest {}).await?;
         Ok(flatten(stream).map(|res| res.map(|res| res.info)))
     }
 
     /// Fetches node information about a remote iroh node identified by its [`NodeId`].
     ///
-    /// See also [`Endpoint::remote_info`](iroh_net::Endpoint::remote_info).
+    /// See also [`Endpoint::remote_info`](iroh::Endpoint::remote_info).
     pub async fn remote_info(&self, node_id: NodeId) -> Result<Option<RemoteInfo>> {
         let RemoteInfoResponse { info } = self.rpc.rpc(RemoteInfoRequest { node_id }).await??;
         Ok(info)
     }
 
     /// Fetches the node id of this node.
     ///
-    /// See also [`Endpoint::node_id`](iroh_net::Endpoint::node_id).
+    /// See also [`Endpoint::node_id`](iroh::Endpoint::node_id).
     pub async fn node_id(&self) -> Result<NodeId> {
         let id = self.rpc.rpc(IdRequest).await??;
         Ok(id)
     }
 
     /// Fetches the [`NodeAddr`] for this node.
     ///
-    /// See also [`Endpoint::node_addr`](iroh_net::Endpoint::node_addr).
+    /// See also [`Endpoint::node_addr`](iroh::Endpoint::node_addr).
     pub async fn node_addr(&self) -> Result<NodeAddr> {
         let addr = self.rpc.rpc(AddrRequest).await??;
         Ok(addr)
     }
 
     /// Adds a known node address to this node.
     ///
-    /// See also [`Endpoint::add_node_addr`](iroh_net::Endpoint::add_node_addr).
+    /// See also [`Endpoint::add_node_addr`](iroh::Endpoint::add_node_addr).
     pub async fn add_node_addr(&self, addr: NodeAddr) -> Result<()> {
         self.rpc.rpc(AddAddrRequest { addr }).await??;
         Ok(())
     }
 
     /// Returns the relay server we are connected to.
     ///
-    /// See also [`Endpoint::home_relay`](iroh_net::Endpoint::home_relay).
+    /// See also [`Endpoint::home_relay`](iroh::Endpoint::home_relay).
     pub async fn home_relay(&self) -> Result<Option<RelayUrl>> {
         let relay = self.rpc.rpc(RelayRequest).await??;
         Ok(relay)

src/rpc/proto.rs

@@ -1,4 +1,4 @@
-//! RPC protocol definitions for controlling iroh-net endpoints and iroh nodes
+//! RPC protocol definitions for controlling iroh endpoints and iroh nodes
 use nested_enum_utils::enum_conversions;
 use serde::{Deserialize, Serialize};
 

src/rpc/proto/net.rs

@@ -1,6 +1,6 @@
-//! RPC calls to control an iroh-net endpoint.
+//! RPC calls to control an iroh endpoint.
 #![allow(missing_docs)]
-use iroh_net::{endpoint::RemoteInfo, key::PublicKey, relay::RelayUrl, NodeAddr, NodeId};
+use iroh::{endpoint::RemoteInfo, key::PublicKey, relay::RelayUrl, NodeAddr, NodeId};
 use nested_enum_utils::enum_conversions;
 use quic_rpc_derive::rpc_requests;
 use serde::{Deserialize, Serialize};

src/rpc/server.rs

@@ -3,7 +3,7 @@ use std::{collections::BTreeMap, net::SocketAddr, sync::Arc, time::Duration};
 
 use anyhow::{anyhow, Result};
 use futures_lite::{Stream, StreamExt};
-use iroh_net::{Endpoint, NodeAddr, NodeId, RelayUrl};
+use iroh::{Endpoint, NodeAddr, NodeId, RelayUrl};
 use quic_rpc::server::{ChannelTypes, RpcChannel, RpcServerError};
 use tracing::{debug, info};