AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-08 23:08:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

Apply review changes

Browse Source 
License: MIT
Signed-off-by: Marcin Rataj <lidel@lidel.org>
This commit is contained in:
Marcin Rataj
2019-09-02 16:59:13 +02:00
parent 8ab79d2470
commit 4e2c796bc7
2 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
peer-ids/peer-ids.md
View File

@@ -131,7 +131,7 @@ behavior.
### String representation
Peer Ids are [multihashes][multihash] represented with [CIDs](https://github.com/ipld/cid) when encoded into strings.
Peer Ids are [multihashes][multihash] canonically represented with [CIDs](https://github.com/ipld/cid) when encoded into strings.
CID is a multihash with a prefix that specifies things like base encoding, cid version and the type of data behind it:
@@ -139,7 +139,7 @@ CID is a multihash with a prefix that specifies things like base encoding, cid v
<cidv1> ::= <multibase><cid-version><multicodec><multihash>
```
Encoding and decoding of string representation must follow [CID spec][cid-decoding].
Encoding and decoding of string representation must follow [CID spec][cid-decoding].
#### libp2p-key CID
@@ -153,6 +153,14 @@ with `base32` [multibase][multibase] ([RFC4648](https://tools.ietf.org/html/rfc4
- `libp2p-key` multicodec is mandatory when serializing to text (ensures Peer Id is self-describing)
- `base32` is the default multibase encoding: projects are free to use a different one if it is more suited to their needs
##### Decoding string representation
To decode a CID, follow the following algorithm:
- If it is 46 characters long and starts with `Qm...`, it's a CIDv0. Decode it as base58btc multihash.
- Otherwise, decode it according to the multibase and [CID spec][cid-decoding].
Examples:
- SHA256 Peer Id encoded as canonical [CIDv1][cid-versions]: