multiformats / multiformats/js-multiformats

Removing version from CID constructor

Open
#3 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
268
Forks
57
PR merge metrics
No merged PRs in 30d

Description

I suggest that the version is removed from the constructor and that it is always v1 automatically. There could be a dedicated v0 constructor, or we just allow constructing it by multihash (which is probably most of its uses).

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 tracing the CID constructor and its current version argument, then inspect callers that construct v0 or v1 values or use multihash. Clarify whether v1 should be implicit and whether a dedicated v0 constructor is required; done means the chosen API is implemented consistently and existing construction paths are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
Issue type
Refactor
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.