refactor: default to base32 encoding for v1 CIDs

This switches the default encoding for v1 CIDs from base58btc to base32. See ipfs/js-ipfs#1995 for details. BREAKING CHANGE: The default string encoding for v1 CIDs has changed from base58btc to base32. License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
multiformats · May 8, 2019 · 31f00f0 · 31f00f0
1 parent c29d12e
commit 31f00f0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/src/index.js b/src/index.js
@@ -59,7 +59,7 @@ class CID {
    * new CID(<bs58 encoded multihash>)
    * new CID(<cid>)
    */
-  constructor (version, codec, multihash, multibaseName = 'base58btc') {
+  constructor (version, codec, multihash, multibaseName) {
     if (module.exports.isCID(version)) {
       // version is an exising CID instance
       const cid = version
@@ -95,13 +95,13 @@ class CID {
     if (Buffer.isBuffer(version)) {
       const firstByte = version.slice(0, 1)
       const v = parseInt(firstByte.toString('hex'), 16)
-      if (v === 0 || v === 1) {
+      if (v === 1) {
         // version is a CID buffer
         const cid = version
         this.version = v
         this.codec = multicodec.getCodec(cid.slice(1))
         this.multihash = multicodec.rmPrefix(cid.slice(1))
-        this.multibaseName = (v === 0) ? 'base58btc' : multibaseName
+        this.multibaseName = 'base32'
       } else {
         // version is a raw multihash buffer, so v0
         this.version = 0
@@ -133,7 +133,7 @@ class CID {
     /**
      * @type {string}
      */
-    this.multibaseName = multibaseName
+    this.multibaseName = multibaseName || (version === 0 ? 'base58btc' : 'base32')
 
     CID.validateCID(this)
   }

diff --git a/test/index.spec.js b/test/index.spec.js
@@ -32,6 +32,7 @@ describe('CID', () => {
       expect(cid).to.have.property('codec', 'dag-pb')
       expect(cid).to.have.property('version', 0)
       expect(cid).to.have.property('multihash').that.eql(multihash.fromB58String(mhStr))
+      expect(cid).to.have.property('multibaseName', 'base58btc')
 
       expect(cid.toBaseEncodedString()).to.be.eql(mhStr)
     })
@@ -46,6 +47,7 @@ describe('CID', () => {
         expect(cid).to.have.property('codec', 'dag-pb')
         expect(cid).to.have.property('version', 0)
         expect(cid).to.have.property('multihash').that.eql(mh)
+        expect(cid).to.have.property('multibaseName', 'base58btc')
 
         expect(cid.toBaseEncodedString()).to.eql(mhStr)
         done()
@@ -58,6 +60,7 @@ describe('CID', () => {
       expect(cid).to.have.property('codec', 'dag-pb')
       expect(cid).to.have.property('version', 0)
       expect(cid).to.have.property('multihash')
+      expect(cid).to.have.property('multibaseName', 'base58btc')
     })
 
     it('throws on invalid BS58Str multihash ', () => {
@@ -108,19 +111,21 @@ describe('CID', () => {
       expect(cid).to.have.property('codec', 'dag-pb')
       expect(cid).to.have.property('version', 1)
       expect(cid).to.have.property('multihash')
+      expect(cid).to.have.property('multibaseName', 'base58btc')
 
       expect(cid.toBaseEncodedString()).to.be.eql(cidStr)
     })
 
     it('handles CID (no multibase)', () => {
-      const cidStr = 'zdj7Wd8AMwqnhJGQCbFxBVodGSBG84TM7Hs1rcJuQMwTyfEDS'
+      const cidStr = 'bafybeidskjjd4zmr7oh6ku6wp72vvbxyibcli2r6if3ocdcy7jjjusvl2u'
       const cidBuf = Buffer.from('017012207252523e6591fb8fe553d67ff55a86f84044b46a3e4176e10c58fa529a4aabd5', 'hex')
 
       const cid = new CID(cidBuf)
 
       expect(cid).to.have.property('codec', 'dag-pb')
       expect(cid).to.have.property('version', 1)
       expect(cid).to.have.property('multihash')
+      expect(cid).to.have.property('multibaseName', 'base32')
 
       expect(cid.toBaseEncodedString()).to.be.eql(cidStr)
     })
@@ -131,6 +136,7 @@ describe('CID', () => {
       expect(cid).to.have.property('codec', 'dag-cbor')
       expect(cid).to.have.property('version', 1)
       expect(cid).to.have.property('multihash')
+      expect(cid).to.have.property('multibaseName', 'base32')
     })
 
     it('can roundtrip through cid.toBaseEncodedString()', () => {
@@ -140,6 +146,7 @@ describe('CID', () => {
       expect(cid1).to.have.property('codec').that.eql(cid2.codec)
       expect(cid1).to.have.property('version').that.eql(cid2.version)
       expect(cid1).to.have.property('multihash').that.eql(cid2.multihash)
+      expect(cid1).to.have.property('multibaseName').that.eql(cid2.multibaseName)
     })
 
     it('handles multibyte varint encoded codec codes', () => {
@@ -151,9 +158,11 @@ describe('CID', () => {
       expect(cid1).to.have.property('codec', 'eth-block')
       expect(cid1).to.have.property('version', 1)
       expect(cid1).to.have.property('multihash').that.eql(mh)
+      expect(cid1).to.have.property('multibaseName', 'base32')
       expect(cid2).to.have.property('codec', 'eth-block')
       expect(cid2).to.have.property('version', 1)
       expect(cid2).to.have.property('multihash').that.eql(mh)
+      expect(cid2).to.have.property('multibaseName', 'base32')
     })
 
     it('.prefix', () => {
@@ -199,9 +208,9 @@ describe('CID', () => {
 
     it('returns a string in the base provided', () => {
       const b58v1Str = 'zdj7Wd8AMwqnhJGQCbFxBVodGSBG84TM7Hs1rcJuQMwTyfEDS'
-      const b32v1Str = 'bafybeidskjjd4zmr7oh6ku6wp72vvbxyibcli2r6if3ocdcy7jjjusvl2u'
+      const b64urlv1Str = 'uAXASIHJSUj5lkfuP5VPWf_VahvhARLRqPkF24QxY-lKaSqvV'
       const cid = new CID(b58v1Str)
-      expect(cid.toString('base32')).to.equal(b32v1Str)
+      expect(cid.toString('base64url')).to.equal(b64urlv1Str)
     })
   })