multiformats / multiformats/multiaddr
Handle unparsable multiaddrs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 482
- Forks
- 87
- PR merge metrics
- No merged PRs in 30d
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- go
- Domain
- networking
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100