Moving forward with multiaddr

Open
#62 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the checklist in this issue and the in-progress encoding/decoding work in pull request 54. The scope spans use cases, path handling, a common interface, partial decoding, ecosystem updates, and dnsaddr/dnslink documentation, so a contributor would need a narrower task and agreed completion criteria before starting.

Written by the indexing model from the issue text.

Description

Speaking with @lgierth we've come up with a preliminary todo list for making multiaddr fit for general usage:

  • Outline use cases (fill them out probably)
    • dns over https should be included
  • Consilidate discussions about paths in segment values (url/unix paths)
  • Come up with multiaddr interface (what functions every implementation should expose)
  • Encoding/Decoding (WIP: https://github.com/multiformats/multiaddr/pull/54)
  • Figure out how to handle partial decoding of multiaddr
    • Basically be able to parse selected parts of a multiaddr even if there is missing codecs, allowing custom/experimental codecs
  • Update the entire ecosystem (go+js+rust first)
  • Document dnsaddr + (dnslink)
    • make dnslink/dnsaddr separation clearer
Dominant language
Go
Stars
482
Forks
87
PR merge metrics
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.