Add spec for AutoRelay
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1.8k
- Forks
- 320
- Avg merge
- 11d 15h
- Merged PRs (30d)
- 1
Description
AutoRelay is a libp2p feature that will attempt to automatically discover relay nodes and connect to them if AutoNAT (#180) tells us we're not publicly dial-able.
Things to spec out:
- how AutoNAT is used
- how relay nodes are discovered
- how newly-obtained relay addresses are advertised
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading AutoNAT (#180) to understand how its reachability result is used. Produce a specification covering AutoNAT integration, relay-node discovery, and advertisement of newly obtained relay addresses.
Written by the indexing model from the issue text.
Assessment
- Domain
- distributed-systems, networking
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100