feat: add cid-base option

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

Author: alanshaw

package.json

@@ -147,7 +147,7 @@
     "mkdirp": "~0.5.1",
     "multiaddr": "^5.0.0",
     "multiaddr-to-uri": "^4.0.0",
-    "multibase": "~0.4.0",
+    "multibase": "~0.5.0",
     "multihashes": "~0.4.13",
     "once": "^1.4.0",
     "path-exists": "^3.0.0",

src/cli/commands/bitswap/stat.js

@@ -1,22 +1,30 @@
 'use strict'
 
-const print = require('../../utils').print
+const multibase = require('multibase')
+const { print } = require('../../utils')
 
 module.exports = {
   command: 'stat',
 
   describe: 'Show some diagnostic information on the bitswap agent.',
 
-  builder: {},
+  builder: {
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
+    }
+  },
 
   handler (argv) {
-    argv.ipfs.bitswap.stat((err, stats) => {
+    const { cidBase } = argv
+
+    argv.ipfs.bitswap.stat({ cidBase }, (err, stats) => {
       if (err) {
         throw err
       }
 
       stats.wantlist = stats.wantlist || []
-      stats.wantlist = stats.wantlist.map(entry => entry['/'])
       stats.peers = stats.peers || []
 
       print(`bitswap status

src/cli/commands/bitswap/unwant.js

@@ -1,6 +1,8 @@
 'use strict'
 
-const print = require('../../utils').print
+const multibase = require('multibase')
+const { print } = require('../../utils')
+const { cidToString } = require('../../../utils/cid')
 
 module.exports = {
   command: 'unwant <key>',
@@ -12,14 +14,19 @@ module.exports = {
       alias: 'k',
       describe: 'Key to remove from your wantlist',
       type: 'string'
+    },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
     }
   },
   handler (argv) {
     argv.ipfs.bitswap.unwant(argv.key, (err) => {
       if (err) {
         throw err
       }
-      print(`Key ${argv.key} removed from wantlist`)
+      print(`Key ${cidToString(argv.key, argv.cidBase)} removed from wantlist`)
     })
   }
 }

src/cli/commands/bitswap/wantlist.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const print = require('../../utils').print
+const multibase = require('multibase')
+const { print } = require('../../utils')
 
 module.exports = {
   command: 'wantlist [peer]',
@@ -12,17 +13,22 @@ module.exports = {
       alias: 'p',
       describe: 'Specify which peer to show wantlist for.',
       type: 'string'
+    },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
     }
   },
 
   handler (argv) {
-    argv.ipfs.bitswap.wantlist(argv.peer, (err, res) => {
+    const { peer, cidBase } = argv
+
+    argv.ipfs.bitswap.wantlist(peer, { cidBase }, (err, cids) => {
       if (err) {
         throw err
       }
-      res.Keys.forEach((cid) => {
-        print(cid['/'])
-      })
+      cids.forEach((cid) => print(cid))
     })
   }
 }

src/cli/commands/block/put.js

@@ -6,7 +6,9 @@ const bl = require('bl')
 const fs = require('fs')
 const Block = require('ipfs-block')
 const waterfall = require('async/waterfall')
-const print = require('../../utils').print
+const multibase = require('multibase')
+const { print } = require('../../utils')
+const { cidToString } = require('../../../utils/cid')
 
 function addBlock (data, opts) {
   const ipfs = opts.ipfs
@@ -27,7 +29,7 @@ function addBlock (data, opts) {
     if (err) {
       throw err
     }
-    print(cid.toBaseEncodedString())
+    print(cidToString(cid, opts.cidBase))
   })
 }
 
@@ -54,6 +56,11 @@ module.exports = {
       describe: 'cid version',
       type: 'number',
       default: 0
+    },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
     }
   },
 

src/cli/commands/block/stat.js

@@ -1,17 +1,25 @@
 'use strict'
 
-const CID = require('cids')
-const print = require('../../utils').print
+const multibase = require('multibase')
+const { print } = require('../../utils')
 
 module.exports = {
   command: 'stat <key>',
 
   describe: 'Print information of a raw IPFS block',
 
-  builder: {},
+  builder: {
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
+    }
+  },
 
   handler (argv) {
-    argv.ipfs.block.stat(new CID(argv.key), (err, stats) => {
+    const { key, cidBase } = argv
+
+    argv.ipfs.block.stat(key, { cidBase }, (err, stats) => {
       if (err) {
         throw err
       }

src/cli/commands/files/add.js

@@ -11,9 +11,8 @@ const getFolderSize = require('get-folder-size')
 const byteman = require('byteman')
 const waterfall = require('async/waterfall')
 const mh = require('multihashes')
-const utils = require('../../utils')
-const print = require('../../utils').print
-const createProgressBar = require('../../utils').createProgressBar
+const multibase = require('multibase')
+const { print, isDaemonOn, createProgressBar } = require('../../utils')
 
 function checkPath (inPath, recursive) {
   // This function is to check for the following possible inputs
@@ -156,10 +155,15 @@ module.exports = {
       describe: 'CID version. Defaults to 0 unless an option that depends on CIDv1 is passed. (experimental)',
       default: 0
     },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
+    },
     hash: {
       type: 'string',
       choices: Object.keys(mh.names),
-      describe: 'Hash function to use. Will set Cid version to 1 if used. (experimental)'
+      describe: 'Hash function to use. Will set CID version to 1 if used. (experimental)'
     },
     quiet: {
       alias: 'q',
@@ -194,6 +198,7 @@ module.exports = {
         ? argv.shardSplitThreshold
         : Infinity,
       cidVersion: argv.cidVersion,
+      cidBase: argv.cidBase,
       rawLeaves: argv.rawLeaves,
       onlyHash: argv.onlyHash,
       hashAlg: argv.hash,
@@ -202,7 +207,7 @@ module.exports = {
       chunker: argv.chunker
     }
 
-    if (options.enableShardingExperiment && utils.isDaemonOn()) {
+    if (options.enableShardingExperiment && isDaemonOn()) {
       throw new Error('Error: Enabling the sharding experiment should be done on the daemon')
     }
     const ipfs = argv.ipfs

src/cli/commands/ls.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const utils = require('../utils')
+const multibase = require('multibase')
+const { print, rightpad } = require('../utils')
 
 module.exports = {
   command: 'ls <key>',
@@ -24,16 +25,16 @@ module.exports = {
       desc: 'Resolve linked objects to find out their types. (not implemented yet)',
       type: 'boolean',
       default: false // should be true when implemented
+    },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
     }
   },
 
   handler (argv) {
-    let path = argv.key
-    if (path.startsWith('/ipfs/')) {
-      path = path.replace('/ipfs/', '')
-    }
-
-    argv.ipfs.ls(path, { recursive: argv.recursive }, (err, links) => {
+    argv.ipfs.ls(argv.key, { recursive: argv.recursive, cidBase: argv.cidBase }, (err, links) => {
       if (err) {
         throw err
       }
@@ -45,12 +46,18 @@ module.exports = {
       const multihashWidth = Math.max.apply(null, links.map((file) => file.hash.length))
       const sizeWidth = Math.max.apply(null, links.map((file) => String(file.size).length))
 
+      let pathParts = argv.key.split('/')
+
+      if (argv.key.startsWith('/ipfs/')) {
+        pathParts = pathParts.slice(2)
+      }
+
       links.forEach(link => {
         const fileName = link.type === 'dir' ? `${link.name || ''}/` : link.name
-        const padding = link.depth - path.split('/').length
-        utils.print(
-          utils.rightpad(link.hash, multihashWidth + 1) +
-          utils.rightpad(link.size || '', sizeWidth + 1) +
+        const padding = link.depth - pathParts.length
+        print(
+          rightpad(link.hash, multihashWidth + 1) +
+          rightpad(link.size || '', sizeWidth + 1) +
           '  '.repeat(padding) + fileName
         )
       })

src/cli/commands/object/get.js

@@ -1,6 +1,9 @@
 'use strict'
 
-const print = require('../../utils').print
+const CID = require('cids')
+const multibase = require('multibase')
+const { print } = require('../../utils')
+const { cidToString } = require('../../../utils/cid')
 
 module.exports = {
   command: 'get <key>',
@@ -11,6 +14,11 @@ module.exports = {
     'data-encoding': {
       type: 'string',
       default: 'base64'
+    },
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
     }
   },
 
@@ -27,13 +35,13 @@ module.exports = {
 
       const answer = {
         Data: nodeJSON.data,
-        Hash: nodeJSON.multihash,
+        Hash: cidToString(new CID(node.multihash), argv.cidBase),
         Size: nodeJSON.size,
         Links: nodeJSON.links.map((l) => {
           return {
             Name: l.name,
             Size: l.size,
-            Hash: l.multihash
+            Hash: cidToString(new CID(l.multihash), argv.cidBase)
           }
         })
       }

src/cli/commands/object/links.js

@@ -1,13 +1,22 @@
 'use strict'
 
-const print = require('../../utils').print
+const CID = require('cids')
+const multibase = require('multibase')
+const { print } = require('../../utils')
+const { cidToString } = require('../../../utils/cid')
 
 module.exports = {
   command: 'links <key>',
 
   describe: 'Outputs the links pointed to by the specified object',
 
-  builder: {},
+  builder: {
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
+    }
+  },
 
   handler (argv) {
     argv.ipfs.object.links(argv.key, {
@@ -18,9 +27,10 @@ module.exports = {
       }
 
       links.forEach((link) => {
+        const cidStr = cidToString(new CID(link.multihash), argv.cidBase)
         link = link.toJSON()
 
-        print(`${link.multihash} ${link.size} ${link.name}`)
+        print(`${cidStr} ${link.size} ${link.name}`)
       })
     })
   }

src/cli/commands/object/new.js

@@ -3,24 +3,31 @@
 const debug = require('debug')
 const log = debug('cli:object')
 log.error = debug('cli:object:error')
-const print = require('../../utils').print
+const CID = require('cids')
+const multibase = require('multibase')
+const { print } = require('../../utils')
+const { cidToString } = require('../../../utils/cid')
 
 module.exports = {
   command: 'new [<template>]',
 
   describe: 'Create new ipfs objects',
 
-  builder: {},
+  builder: {
+    'cid-base': {
+      describe: 'Number base to display CIDs in.',
+      type: 'string',
+      choices: multibase.names
+    }
+  },
 
   handler (argv) {
     argv.ipfs.object.new(argv.template, (err, node) => {
       if (err) {
         throw err
       }
 
-      const nodeJSON = node.toJSON()
-
-      print(nodeJSON.multihash)
+      print(cidToString(new CID(node.multihash), argv.cidBase))
     })
   }
 }