docs: document dotted-decimal conversion between Peer.ip and Ping.canaries#46
Open
VasilevNStas wants to merge 1 commit into
Open
docs: document dotted-decimal conversion between Peer.ip and Ping.canaries#46VasilevNStas wants to merge 1 commit into
VasilevNStas wants to merge 1 commit into
Conversation
Contributor
Author
|
@davvd plz review |
Member
|
@VasilevNStas we have merge conflicts here, please resolve them and we'll merge |
VasilevNStas
force-pushed
the
14-docs/canaries-ip-conversion
branch
from
July 4, 2026 17:59
bb01648 to
0307a59
Compare
Contributor
Author
|
@davvd conflicts resolved. |
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
2 participants
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.
Description
Documents the required string-to-bytes conversion between
Peer.ip(raw 4 bytes) andPing.canarieskeys (dotted-decimal string). No wire changes.Problem
Ping.canaries(ping.proto:23) uses dotted-decimal string keys like"203.0.113.7", whilePeer.ip(pong.proto:68) delivers the same address asbytes— four raw bytes in network byte order. A client inserting the raw bytes directly as a canary key produces a 4-character binary key like"\xcb\x00\x71\x07"that the Node cannot match, silently dropping every failure report from that client.Changes
Peer.ipcomment: added "Clients MUST convert this to dotted-decimal form when using the address as a Ping.canaries key."Ping.canariescomment: added "When producing keys from Peer.ip (four raw bytes, network byte order), the client MUST convert each byte to its decimal representation and join with dots before inserting into this map."Closes #14