feat: cid base option (#1552)

Implements an option for the CLI, HTTP API and core (where appropriate) that will allow the user to pick the multibase encoding for any CIDs that are returned as strings.

**NOTE** Using the CID base option in `bitswap`, `dag` and `object` APIs **WILL NOT** auto upgrade your CID to v1 if it is a v0 CID and **WILL NOT** apply the encoding you specified. This is because these APIs return IPLD objects with links and changing the version of the links would result in a different hash for the node if you were to re-add it. Also, the CID you used to retrieve the node wouldn't actually refer to the node you got back any longer. [Read this](ipfs/kubo#5349 (comment)) for further context.

This PR adds a `--cid-base` option to the following **CLI commands**:

* `jsipfs bitswap stat`
* `jsipfs bitswap unwant`
* `jsipfs bitswap wantlist`
* `jsipfs block put`
* `jsipfs block stat`
* `jsipfs add`
* `jsipfs ls`
* `jsipfs object get`
* `jsipfs object links`
* `jsipfs object new`
* `jsipfs object patch add-link`
* `jsipfs object patch append-data`
* `jsipfs object patch rm-link`
* `jsipfs object patch set-data`
* `jsipfs object put`
* `jsipfs object stat`
* `jsipfs pin add`
* `jsipfs pin ls`
* `jsipfs pin rm`
* `jsipfs resolve`

Note: these two MFS commands _already_ implement the `--cid-base` option:

* `jsipfs files ls`
* `jsipfs files stat`

It also adds `?cid-base=` query option to the following **HTTP endpoints**:

* `/api/v0/bitswap/wantlist`
* `/api/v0/bitswap/stat`
* `/api/v0/bitswap/unwant`
* `/api/v0/block/put`
* `/api/v0/block/stat`
* `/api/v0/add`
* `/api/v0/ls`
* `/api/v0/object/new`
* `/api/v0/object/get`
* `/api/v0/object/put`
* `/api/v0/object/stat`
* `/api/v0/object/links`
* `/api/v0/object/patch/append-data`
* `/api/v0/object/patch/set-data`
* `/api/v0/object/patch/add-link`
* `/api/v0/object/patch/rm-link`
* `/api/v0/pin/ls`
* `/api/v0/pin/add`
* `/api/v0/pin/rm`
* `/api/v0/resolve`

It adds a `cidBase` option to the following **core functions**:

* `resolve`

License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>

Author: Alan Shaw

package.json

@@ -108,7 +108,7 @@
     "ipfs-bitswap": "~0.21.0",
     "ipfs-block": "~0.8.0",
     "ipfs-block-service": "~0.15.1",
-    "ipfs-http-client": "^28.0.1",
+    "ipfs-http-client": "^28.1.0",
     "ipfs-http-response": "~0.2.1",
     "ipfs-mfs": "~0.8.0",
     "ipfs-multipart": "~0.1.0",
@@ -122,7 +122,7 @@
     "ipld-git": "~0.2.2",
     "ipld-zcash": "~0.1.6",
     "ipns": "~0.4.3",
-    "is-ipfs": "~0.4.7",
+    "is-ipfs": "~0.4.8",
     "is-pull-stream": "~0.0.0",
     "is-stream": "^1.1.0",
     "joi": "^14.3.0",

src/cli/commands/add.js

@@ -11,9 +11,9 @@ 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')
+const { cidToString } = require('../../utils/cid')
 
 function checkPath (inPath, recursive) {
   // This function is to check for the following possible inputs
@@ -90,7 +90,7 @@ function addPipeline (index, addStream, list, argv) {
       sortBy(added, 'path')
         .reverse()
         .map((file) => {
-          const log = [ 'added', file.hash ]
+          const log = [ 'added', cidToString(file.hash, { base: argv.cidBase }) ]
 
           if (!quiet && file.path.length > 0) log.push(file.path)
 
@@ -156,10 +156,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',
@@ -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