Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a new QUIC codepoint for QUIC v1 #298

Merged
merged 2 commits into from
Nov 11, 2022
Merged

add a new QUIC codepoint for QUIC v1 #298

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
06803c8
change existing QUIC code point to draft-29, add one for v1
marten-seemann Oct 28, 2022
d0610f7
don't change the original code point
marten-seemann Nov 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion table.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@ garlic32, multiaddr, 0x01bf, draft, I2P b
tls, multiaddr, 0x01c0, draft,
sni, multiaddr, 0x01c1, draft, Server Name Indication RFC 6066 § 3
noise, multiaddr, 0x01c6, draft,
quic, multiaddr, 0x01cc, permanent,
Copy link
Member

@lidel lidel Nov 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing quic name will break all implementations that parse text multiaddrs based on libraries generated from this table.

@marten-seemann is the plan to do a hard BREAKING CHANGE across ecosystem (forcing end users or implementations to update bootstrap/peering configs and DNSAddrs manually)?

OR

do we want to have a ~1y deprecation period when both are valid, like we did when we renamed /ipfs/{peerid} to /p2p/{peerid}?
(fysa we've removed the legacy alias entry just recently in #283).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was planning to keep parsing quic as draft-29 for the foreseeable future, but emit quic-draft29 from now on (for the limited amount of time that we still support it).

Is there any way to encode this kind of logic into the multicodec table?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so. We should do the rename later and for now simply add the quic-v1 codepoint. (I left a similar comment in the multiaddr PR: multiformats/multiaddr#147 (comment))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted this change.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add another code-point for quic-draft29 and just deprecate the use of quic altogether. That is semantically equivalent to a rename but can be expressed in the table if we also add a "Status" called "deprecated".

Copy link

@guseggert guseggert Nov 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should do the rename later and for now simply add the quic-v1 codepoint.

I would advocate for not renaming things in this table anymore, ever, and to make this table append-only. We have an increasing number of critical systems and businesses relying on these values remaining constant. There is enormous value in using the names as human-readable codes, but if we are unable to commit to not breaking names then I think we should just remove them entirely and rely on the description, which implies that it's for human and not machine consumption.

quic-draft29, multiaddr, 0x01cc, permanent,
quic-v1, multiaddr, 0x01cd, permanent,
webtransport, multiaddr, 0x01d1, draft,
certhash, multiaddr, 0x01d2, draft, TLS certificate's fingerprint as a multihash
ws, multiaddr, 0x01dd, permanent,
Expand Down