multiformats / multiformats/multiaddr

Vague format specification.

Open
#52 0 comments 3 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

This format seems very vague as to the specifics of each protocol.

It may seem very intuitive that an ipv4 address (a 32 bit unsigned integer) should look like .<bits 23 to 16 in decimal>.<bits 15 to 8 in decimal>. (2130706433 should be represented as 127.0.0.1) but I think this should be clearly specified somewhere. The same goes for the binary representation, network byte order may seem like the obvious choice but how do I know what to use for a multiaddr?

These are just protocols which I know of and they have well known and established address representations, there are plenty of protocols in the csv with which I am not familiar. I am not sure how to go about implementing multiaddr without this information.

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 by reviewing the protocol definitions in the repository's CSV and the multiaddr format described in the issue. Identify which address and binary representations are currently unspecified, especially IPv4 and network byte order. Done means the relevant protocol specifications clearly define their representations and provide enough information to implement multiaddr consistently.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.