README: qualify 'never through a central server' (relay fallback)#386
Open
pstayets wants to merge 1 commit into
Open
README: qualify 'never through a central server' (relay fallback)#386pstayets wants to merge 1 commit into
pstayets wants to merge 1 commit into
Conversation
… relay fallback Under symmetric NAT, hole-punching fails and the beacon relays the (still end-to-end-encrypted) traffic, so data is not always purely peer-to-peer. Reworded the intro and architecture claims to match the relay-fallback behavior documented in the whitepaper (§4.2) and docs/firewalls. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README accuracy pass, companion to pilot-protocol/website#127.
Applied in this PR
"Application data flows directly between peers -- never through a central server" overstates the data-plane guarantee. Under symmetric NAT, hole-punching fails and the beacon relays the (still end-to-end-encrypted) traffic — this is the relay fallback documented in the whitepaper §4.2 and
docs/firewalls. Reworded both the intro (line 45) and the architecture note (line ~237, "the rendezvous is not in the data path") so the relay-fallback exception is explicit. The claim is now accurate without giving up the direct-path-by-default point.Flagged — not changed, please confirm
Reserved addresses used for example agents in the architecture diagram —
README.md:68-69The mermaid diagram assigns
0:0000.0000.0001,0002, and0003to Agent A/B/C. Perpilot-protocol/docs/SPEC.md§1.3 those addresses are reserved (0001= Registry,0002= Beacon,0003= Nameserver). Illustrative only, but it reads oddly against the spec. Suggest bumping the example agents to non-reserved node addresses (the README already uses0:0000.0000.0004/0005for agents elsewhere). Left unchanged because the "right" example addresses are a stylistic call.Whitepaper was intentionally left untouched.