multiformats / multiformats/multiaddr

define a string representation for unparsable multiaddresses

Open
#155 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
482
Forks
87
PR merge metrics
No merged PRs in 30d

Description

When introducing and rolling out new types, we might encounter multiaddresses that we don't understand yet. We should define a string representation so people can pass them around in JSON (for example).

One option would be to use multibase (and assuming you're using a multibase that your peer understands):

/unparsable/<multibase encoded bytes>

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

The issue names no files, tests, or entry points. Start by locating the existing multiaddress parsing and string or JSON serialization paths, then review how unknown types are handled; the work is done when the project has an agreed representation for unparsable multiaddresses and its behavior is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
networking
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.