Merge pull request #22 from n0-computer/content-discovery

Content discovery

Author: rklaehn

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   MSRV: "1.72"
-  RS_EXAMPLES_LIST: "iroh-mainline-content-discovery,iroh-ipfs,dumbpipe-web,iroh-pkarr-node-discovery"
+  RS_EXAMPLES_LIST: "content-discovery,iroh-ipfs,dumbpipe-web,iroh-pkarr-node-discovery"
   GO_EXAMPLES_LIST: "dall_e_worker"
 
 jobs:

iroh-mainline-content-discovery/.gitignore renamed to content-discovery/.gitignore

@@ -1,6 +1,7 @@
 [workspace]
 members = [
   "iroh-mainline-content-discovery",
+  "iroh-mainline-content-discovery-cli",
   "iroh-mainline-tracker",
 ]
 resolver = "2"

iroh-mainline-content-discovery/Cargo.lock renamed to content-discovery/Cargo.lock

@@ -1,6 +1,12 @@
 # Iroh content discovery
 
-This library provides global content discovery for iroh.
+This rust workspace provides global content discovery for iroh.
+
+*iroh-mainline-content-discovery* is a library that provides a discovery protocol,
+a client implementation, and a client command line utility.
+
+*iroh-mainline-tracker* is a server implementation for the content discovery
+protocol.
 
 ## Building from source
 
@@ -9,12 +15,12 @@ Make sure you have an up to date version of [rust](https://www.rust-lang.org/) i
 `cargo` for your platform.
 
 Then run `cargo build --release` from the root directory. The resulting binary
-will be in `target/release/tracker`
+will be in `target/release/iroh-mainline-tracker`
 
 ## Running the tracker
 
 ```sh
-tracker server
+iroh-mainline-tracker
 ```
 
 Will run the server with a persistent node id and announce information.
@@ -24,7 +30,7 @@ Will run the server with a persistent node id and announce information.
 When announcing content, you can give either iroh tickets or content hashes.
 
 ```sh
-tracker announce \
+iroh-mainline-content-discovery announce \
     --tracker t3od3nblvk6csozc3oe7rjum7oebnnwwfkebolbxf2o66clzdyha \
     blob:ealcoyhcjxyklzee4manl3b5see3k3nwekf6npw5oollcsflrsduiaicaiafetezhwjouayaycuadbes5ibqaq7qasiyqmqo74ijal7k7ec4pni5htntx4tpoawgvmbhaa3txa4uaa
 ```
@@ -36,7 +42,7 @@ When querying content, you can use tickets, hashes, or hash and format.
 When using tickets, the address part of the ticket will be ignored.
 
 ```sh
-tracker query \
+iroh-mainline-content-discovery query \
     --tracker t3od3nblvk6csozc3oe7rjum7oebnnwwfkebolbxf2o66clzdyha \
     blob:ealcoyhcjxyklzee4manl3b5see3k3nwekf6npw5oollcsflrsduiaicaiafetezhwjouayaycuadbes5ibqaq7qasiyqmqo74ijal7k7ec4pni5htntx4tpoawgvmbhaa3txa4uaa
 ```

iroh-mainline-content-discovery/Cargo.toml renamed to content-discovery/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "iroh-mainline-content-discovery-cli"
+version = "0.3.0"
+edition = "2021"
+description = "Content discovery for iroh, using the bittorrent mainline DHT"
+license = "MIT OR Apache-2.0"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+iroh-net = "0.12.0"
+iroh-bytes = "0.12.0"
+iroh-mainline-content-discovery = { path = "../iroh-mainline-content-discovery" }
+quinn = { version = "0.10" }
+iroh-pkarr-node-discovery = { version = "0.1.2" }
+mainline = { version = "1.0.0" }
+anyhow = { version = "1", features = ["backtrace"] }
+futures = { version = "0.3.25" }
+clap = { version = "4", features = ["derive"] }
+tempfile = { version = "3.4" }
+derive_more = { version = "1.0.0-beta.1", features = ["debug", "display", "from", "try_into"] }
+tracing-subscriber = { version = "0.3", features = ["env-filter"] }
+tokio = { version = "1", features = ["io-util", "rt"] }

iroh-mainline-content-discovery/README.md renamed to content-discovery/README.md

@@ -15,6 +15,7 @@ pub struct Args {
 pub enum Commands {
     Announce(AnnounceArgs),
     Query(QueryArgs),
+    QueryDht(QueryDhtArgs),
 }
 
 /// Various ways to specify content.
@@ -80,10 +81,6 @@ pub struct AnnounceArgs {
     #[clap(long)]
     pub tracker: NodeId,
 
-    /// the port to use for announcing
-    #[clap(long)]
-    pub port: Option<u16>,
-
     /// The host to announce. Not needed if content is a ticket.
     #[clap(long)]
     pub host: Option<NodeId>,
@@ -98,17 +95,36 @@ pub struct AnnounceArgs {
     /// Announce that the peer has only partial data.
     #[clap(long)]
     pub partial: bool,
+
+    /// the port to use for announcing
+    #[clap(long)]
+    pub magic_port: Option<u16>,
 }
 
 #[derive(Parser, Debug)]
 pub struct QueryArgs {
+    /// the tracker to query
     #[clap(long)]
     pub tracker: TrackerId,
 
+    /// The content to find hosts for.
+    pub content: ContentArg,
+
+    /// Ask for hosts that were announced as having just partial data
+    #[clap(long)]
+    pub partial: bool,
+
+    /// Ask for hosts that were recently checked and found to have some data
+    #[clap(long)]
+    pub verified: bool,
+
     /// the port to use for querying
     #[clap(long)]
-    pub port: Option<u16>,
+    pub magic_port: Option<u16>,
+}
 
+#[derive(Parser, Debug)]
+pub struct QueryDhtArgs {
     /// The content to find hosts for.
     pub content: ContentArg,
 
@@ -119,4 +135,12 @@ pub struct QueryArgs {
     /// Ask for hosts that were recently checked and found to have some data
     #[clap(long)]
     pub verified: bool,
+
+    /// Parallelism for querying the dht
+    #[clap(long)]
+    pub query_parallelism: Option<usize>,
+
+    /// the port to use for querying
+    #[clap(long)]
+    pub quinn_port: Option<u16>,
 }