search

libp2p / specs

Technical specifications for the libp2p networking stack
https://libp2p.io
1.56k stars 273 forks source link

Make the name-change to `PeerRecord` more consistent #298

Closed tmakarios closed 3 years ago

tmakarios commented 4 years ago

An earlier commit (377f05abe37fca3bfe392b5e07c134da94306c02) changed RoutingState to PeerRecord in the protobuf definition, but left RoutingState throughout the rest of the document. This patch makes the document a bit more consistent, but I've been fairly conservative with my changes, so while there are no RoutingStates left, there is still a SignedRoutingState, and a couple of slightly odd things like:

When wrapping a PeerRecord in a signed envelope, the domain string MUST be libp2p-routing-state.

tmakarios commented 3 years ago

@jacobheun The bug still remains (that PeerRecord is the name when it's defined in this document, but the old name RoutingState is still used everywhere else in the same document). Are there plans to resolve this bug some other way?