multiformats / multiformats/multicodec

Define multicodec's prefix

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
383
Forks
221
Avg merge
24d 6h
Merged PRs (30d)
1

Description

Suppose I come across a multicodec-encoded stream in the wild, and have no context for it. After some investigating I might conclude everything after the first few bytes is a standard format. But what are those first few bytes?

If there were a registered prefix for multicodec itself, then all stored/transmitted multicodec streams could start with the same recognizable "magic number". Once the stream is recognized as a multicodec stream, people/machines will know to look at the prefix in the next few bytes to determine the nature of the payload.

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; begin by reviewing the multicodec specification and existing prefix definitions. Done means agreeing on and documenting a registered prefix that identifies multicodec streams before their payload is decoded.

Written by the indexing model from the issue text.

Assessment

Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.