feat: adds --cid-base argument to stringify cids in different bases

License: MIT
Signed-off-by: achingbrain <[email protected]>

Author: achingbrain

src/cli/ls.js

@@ -20,19 +20,26 @@ module.exports = {
       default: false,
       coerce: asBoolean,
       describe: 'Use long listing format.'
+    },
+    cidBase: {
+      alias: 'cid-base',
+      default: 'base58btc',
+      describe: 'CID base to use.'
     }
   },
 
   handler (argv) {
     let {
       path,
       ipfs,
-      long
+      long,
+      cidBase
     } = argv
 
     argv.resolve(
       ipfs.files.ls(path || FILE_SEPARATOR, {
-        long
+        long,
+        cidBase
       })
         .then(files => {
           if (long) {

src/cli/stat.js

@@ -41,6 +41,11 @@ Type: <type>`,
       default: false,
       coerce: asBoolean,
       describe: 'Compute the amount of the dag that is local, and if possible the total size'
+    },
+    cidBase: {
+      alias: 'cid-base',
+      default: 'base58btc',
+      describe: 'CID base to use.'
     }
   },
 

src/core/ls.js

@@ -2,17 +2,18 @@
 
 const waterfall = require('async/waterfall')
 const map = require('async/map')
-const bs58 = require('bs58')
 const UnixFs = require('ipfs-unixfs')
 const {
   traverseTo,
   loadNode,
+  formatCid,
   FILE_SEPARATOR,
   FILE_TYPES
 } = require('./utils')
 
 const defaultOptions = {
-  long: false
+  long: false,
+  cidBase: 'base58btc'
 }
 
 module.exports = (ipfs) => {
@@ -47,7 +48,7 @@ module.exports = (ipfs) => {
                 done(null, {
                   name: link.name,
                   type: meta.type,
-                  hash: bs58.encode(node.multihash),
+                  hash: formatCid(node.multihash, options.cidBase),
                   size: meta.fileSize() || 0
                 })
               }
@@ -57,7 +58,7 @@ module.exports = (ipfs) => {
           cb(null, [{
             name: result.name,
             type: meta.type,
-            hash: bs58.encode(result.node.multihash),
+            hash: formatCid(result.node.multihash, options.cidBase),
             size: meta.fileSize() || 0
           }])
         }

src/core/stat.js

@@ -1,17 +1,18 @@
 'use strict'
 
 const unmarshal = require('ipfs-unixfs').unmarshal
-const bs58 = require('bs58')
 const {
-  traverseTo
+  traverseTo,
+  formatCid
 } = require('./utils')
 const waterfall = require('async/waterfall')
 const log = require('debug')('ipfs:mfs:stat')
 
 const defaultOptions = {
   hash: false,
   size: false,
-  withLocal: false
+  withLocal: false,
+  cidBase: 'base58btc'
 }
 
 module.exports = (ipfs) => {
@@ -32,7 +33,7 @@ module.exports = (ipfs) => {
       ({ node }, done) => {
         if (options.hash) {
           return done(null, {
-            hash: bs58.encode(node.multihash)
+            hash: formatCid(node.multihash, options.cidBase)
           })
         } else if (options.size) {
           return done(null, {
@@ -49,7 +50,7 @@ module.exports = (ipfs) => {
         }
 
         done(null, {
-          hash: bs58.encode(node.multihash),
+          hash: formatCid(node.multihash, options.cidBase),
           size: meta.fileSize() || 0,
           cumulativeSize: node.size,
           blocks: blocks,

src/core/utils/format-cid.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const CID = require('cids')
+
+module.exports = (cid, base) => {
+  if (Buffer.isBuffer(cid)) {
+    cid = new CID(cid)
+  }
+
+  if (base === 'base58btc') {
+    return cid.toBaseEncodedString()
+  }
+
+  return cid.toV1().toBaseEncodedString(base)
+}

src/core/utils/index.js

@@ -9,6 +9,7 @@ module.exports = {
   createLock: require('./create-lock'),
   createNode: require('./create-node'),
   endPullStream: require('./end-pull-stream'),
+  formatCid: require('./format-cid'),
   limitStreamBytes: require('./limit-stream-bytes'),
   loadNode: require('./load-node'),
   toSourcesAndDestination: require('./to-sources-and-destination'),

src/http/ls.js

@@ -13,11 +13,13 @@ const mfsLs = (api) => {
         } = request.server.app
         const {
           arg,
-          long
+          long,
+          cidBase
         } = request.query
 
         return ipfs.files.ls(arg, {
-          long
+          long,
+          cidBase
         })
           .then(files => {
             reply({
@@ -44,7 +46,8 @@ const mfsLs = (api) => {
         },
         query: Joi.object().keys({
           arg: Joi.string().default('/'),
-          long: Joi.boolean().default(false)
+          long: Joi.boolean().default(false),
+          cidBase: Joi.string().default('base58btc')
         })
           .rename('l', 'long', {
             override: true,

src/http/stat.js

@@ -15,13 +15,15 @@ const mfsStat = (api) => {
           arg,
           hash,
           size,
-          withLocal
+          withLocal,
+          cidBase
         } = request.query
 
         return ipfs.files.stat(arg, {
           hash,
           size,
-          withLocal
+          withLocal,
+          cidBase
         })
           .then(stats => {
             reply({
@@ -52,7 +54,8 @@ const mfsStat = (api) => {
           arg: Joi.string().default('/'),
           hash: Joi.boolean().default(false),
           size: Joi.boolean().default(false),
-          withLocal: Joi.boolean().default(false)
+          withLocal: Joi.boolean().default(false),
+          cidBase: Joi.string().default('base58btc')
         })
       }
     }

test/helpers/index.js

@@ -40,5 +40,6 @@ module.exports = {
   createMfs,
   bufferStream: require('./buffer-stream'),
   collectLeafCids: require('./collect-leaf-cids'),
-  EMPTY_DIRECTORY_HASH: 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
+  EMPTY_DIRECTORY_HASH: 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn',
+  EMPTY_DIRECTORY_HASH_BASE32: 'bafybeiczsscdsbs7ffqz55asqdf3smv6klcw3gofszvwlyarci47bgf354'
 }

test/ls.spec.js

@@ -139,6 +139,26 @@ describe('ls', function () {
       })
   })
 
+  it('lists a file with a base32 hash', () => {
+    const fileName = `small-file-${Math.random()}.txt`
+    const content = Buffer.from('Hello world')
+
+    return mfs.write(`/${fileName}`, content, {
+      create: true
+    })
+      .then(() => mfs.ls(`/${fileName}`, {
+        long: true,
+        cidBase: 'base32'
+      }))
+      .then(files => {
+        expect(files.length).to.equal(1)
+        expect(files[0].name).to.equal(fileName)
+        expect(files[0].type).to.equal(FILE_TYPES.file)
+        expect(files[0].size).to.equal(content.length)
+        expect(files[0].hash.startsWith('b')).to.equal(true)
+      })
+  })
+
   it('fails to list non-existent file', () => {
     return mfs.ls('/i-do-not-exist')
       .then(() => {

test/stat.spec.js

@@ -9,7 +9,8 @@ const loadFixture = require('aegir/fixtures')
 
 const {
   createMfs,
-  EMPTY_DIRECTORY_HASH
+  EMPTY_DIRECTORY_HASH,
+  EMPTY_DIRECTORY_HASH_BASE32
 } = require('./helpers')
 
 describe('stat', function () {
@@ -86,6 +87,20 @@ describe('stat', function () {
       })
   })
 
+  it('returns only a base32 hash', () => {
+    const path = `/directory-${Math.random()}`
+
+    return mfs.mkdir(path)
+      .then(() => mfs.stat(path, {
+        hash: true,
+        cidBase: 'base32'
+      }))
+      .then(stats => {
+        expect(Object.keys(stats).length).to.equal(1)
+        expect(stats.hash).to.equal(EMPTY_DIRECTORY_HASH_BASE32)
+      })
+  })
+
   it('returns only the size', () => {
     const path = `/directory-${Math.random()}`
 
@@ -134,4 +149,23 @@ describe('stat', function () {
         expect(stats.type).to.equal('file')
       })
   })
+
+  it('stats a large file with base32', () => {
+    const filePath = '/stat/large-file.txt'
+
+    return mfs.write(filePath, largeFile, {
+      create: true,
+      parents: true
+    })
+      .then(() => mfs.stat(filePath, {
+        cidBase: 'base32'
+      }))
+      .then((stats) => {
+        expect(stats.hash.startsWith('b')).to.equal(true)
+        expect(stats.size).to.equal(largeFile.length)
+        expect(stats.cumulativeSize).to.equal(490800)
+        expect(stats.blocks).to.equal(2)
+        expect(stats.type).to.equal('file')
+      })
+  })
 })