refactor the peer ID spec

libp2p / specs

Technical specifications for the libp2p networking stack

https://libp2p.io

1.56k stars 273 forks source link

refactor the peer ID spec #242

Closed Stebalien closed 4 years ago

Stebalien commented 4 years ago

I reorganized it to put all the key encoding logic together (instead of sticking the peer ID stuff in the middle).
Described how the protobufs must should be deterministically encoded.
Fixed some misconceptions around CIDv0 versus CIDv1. Qm... peer IDs are not CIDv0, they're just bare multihashes.
Instructed users to continue encoding peer IDs as bare multihashes by default for now. Not all implementations support decoding CID peer IDs.

Stebalien commented 4 years ago

Please review this carefully (and don't bother looking at the diff). I'm not married to the refactor itself, I'm more concerned with ensuring that the description is correct and complete.

cc @ShadowJonathan, @alexander255 does this help clarify things?

ShadowJonathan commented 4 years ago

👍 from me