Fix: Change default encoding of CIDv1 to base32#77
Open
sumanjeet0012 wants to merge 2 commits into
Open
Conversation
sumanjeet0012
force-pushed
the
fix-66-default-base32
branch
from
005aabd to
e7bbd13
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR addresses the issue where
CIDv1.encode()incorrectly defaulted tobase58btc. The CID specification officially recommendsbase32as the default encoding for CIDv1 strings. This alignspy-cidwith the spec and with other implementations such as Go'sCid.String().Changes
CIDv1.encodeto use"base32"as the default encoding parameter.test_encode_defaultintests/test_cid.pyto assert against thebase32encoded string rather thanbase58btc.Warning
Breaking Change: The default output of
str(cid)andcid.encode()for allCIDv1objects will now bebase32strings (which begin withb) instead ofbase58btcstrings (which begin withz). Ensure you document this in the release notes so downstreams relying on defaultbase58btcserialization can update their code to explicitly passcid.encode("base58btc")if they rely on the older behavior.