feat: add util.cid options

src/util.js

@@ -3,16 +3,45 @@
 const CID = require('cids')
 const protons = require('protons')
 const proto = protons(require('./dag.proto.js'))
+const resolver = require('./resolver')
 const DAGLink = require('./dag-link')
 const DAGNode = require('./dag-node')
+const multihashing = require('multihashing-async')
+const waterfall = require('async/waterfall')
 
 exports = module.exports
 
-function cid (node, callback) {
-  if (node.multihash) {
-    return callback(null, new CID(node.multihash))
+/**
+ * @callback CidCallback
+ * @param {?Error} error - Error if getting the CID failed
+ * @param {?CID} cid - CID if call was successful
+ */
+/**
+ * Get the CID of the DAG-Node.
+ *
+ * @param {Object} dagNode - Internal representation
+ * @param {Object} [options] - Options to create the CID
+ * @param {number} [options.version] - CID version number. Defaults to zero if hashAlg == 'sha2-256'; otherwise, 1.
+ * @param {string} [options.hashAlg] - Defaults to hashAlg for the resolver
+ * @param {CidCallback} callback - Callback that handles the return value
+ * @returns {void}
+ */
+function cid (dagNode, options, callback) {
+  if (typeof options === 'function') {
+    callback = options
+    options = {}
   }
-  callback(new Error('not valid dagPB node'))
+  options = options || {}
+  const hashAlg = options.hashAlg || resolver.defaultHashAlg
+  let version = options.version
+  if (typeof version === 'undefined') {
+    version = hashAlg === 'sha2-256' ? 0 : 1
+  }
+  waterfall([
+    (cb) => serialize(dagNode, cb),
+    (serialized, cb) => multihashing(serialized, hashAlg, cb),
+    (mh, cb) => cb(null, new CID(version, resolver.multicodec, mh))
+  ], callback)
 }
 
 function serialize (node, callback) {

test/dag-node-test.js

@@ -17,6 +17,7 @@ const util = dagPB.util
 const series = require('async/series')
 const waterfall = require('async/waterfall')
 const isNode = require('detect-node')
+const multihash = require('multihashes')
 
 const BlockService = require('ipfs-block-service')
 const Block = require('ipfs-block')
@@ -428,6 +429,23 @@ module.exports = (repo) => {
           expect(cid.multihash).to.exist()
           expect(cid.codec).to.equal('dag-pb')
           expect(cid.version).to.equal(0)
+          const mh = multihash.decode(cid.multihash)
+          expect(mh.name).to.equal('sha2-256')
+          done()
+        })
+      })
+    })
+
+    it('get node CID with hashAlg', (done) => {
+      DAGNode.create(Buffer.from('some data'), (err, node) => {
+        expect(err).to.not.exist()
+        util.cid(node, { hashAlg: 'sha2-512' }, (err, cid) => {
+          expect(err).to.not.exist()
+          expect(cid.multihash).to.exist()
+          expect(cid.codec).to.equal('dag-pb')
+          expect(cid.version).to.equal(1)
+          const mh = multihash.decode(cid.multihash)
+          expect(mh.name).to.equal('sha2-512')
           done()
         })
       })