Relays: explain main use cases and per-protocol limits
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 72
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
Ref. https://docs.libp2p.io/concepts/nat/circuit-relay/
The page should mention that
- relays are limited by default (time/bytes)
- relays only allow specific libp2p protocols to be relays (e.g. ping, identify, hole punching ones)
- relays do not allow protocols like bitswap by default
- one can run own relay with different rules
- lift bandwidth / time limits for specific IPs
- allow extra protocols
- NOTE: there should be warning this is a potential cost center and implementers should be very careful / have logic ensuring only their "blessed" clients use their "unlimited" relays
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 with the referenced circuit-relay page at docs.libp2p.io/concepts/nat/circuit-relay/. Update it to explain default time and byte limits, permitted protocols, custom relay rules, and the security and cost risks of unrestricted relays. Done means each listed use case and warning is clearly covered on that page.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100