Skip to content
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

Protocol documentation? #60

Open
christianbundy opened this issue Apr 28, 2020 · 9 comments
Open

Protocol documentation? #60

christianbundy opened this issue Apr 28, 2020 · 9 comments

Comments

@christianbundy
Copy link

Hi! I'm looking for docs to implement this in other languages. My understanding is that it's DHT + MDNS, but I'm not sure how straightforward it is. Are there any resources y'all could recommend for making Hyperswarm work outside of Node.js? Thanks! ⭐

@mafintosh
Copy link
Contributor

I’m in the middle of documenting it right now :) We’ll be putting up a website as well. Which languages are you porting it to?

@christianbundy
Copy link
Author

Great! I'm not actively working on porting to any language, but after investing heaps of time learning the SSB stack I'm hesitant to adopt a reference implementation before I can understand how hard it'd be to implement from scratch. Hyperswarm is lovely to work with because it Just Works, but I don't actually know what's Just Working and so I figured I'd reach out and start a chat.

Thanks for all of your work on this project!

@mafintosh
Copy link
Contributor

Makes tons of sense. The DHT protocol is not too complicated (at least compared to the rest of the Hyper stack).

Since there’s growing interest I’ll try to just get the content up and style it later to be all nice and stuff :)

@christianbundy
Copy link
Author

Sounds great, looking forward to checking it at your convenience.

@christianbundy
Copy link
Author

Hi, I'm checking back in on this -- are there any resources I should check out, or are the protocol docs still WIP?

@decentral1se
Copy link

Yes, just wanted to chime in that this would be utterly fantastic (having the python implementation in mind...) 🌞

@amoallim15
Copy link

I'm considering to port this specific implementation to python :D Keep up the great work!

@decentral1se
Copy link

Hey @amoallim15 if you get started and want to chat, I've been working on porting the hyper stack to python over at https://hyperpy.decentral1.se so would happily try to help out with your effort! Would be cool to see more python stuff in this space.

@smoyer64
Copy link

smoyer64 commented Nov 11, 2021

@mafintosh

I was working on a Go implementation last year and have just come back to working on the project. The changes from v2.x.x to v3.x.x eliminate the use of protobuf and so the above referenced documentation is more important. What's the status of the protocol documentation? Would you want help with it? Or proof-reading it? (I'm a long-time protocol engineer and worked on the DOCSIS 3.0 and 3.1 specifications so I've got an eye tuned towards separating the protocol specifics from the implementation.

A couple follow-up questions:

  • Is there a testnet configured for a v3 Swarm?
  • Will the network protocol encode the version so that v2 and v3 implementations are compatible?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants