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

multiaddr string representation: use /p2p by default #386

Closed
1 of 8 tasks
jacobheun opened this issue Jul 23, 2019 · 1 comment
Closed
1 of 8 tasks

multiaddr string representation: use /p2p by default #386

jacobheun opened this issue Jul 23, 2019 · 1 comment
Labels
exp/novice Someone with a little familiarity can pick up kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up status/blocked Unable to be worked further until needs are met

Comments

@jacobheun
Copy link
Contributor

jacobheun commented Jul 23, 2019

Support for /p2p in multiaddr has existed since December 17 of last year. It's time to migrate switch to using it by default. Currently we use /ipfs to indicate peer id's in a multiaddr and it is the default, but /p2p is preferred. In the greater effort to migrate completely away from /ipfs, this task is here to track the roll out of only switching the default.

Breaking Changes

Older JS nodes who are not using the latest multiaddr@6.x.x release line, will not be able to understand the /p2p string representation. This shouldn't affect peers over the wire, but any string usage will cause issues.

Anyone using js-libp2p older than 0.25 may be affected. You can run npm ls multiaddr to check that you have version of multiaddr >= 6.0.2. Older versions of multiaddr will likely have issues with the string representation of /p2p.

js-ipfs

Anyone using js-ipfs@0.34 or later will be unaffected by this change, as it includes the /p2p codec.

TODOs

  • Update multiaddr to prioritize /p2p in a major version release
  • Update the multiaddr version in a minor release for js-libp2p
  • Update js-ipfs to use the new js-libp2p version, in a minor release

Announcement

This is to track announcing the breaking change for older versions. Once a release date has been determined.

Libp2p Release Version: TBD

Parent issue: libp2p/libp2p#79

@wemeetagain
Copy link
Member

This is done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exp/novice Someone with a little familiarity can pick up kind/enhancement A net-new feature or improvement to an existing feature P1 High: Likely tackled by core team if no one steps up status/blocked Unable to be worked further until needs are met
Projects
None yet
Development

No branches or pull requests

3 participants