Allow hash algorithm to be specified

Author: alanshaw

src/cli/commands/files/add.js

@@ -8,6 +8,7 @@ const pull = require('pull-stream')
 const paramap = require('pull-paramap')
 const zip = require('pull-zip')
 const toPull = require('stream-to-pull-stream')
+const mh = require('multihashes')
 const utils = require('../../utils')
 const print = require('../../utils').print
 
@@ -154,7 +155,7 @@ module.exports = {
     },
     hash: {
       type: 'string',
-      // TODO: choices: [],
+      choices: [undefined].concat(Object.keys(mh.names)),
       describe: 'Hash function to use. Will set Cid version to 1 if used. (experimental)'
     }
   },
@@ -165,8 +166,8 @@ module.exports = {
     const options = {
       strategy: argv.trickle ? 'trickle' : 'balanced',
       shardSplitThreshold: argv.enableShardingExperiment ? argv.shardSplitThreshold : Infinity,
-      'cid-version': argv['cid-version'],
-      'raw-leaves': argv['raw-leaves'],
+      cidVersion: argv.cidVersion,
+      rawLeaves: argv.rawLeaves,
       hashAlg: argv.hash
     }
 
@@ -178,11 +179,11 @@ module.exports = {
     // cid-version > 0 unless explicitly set to false.
     //
     // This retains feature parity without having to implement raw-leaves.
-    if (argv['cid-version'] > 0 && argv['raw-leaves'] !== false) {
+    if (argv.cidVersion > 0 && argv.rawLeaves !== false) {
       throw new Error('Implied argument raw-leaves must be passed and set to false when cid-version is > 0')
     }
 
-    if (argv['raw-leaves']) {
+    if (argv.rawLeaves) {
       throw new Error('Not implemented: raw-leaves')
     }
 

src/core/components/files.js

@@ -20,6 +20,11 @@ module.exports = function files (self) {
       shardSplitThreshold: self._options.EXPERIMENTAL.sharding ? 1000 : Infinity
     }, options)
 
+    // CID v0 is for multihashes encoded with sha2-256
+    if (opts.hashAlg && opts.hashAlg !== 'sha2-256' && opts.cidVersion !== 1) {
+      opts.cidVersion = 1
+    }
+
     return pull(
       pull.map(normalizeContent),
       pull.flatten(),
@@ -65,6 +70,11 @@ module.exports = function files (self) {
         return callback(new Error('Invalid arguments, data must be an object, Buffer or readable stream'))
       }
 
+      // CID v0 is for multihashes encoded with sha2-256
+      if (options && options.hashAlg && options.hashAlg !== 'sha2-256' && options.cidVersion !== 1) {
+        options.cidVersion = 1
+      }
+
       pull(
         pull.values(normalizeContent(data)),
         importer(self._ipldResolver, options),
@@ -120,7 +130,7 @@ function prepareFile (self, opts, file, callback) {
   waterfall([
     (cb) => self.object.get(file.multihash, cb),
     (node, cb) => {
-      let cid = new CID(node.multihash)
+      let cid = new CID(file.multihash)
 
       if (opts.cidVersion === 1) {
         cid = cid.toV1()

src/http-api/resources/files.js

@@ -158,8 +158,7 @@ exports.add = {
           then: Joi.boolean().valid(false).required(),
           otherwise: Joi.boolean().valid(false)
         }),
-        // TODO: Validate against multihash alg names
-        hash: Joi.string()
+        hash: Joi.string().valid(Object.keys(mh.names))
       })
       // TODO: Necessary until validate "recursive", "stream-channels" etc.
       .options({ allowUnknown: true })
@@ -210,9 +209,9 @@ exports.add = {
     })
 
     const options = {
-      'cid-version': request.query['cid-version'],
-      'raw-leaves': request.query['raw-leaves'],
-      'hashAlg': request.query['hash']
+      cidVersion: request.query['cid-version'],
+      rawLeaves: request.query['raw-leaves'],
+      hashAlg: request.query['hash']
     }
 
     pull(

test/cli/files.js

@@ -6,6 +6,8 @@ const fs = require('fs')
 const path = require('path')
 const compareDir = require('dir-compare').compareSync
 const rimraf = require('rimraf').sync
+const CID = require('cids')
+const mh = require('multihashes')
 const runOnAndOff = require('../utils/on-and-off')
 
 describe('files', () => runOnAndOff((thing) => {
@@ -222,6 +224,17 @@ describe('files', () => runOnAndOff((thing) => {
       })
   })
 
+  Object.keys(mh.names).forEach((name) => {
+    it('add with hash=' + name, () => {
+      return ipfs('add src/init-files/init-docs/readme --hash=' + name)
+        .then((out) => {
+          const hash = out.split(' ')[1]
+          const cid = new CID(hash)
+          expect(mh.decode(cid.multihash).name).to.equal(name)
+        })
+    })
+  })
+
   it('cat', () => {
     return ipfs('files cat QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB')
       .then((out) => {