Binary resolver

src/index.js

@@ -23,6 +23,7 @@ const ipldEthStateTrie = require('ipld-eth-star').ethStateTrie
 const ipldEthStorageTrie = require('ipld-eth-star').ethStorageTrie
 const ipldEthTx = require('ipld-eth-star').ethTx
 const ipldEthTxTrie = require('ipld-eth-star').ethTxTrie
+const ipldBin = require('./ipldBin')
 
 function noop () {}
 
@@ -91,6 +92,10 @@ class IPLDResolver {
     this.support.add(ipldEthTxTrie.resolver.multicodec,
                      ipldEthTxTrie.resolver,
                      ipldEthTxTrie.util)
+
+    this.support.add(ipldBin.resolver.multicodec,
+                     ipldBin.resolver,
+                     ipldBin.util)
   }
 
   get (cid, path, options, callback) {

src/ipldBin.js

@@ -0,0 +1,29 @@
+'use strict'
+const CID = require('cids')
+
+// binary resolver
+module.exports = {
+  resolver: {
+    multicodec: 'base2',
+    resolve: (ipfsBlock, path, callback) => {
+      callback(null, {
+        value: ipfsBlock.data,
+        remainderPath: path
+      })
+    },
+    tree: (ipfsBlock, options, callback) => {
+      callback(null, [])
+    }
+  },
+  util: {
+    deserialize: (data, cb) => {
+      cb(null, data)
+    },
+    serialize: (data, cb) => {
+      cb(null, data)
+    },
+    cid: (data, cb) => {
+      cb(null, new CID(1, 'base2', data))
+    }
+  }
+}

test/browser.js

@@ -37,6 +37,7 @@ describe('Browser', () => {
     ], done)
   })
 
+  require('./ipld-bin')
   require('./basics')(repo)
   require('./ipld-dag-pb')(repo)
   require('./ipld-dag-cbor')(repo)

test/ipld-bin.js

@@ -0,0 +1,76 @@
+/* eslint-env mocha */
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+chai.use(dirtyChai)
+const IpfsBlock = require('ipfs-block')
+const CID = require('cids')
+const ipldBin = require('../src/ipldBin')
+
+module.exports = () => {
+  describe('IPLD Resolver with ipld-bin (binary resolver)', () => {
+    it('resolves an ipfsBlock to its data', (done) => {
+      const buffer = Buffer.from('deadbeef', 'hex')
+      const cid = new CID('zDvjKAA4iXx')
+      const ipfsBlock = new IpfsBlock(buffer, cid)
+      ipldBin.resolver.resolve(ipfsBlock, '/hello/world', (err, result) => {
+        expect(err).to.not.exist()
+        expect(result).to.exist()
+        expect(Buffer.isBuffer(result.value)).to.be.true()
+        expect(result.value.toString('hex')).to.be.eql('deadbeef')
+        expect(result.remainderPath).to.be.eql('/hello/world')
+        done()
+      })
+    })
+
+    it('trees an empty array', (done) => {
+      const buffer = Buffer.from('deadbeef', 'hex')
+      const cid = new CID('zDvjKAA4iXx')
+      const ipfsBlock = new IpfsBlock(buffer, cid)
+      ipldBin.resolver.tree(ipfsBlock, {}, (err, result) => {
+        expect(err).to.not.exist()
+        expect(result).to.exist()
+        expect(result.length).to.eql(0)
+        done()
+      })
+    })
+
+    it('creates a cid with the currect multicodec', (done) => {
+      const buffer = Buffer.from('deadbeef', 'hex')
+      // const cid = new CID('zDvjKAA4iXx')
+      // const ipfsBlock = new IpfsBlock(buffer, cid)
+      ipldBin.util.cid(buffer, (err, cid) => {
+        expect(err).to.not.exist()
+        expect(cid).to.exist()
+        expect(cid.codec).to.eql('base2')
+        done()
+      })
+    })
+
+    it('serializes to the same value', (done) => {
+      const buffer = Buffer.from('deadbeef', 'hex')
+      // const cid = new CID('zDvjKAA4iXx')
+      // const ipfsBlock = new IpfsBlock(buffer, cid)
+      ipldBin.util.serialize(buffer, (err, result) => {
+        expect(err).to.not.exist()
+        expect(result).to.exist()
+        expect(result.toString('hex')).to.eql(buffer.toString('hex'))
+        done()
+      })
+    })
+
+    it('deserializes to the same value', (done) => {
+      const buffer = Buffer.from('deadbeef', 'hex')
+      // const cid = new CID('zDvjKAA4iXx')
+      // const ipfsBlock = new IpfsBlock(buffer, cid)
+      ipldBin.util.deserialize(buffer, (err, result) => {
+        expect(err).to.not.exist()
+        expect(result).to.exist()
+        expect(result.toString('hex')).to.eql(buffer.toString('hex'))
+        done()
+      })
+    })
+  })
+}

test/node.js

@@ -26,6 +26,7 @@ describe('Node.js', () => {
     ], done)
   })
 
+  require('./ipld-bin')
   require('./basics')(repo)
   require('./ipld-dag-pb')(repo)
   require('./ipld-dag-cbor')(repo)