Handle unparsable multiaddrs

Open
#70 12 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
go
Domain
networking

Research direction

Start by reading the existing multiaddr string and binary parsing paths and the protocol definitions. Check the comment discussion for decisions about the proposed string-only unknown protocol; done means preserving an unfamiliar multaddr prefix and multibase argument without requiring every protocol definition, while retaining existing parsing behavior.

Written by the indexing model from the issue text.

Description

Due to the fact that binary multiaddrs don't include protocol definitions, we can't parse them unless we know all the relevant protocols.

However, we can parse a prefix. Therefore, I'd like to propose a special, string-only "unknown" protocol that takes a single multibase encoded argument. That is: `/ip4/1.2.3.4/tcp/123/unknown/bxyz". This would only exist in the string format and would allow us to keep and use multiaddrs we don't fully understand.

This should fix some of the problems described in #6.

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

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.

More from multiformats/multiaddr

All issues in multiformats/multiaddr

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.