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.

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

rename namespaces and remove "ipfs" alias for "p2p" #283

Merged
merged 1 commit into from
Aug 25, 2022

Conversation

Stebalien
Copy link
Member

Previously, we called these foo-ns. Now we just call them foo (the fact that they're "namespaces" is implicit.

This way, the path component always matches the multicodec name (for both multiaddr and other path types).

Previously, we called these foo-ns. Now we just call them foo (the fact
that they're "namespaces" is implicit.

This way, the path component always matches the multicodec name (for
both multiaddr and other path types).
@Stebalien Stebalien merged commit 1653be6 into master Aug 25, 2022
@Stebalien Stebalien deleted the feat/rename-namespaces branch August 25, 2022 07:11
@ben221199
Copy link
Contributor

Nice.

Comment on lines +84 to +87
ipld, namespace, 0xe2, draft, IPLD path
ipfs, namespace, 0xe3, draft, IPFS path
swarm, namespace, 0xe4, draft, Swarm path
ipns, namespace, 0xe5, draft, IPNS path
Copy link
Member

@lidel lidel Nov 8, 2022

Choose a reason for hiding this comment

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

cc @makoto – fysa in case this impacts ENS (i know you use ipfs-ns and ipns-ns codes for identifying /ipfs/ and /ipns/ content paths, but not sure if you ever rely on their string labels)

@guseggert
Copy link

guseggert commented Nov 9, 2022

I would like to use human-readable codec names in an API but this makes me think twice, is it incorrect to consider these names as stable?

If these are considered unstable, then we should make this clear in the docs and probably remove the recommendation to parse these names or use them programmatically.

@rvagg
Copy link
Member

rvagg commented Nov 14, 2022

@guseggert mostly we try to keep them stable, but there are occasions like this when they get changed but I think in this case these names are not as likely to be used as they were anyway so the impact is considered fairly low. We're not about to go changing "dag-pb" or other commonly used names, however, even in cases where there's name-regret.

We also have this "draft" thing now, and these are drafts so that lessens the burden. Perhaps we don't document it but maybe there's an implicit "we won't touch this if it's 'permanent'".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants