RFC 0001: Text Peer Ids as CIDs #209

lidel · 2019-08-19T15:35:32Z

Important Note: this is the first RFC ever, following "option 2" from #198 and creating a template for future RFCs as a side-effect. The goal is to kick-off the RFC process. I am not a native speaker, feel free to tweak sentences that sound weird.

The RFC 0001 aims to modify Peer ID spec to alter the default string representation from Multihash to CIDv1 in Base32 and to support encoding/decoding text peerids as CIDs.

Changes

~~Added RFC/0000-RFC-TEMPLATE.md the TEMPLATE every future RFC should follow~~
- Removed the template as suggested by @jacobheun – we will add it in separate PR after this PR is finalized
Added RFC/0001-text-peerid-cid.md the first RFC to test the process
Modified peer-ids/peer-ids.md to reflect changes from the RFC

Feedback needed

the process: does the template include everything we expect from this and future RFCs?
the RFC: is the proposed change clear enough? anything missing?

cc ipfs/kubo#5287, multiformats/multicodec#130, libp2p/go-libp2p-core#41, https://github.com/ipfs/ipfs/issues/337

lidel · 2019-08-19T15:41:13Z

peer-ids/peer-ids.md

+Examples:
+
+- SHA256 Peer Id encoded as canonical [CIDv1][cid-versions]:   
+  `bafzbeie5745rpv2m6tjyuugywy4d5ewrqgqqhfnf445he3omzpjbx5xqxe` ([inspect](http://cid.ipfs.io/#bafzbeie5745rpv2m6tjyuugywy4d5ewrqgqqhfnf445he3omzpjbx5xqxe))


FYSA "inspect" link requires multiformats/cid-utils-website#14 to work correctly

jacobheun

A couple nits on the template but otherwise this RFC and the template looks good to me.

Before we merge the RFC we should pull the template out of this PR and merge that separately to avoid muddying the commit of the change.

RFC/0000-RFC-TEMPLATE.md

RFC/0001-text-peerid-cid.md

This is an RFC to modify peerid spec to alter the default string representation from Multihash to CIDv1 in Base32 and to support encoding/decoding text peerids as CIDs. It is also the first RFC ever, following suggestions from #198 and creating a template for future RFCs as a side-effect. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel · 2019-08-28T11:48:39Z

I rebased this PR to remove template and make RFC-0001 easier to audit.
Will add it in a separate PR after this one is finalized and merged.

yusefnapora

This looks great to me 👍 Thanks for making the first RFC!

RFC/0001-text-peerid-cid.md

peer-ids/peer-ids.md

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel · 2019-09-09T14:51:43Z

@raulk thoughts? :)

raulk

I think we need to mandate backwards compatibility with base58 encoded peer IDs string representations.

Implementations parsing IDs from text MUST support both base58 CIDv0 and CIDv1, and they MUST generate base32-encoded CIDv1, and optionally CIDv0 behind a flag.

We may want to provide a web tool to perform conversions, if we don't already.

In the future we can deprecate CIDv0, but if we don't do it this way, we may end up breaking the UX/DX of cross-language demos. May be worth the breakage, but I want us to be explicit about this.

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel · 2019-09-30T13:40:53Z

@raulk CIDv0 is the same as current text representation (Peer ID being multihash in base58btc), making this a relatively safe change.

Existing CID libraries provide conversion methods and support old representation out of the box, but I've added explicit requirement to the spec in b621ac5.

Let me know if there is anything else blocking this.

raulk

Thanks for bearing with me while I got to this, @lidel ;-) LGTM now.

I appreciate your adherence to the unofficial RFC process -- good to do some test runs. Once we land a specific format for RFC docs, we'll retrofit this one if needed.

Stebalien · 2019-10-01T14:58:20Z

@raulk can we 🚢 this?

raulk · 2019-10-01T16:54:51Z

@Stebalien so we've locked in consensus for making the change. I'm not sure how to deal with change management across implementations, though. We haven't worked out the procedural details of how to coordinate the implementation of an RFC across libraries, and how to signal varying support in a matrix-like format :-(

In a nutshell, I want to avoid getting in a situation where go-libp2p spits out string representations of multiaddrs with CIDv1 peer IDs by default to stdout, and when users copy-paste those multiaddrs to an application powered by py-libp2p, it blows up.

I could be paranoid, though.

Stebalien · 2019-10-01T18:47:21Z

@raulk the first step is https://github.com/libp2p/go-libp2p-core/pull/41/files. That will add support for parsing cid-peer-ids but it won't spit them out by default.

I've created a tracking issue: #216.

This change adds two functions: - createFromCID accepts CID as String|CID|Buffer and created PeerId from the multihash value inside of it - toCIDString serializes PeerId multihash into a CIDv1 in Base32, as agreed in libp2p/specs#209 License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

This change adds two functions: - createFromCID accepts CID as String|CID|Buffer and creates PeerId from the multihash value inside of it - toCIDString serializes PeerId multihash into a CIDv1 in Base32, as agreed in libp2p/specs#209 License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

