Iroh GossipSub topic tracker

[rustonbsd]

I wanted to some feedback about my Iroh protocol lib.
A protocol that allows Iroh nodes using GossipSub to find each others node id's based on a Gossip Topic.

Here an example:

use iroh_topic_tracker::topic_tracker::TopicTracker;

let topic = Topic::from_passphrase("my test topic");
let endpoint = Endpoint::builder()
    .secret_key(SecretKey::generate(rand::rngs::OsRng))
    .discovery_n0()
    .discovery_dht()
    .bind()
    .await?;

let topic_tracker = TopicTracker::new(&endpoint);
let router = Router::builder(endpoint.clone())
    .accept(TopicTracker::ALPN, topic_tracker.clone())
    .spawn()
    .await?;
topic_tracker.get_topic_nodes(&topic).await?;

I would love some feedback and to know about the requirements a pull request to add a new protocol to your docs. I realise this is in no way ready for that. Just wandering. Would love to contribute.

Thank you for making a great lib!

https://github.com/rustonbsd/iroh-topic-tracker

[dignifiedquire]

Thanks a lot, in general we are very open to adding protocols from the community. We don't have clear requirements yet, some general things that would be good to have

• some basic docs & some tests
• readme structure similar to our existing ones, as we use that to generate the docs on the website
• a published crate
• license similar to iroh, or an explicit note that it is different

[rustonbsd]

I will get on that and post an update as a pull request or would you like me to keep this issue open?

[rustonbsd]

Hi @dignifiedquire, I implemented your suggestions. what else would you like to see added to make this a valid protocol to be added?

some basic docs & some tests:
work in progress..
see repo: https://github.com/rustonbsd/iroh-topic-tracker
or docs.rs: https://docs.rs/iroh-topic-tracker/0.1.9/iroh_topic_tracker/

readme structure similar to our existing ones, as we use that to generate the docs on the website:
let me know if you would like anything changed
README

a published crate:
https://crates.io/crates/iroh-topic-tracker

license similar to iroh, or an explicit note that it is different:
i just switched to the same dual license of iroh to keep it simple

Thank you and best regards