libp2p / libp2p/specs

Revisit peer-id string representation

Open
#423 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1.8k
Forks
320
Avg merge
11d 15h
Merged PRs (30d)
1

Description

See https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#string-representation

Specifically:

Libp2p is slowly transitioning from the first (legacy) format to the second (new).

and

Implementations SHOULD display peer IDs using the first (raw base58btc encoded multihash) format until the second format is widely supported.

Perhaps its time this language is changed to be more definitively in favor of the 'new' encoding.
Opening issue for discussion.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the peer-ids specification section linked in the issue, especially its discussion of legacy and new string representations. Review the existing wording and the four-comment discussion to determine whether there is agreement on a change. Done means reaching a decision and updating the specification text accordingly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, networking
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.