feat: CID Support

Closes ipfs-shipyard#12

package.json

@@ -28,8 +28,9 @@
   "author": "Francisco Dias <francisco@baiodias.com> (http://franciscodias.net/)",
   "license": "MIT",
   "dependencies": {
-    "bs58": "^4.0.0",
-    "multihashes": "^0.3.2"
+    "cids": "^0.5.1",
+    "bs58": "^4.0.1",
+    "multihashes": "^0.4.9"
   },
   "devDependencies": {
     "aegir": "^9.4.0",
@@ -50,4 +51,4 @@
     "Marcin Rataj <lidel@lidel.org>",
     "nginnever <ginneversource@gmail.com>"
   ]
-}
+}

src/index.js

@@ -2,6 +2,7 @@
 
 const base58 = require('bs58')
 const multihash = require('multihashes')
+const CID = require('cids')
 
 const urlPattern = /^https?:\/\/[^/]+\/(ip(f|n)s)\/((\w+).*)/
 const pathPattern = /^\/(ip(f|n)s)\/((\w+).*)/
@@ -17,6 +18,14 @@ function isMultihash (hash) {
   }
 }
 
+function isCID (hash) {
+  try {
+    return CID.isCID(new CID(hash))
+  } catch (e) {
+    return false
+  }
+}
+
 function isIpfs (input, pattern) {
   const formatted = convertToString(input)
   if (!formatted) {
@@ -33,7 +42,7 @@ function isIpfs (input, pattern) {
   }
 
   const hash = match[4]
-  return isMultihash(hash)
+  return isCID(hash)
 }
 
 function isIpns (input, pattern) {
@@ -67,6 +76,7 @@ function convertToString (input) {
 
 module.exports = {
   multihash: isMultihash,
+  cid: isCID,
   ipfsUrl: (url) => isIpfs(url, urlPattern),
   ipnsUrl: (url) => isIpns(url, urlPattern),
   url: (url) => (isIpfs(url, urlPattern) || isIpns(url, urlPattern)),

test/test-cid.spec.js

@@ -0,0 +1,56 @@
+/* eslint-env mocha */
+'use strict'
+
+const base58 = require('bs58')
+const expect = require('chai').expect
+const isIPFS = require('../src/index')
+
+describe('ipfs cid', () => {
+  it('isIPFS.cid should match a valid CIDv0 (multihash)', (done) => {
+    const actual = isIPFS.cid('QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o')
+    expect(actual).to.equal(true)
+    done()
+  })
+
+  it('isIPFS.cid should match a valid CIDv0 (multihash) buffer', (done) => {
+    const actual = isIPFS.cid(new Buffer(base58.decode('QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o')))
+    expect(actual).to.equal(true)
+    done()
+  })
+
+  it('isIPFS.cid should not match a broken CIDv0 buffer', (done) => {
+    const actual = isIPFS.cid(new Buffer('QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE70'))
+    expect(actual).to.equal(false)
+    done()
+  })
+
+  it('isIPFS.cid should not match an invalid CIDv0 (multihash with a typo)', (done) => {
+    const actual = isIPFS.cid('QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE70')
+    expect(actual).to.equal(false)
+    done()
+  })
+
+  it('isIPFS.cid should match a valid CIDv1', (done) => {
+    const actual = isIPFS.cid('zdj7WWeQ43G6JJvLWQWZpyHuAMq6uYWRjkBXFad11vE2LHhQ7')
+    expect(actual).to.equal(true)
+    done()
+  })
+
+  it('isIPFS.cid should not match an invalid CIDv1 (with a typo)', (done) => {
+    const actual = isIPFS.cid('zdj7WWeQ43G6JJvLWQWZpyHuAMq6uYWRjkBXFad11vE2LHhQ')
+    expect(actual).to.equal(false)
+    done()
+  })
+
+  it('isIPFS.cid should not match an invalid CID', (done) => {
+    const actual = isIPFS.cid('noop')
+    expect(actual).to.equal(false)
+    done()
+  })
+
+  it('isIPFS.cid should not match an invalid CID data type', (done) => {
+    const actual = isIPFS.cid(4)
+    expect(actual).to.equal(false)
+    done()
+  })
+})