* feat: support Peer ID represented as CID This change adds two functions: - createFromCID accepts CID as String|CID|Buffer and creates PeerId from the multihash value inside of it - toCIDString serializes PeerId multihash into a CIDv1 in Base32, as agreed in libp2p/specs#209 License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * refactor: rename toCIDString to toString CIDv1 is self describing, and toString was not defined. Makes sense to use generic toString in this case. This change also: - remembers string with CID, so it is lazily generated only once - switches createFromB58String to createFromCID (b58 is CIDv0), making it easier to migrate existing codebases. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * docs: comment tests License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> * feat: validate CID multicodec - require CID with 'libp2p-key' (CIDv1) or 'dag-pb' (CIDv0 converted to CIDv1) - delegate CID validation to CID constructor License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel requested review from Stebalien, jacobheun, yusefnapora and raulk August 19, 2019 15:35

lidel mentioned this pull request Aug 19, 2019

Framework specification: formalising the RFC process #198

Open

lidel commented Aug 19, 2019

View reviewed changes

lidel mentioned this pull request Aug 19, 2019

feat: support encoding/decoding peer IDs as CIDs in text libp2p/go-libp2p-core#41

Merged

jacobheun approved these changes Aug 28, 2019

View reviewed changes

RFC/0000-RFC-TEMPLATE.md Outdated Show resolved Hide resolved

RFC/0000-RFC-TEMPLATE.md Outdated Show resolved Hide resolved

RFC/0001-text-peerid-cid.md Outdated Show resolved Hide resolved

lidel force-pushed the rfc/0001-cid-peerid branch from 20c84dd to 8ab79d2 Compare August 28, 2019 11:39

yusefnapora approved these changes Aug 28, 2019

View reviewed changes

Stebalien reviewed Aug 30, 2019

View reviewed changes

RFC/0001-text-peerid-cid.md Show resolved Hide resolved

peer-ids/peer-ids.md Outdated Show resolved Hide resolved

peer-ids/peer-ids.md Show resolved Hide resolved

Apply review changes

4e2c796

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel requested a review from Stebalien September 2, 2019 15:00

lidel mentioned this pull request Sep 12, 2019

IPNS-over-PubSub as an Independent Transport ipfs/specs#218

Merged

raulk requested changes Sep 23, 2019

View reviewed changes

peer-ids.md: be explicit about supporting CID v0&v1

b621ac5

License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org>

lidel requested a review from raulk September 30, 2019 13:40

raulk approved these changes Oct 1, 2019

View reviewed changes

Stebalien mentioned this pull request Oct 1, 2019

Tracking issue for peer IDs as CIDs #216

Open

22 tasks

Stebalien merged commit 9a63e50 into master Oct 1, 2019

Stebalien deleted the rfc/0001-cid-peerid branch October 1, 2019 18:47

This was referenced Oct 25, 2019

feat: support Peer ID represented as CID libp2p/js-peer-id#105

Merged

feat: multiaddr support Peer ID represented as CID multiformats/js-multiaddr#102

Merged

feat: js-ipfs support of CIDs in /ipns/ content paths ipfs/js-ipfs#2566

Merged

lidel mentioned this pull request Nov 15, 2019

fix: persist CIDv1 multicodec pldespaigne/content-hash#37

Merged

vasco-santos mentioned this pull request Feb 5, 2021

feat: add types and update all deps libp2p/js-libp2p-kad-dht#214

Merged

1 task

vasco-santos mentioned this pull request Mar 23, 2021

Calling toString on a peer id breaks deep comparison libp2p/js-peer-id#141

Closed

This was referenced Jan 24, 2024

Add base36 support, libp2p-key codec ipfs-shipyard/net-ipfs-core#28

Merged

Cidv1 support for libp2p-key ipfs-shipyard/net-ipfs-http-client#31

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RFC 0001: Text Peer Ids as CIDs #209

RFC 0001: Text Peer Ids as CIDs #209

lidel commented Aug 19, 2019 •

edited

Loading

lidel Aug 19, 2019

jacobheun left a comment

lidel commented Aug 28, 2019

yusefnapora left a comment

lidel commented Sep 9, 2019

raulk left a comment

lidel commented Sep 30, 2019 •

edited

Loading

raulk left a comment

Stebalien commented Oct 1, 2019

raulk commented Oct 1, 2019 •

edited

Loading

Stebalien commented Oct 1, 2019

RFC 0001: Text Peer Ids as CIDs #209

RFC 0001: Text Peer Ids as CIDs #209

Conversation

lidel commented Aug 19, 2019 • edited Loading

Changes

Feedback needed

lidel Aug 19, 2019

Choose a reason for hiding this comment

jacobheun left a comment

Choose a reason for hiding this comment

lidel commented Aug 28, 2019

yusefnapora left a comment

Choose a reason for hiding this comment

lidel commented Sep 9, 2019

raulk left a comment

Choose a reason for hiding this comment

lidel commented Sep 30, 2019 • edited Loading

raulk left a comment

Choose a reason for hiding this comment

Stebalien commented Oct 1, 2019

raulk commented Oct 1, 2019 • edited Loading

Stebalien commented Oct 1, 2019

lidel commented Aug 19, 2019 •

edited

Loading

lidel commented Sep 30, 2019 •

edited

Loading

raulk commented Oct 1, 2019 •

edited

Loading