Merge pull request #74 from ipfs/awesome-ipld

Awesome IPLD endeavour

Author: daviddias

README.md

@@ -25,6 +25,14 @@ IPFS unixFS Engine
 - [Contribute](#contribute)
 - [License](#license)
 
+## BEWARE BEWARE BEWARE there might be 🐉
+
+This module has passed through several iterations and still is far from a nice and easy understandable codebase. Currently missing features:
+
+- tar importer
+- trickle dag exporter
+- sharding
+
 ## Install
 
 With [npm](https://npmjs.org/) installed, run

package.json

@@ -34,31 +34,33 @@
   },
   "homepage": "https://github.com/ipfs/js-ipfs-unixfs-engineg#readme",
   "devDependencies": {
-    "aegir": "^8.0.1",
+    "aegir": "^8.1.2",
     "buffer-loader": "0.0.1",
     "chai": "^3.5.0",
-    "fs-pull-blob-store": "^0.3.0",
+    "fs-pull-blob-store": "^0.4.1",
     "idb-pull-blob-store": "^0.5.1",
-    "ipfs-block-service": "^0.5.0",
-    "ipfs-repo": "^0.9.0",
+    "ipfs-block-service": "^0.6.0",
+    "ipfs-repo": "^0.10.0",
     "ncp": "^2.0.0",
     "pre-commit": "^1.1.3",
-    "pull-zip": "^2.0.0",
+    "pull-zip": "^2.0.1",
     "raw-loader": "^0.5.1",
     "rimraf": "^2.5.4",
     "run-series": "^1.1.4"
   },
   "dependencies": {
-    "ipfs-merkle-dag": "^0.7.0",
+    "cids": "^0.2.0",
     "ipfs-unixfs": "^0.1.4",
-    "is-ipfs": "^0.2.0",
+    "ipld-dag-pb": "^0.1.3",
+    "ipld-resolver": "^0.1.1",
+    "is-ipfs": "^0.2.1",
     "multihashes": "^0.2.2",
     "pull-block": "^1.0.2",
-    "pull-paramap": "^1.1.6",
+    "pull-paramap": "^1.2.0",
     "pull-pushable": "^2.0.1",
     "pull-stream": "^3.4.5",
     "pull-traverse": "^1.0.3",
-    "pull-write": "^1.1.0",
+    "pull-write": "^1.1.1",
     "run-parallel": "^1.1.6"
   },
   "contributors": [

src/chunker-fixed-size.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const pullBlock = require('pull-block')
+
+module.exports = (size) => {
+  return pullBlock(size, { zeroPadding: false })
+}

src/chunker/fixed-size.js

@@ -3,12 +3,13 @@
 const path = require('path')
 const pull = require('pull-stream')
 const paramap = require('pull-paramap')
+const CID = require('cids')
 
 const fileExporter = require('./file')
 const switchType = require('../util').switchType
 
 // Logic to export a unixfs directory.
-module.exports = (node, name, dagService) => {
+module.exports = (node, name, ipldResolver) => {
   // The algorithm below is as follows
   //
   // 1. Take all links from a given directory node
@@ -25,15 +26,15 @@ module.exports = (node, name, dagService) => {
       path: path.join(name, link.name),
       hash: link.hash
     })),
-    paramap((item, cb) => dagService.get(item.hash, (err, n) => {
+    paramap((item, cb) => ipldResolver.get(new CID(item.hash), (err, n) => {
       if (err) {
         return cb(err)
       }
 
       cb(null, switchType(
         n,
         () => pull.values([item]),
-        () => fileExporter(n, item.path, dagService)
+        () => fileExporter(n, item.path, ipldResolver)
       ))
     })),
     pull.flatten()

src/exporters/dir.js renamed to src/exporter/dir.js

@@ -2,11 +2,12 @@
 
 const traverse = require('pull-traverse')
 const UnixFS = require('ipfs-unixfs')
+const CID = require('cids')
 const pull = require('pull-stream')
 const paramap = require('pull-paramap')
 
 // Logic to export a single (possibly chunked) unixfs file.
-module.exports = (node, name, ds) => {
+module.exports = (node, name, ipldResolver) => {
   function getData (node) {
     try {
       const file = UnixFS.unmarshal(node.data)
@@ -19,7 +20,7 @@ module.exports = (node, name, ds) => {
   function visitor (node) {
     return pull(
       pull.values(node.links),
-      paramap((link, cb) => ds.get(link.hash, cb))
+      paramap((link, cb) => ipldResolver.get(new CID(link.hash), cb))
     )
   }
 

src/exporters/file.js renamed to src/exporter/file.js

@@ -2,37 +2,38 @@
 
 const traverse = require('pull-traverse')
 const pull = require('pull-stream')
+const CID = require('cids')
 
-const util = require('./util')
+const util = require('./../util')
 const switchType = util.switchType
 const cleanMultihash = util.cleanMultihash
 
-const dirExporter = require('./exporters/dir')
-const fileExporter = require('./exporters/file')
+const dirExporter = require('./dir')
+const fileExporter = require('./file')
 
-module.exports = (hash, dagService, options) => {
+module.exports = (hash, ipldResolver, options) => {
   hash = cleanMultihash(hash)
   options = options || {}
 
   function visitor (item) {
     return pull(
-      dagService.getStream(item.hash),
+      ipldResolver.getStream(new CID(item.hash)),
       pull.map((node) => switchType(
         node,
-        () => dirExporter(node, item.path, dagService),
-        () => fileExporter(node, item.path, dagService)
+        () => dirExporter(node, item.path, ipldResolver),
+        () => fileExporter(node, item.path, ipldResolver)
       )),
       pull.flatten()
     )
   }
 
   // Traverse the DAG
   return pull(
-    dagService.getStream(hash),
+    ipldResolver.getStream(new CID(hash)),
     pull.map((node) => switchType(
       node,
       () => traverse.widthFirst({path: hash, hash}, visitor),
-      () => fileExporter(node, hash, dagService)
+      () => fileExporter(node, hash, ipldResolver)
     )),
     pull.flatten()
   )