Merge branch 'master' into feat/add-bootstrapers-through-dns

Author: daviddias

README.md

@@ -200,7 +200,12 @@ The HTTP-API exposed by the js-ipfs daemon follows the [`http-api-spec`](https:/
 const repo = <IPFS Repo instance or repo path>
 
 // Create the IPFS node instance
-const node = new IPFS(repo)
+const node = new IPFS({
+  repo: repo,
+  EXPERIMENTAL: {
+    pubsub: false
+  }
+})
 
 // We need to init our repo, in this case the repo was empty
 // We are picking 2048 bits for the RSA key that will be our PeerId

RELEASE.md

@@ -0,0 +1,21 @@
+# Release checklist
+
+> List of actions to perform before issuing a new js-ipfs release
+
+- Robustness and quality
+  - [ ] Ensure that all tests are passing, this includes:
+    - [ ] unit
+    - [ ] interop
+    - [ ] sharness
+  - [ ] Run tests of the following projects with the new release:
+    - [ ] orbitdb
+    - [ ] orbit-core
+    - [ ] ipfs-log
+- Documentation
+  - [ ] Ensure that README.md is up to date
+  - [ ] Ensure that all the examples run
+- Communication
+  - [ ] Create the release issue
+  - [ ] Announcements (both pre-release and post-release)
+    - [ ] Twitter
+    - [ ] IRC

ci/Dockerfile

@@ -0,0 +1 @@
+FROM quay.io/ipfs/js-base:6.9.4

ci/jenkins

@@ -0,0 +1 @@
+javascript

examples/README.md

@@ -9,5 +9,6 @@ Let us know if you find any issue or if you want to contribute and add a new tut
 - [js-ipfs basic, how to spawn a node and add a file to IPFS](/examples)
 - [How to bundle js-ipfs with Browserify](/bundle-browserify)
 - [How to bundle js-ipfs with WebPack](/bundle-webpack)
+- [Use IPFS to explore the Ethereum BlockChain](/explore-ethereum)
 
 ## Tutorials

examples/basics/index.js

@@ -12,7 +12,12 @@ const IPFS = require('../../src/core')
 /*
  * Create a new IPFS instance, using default repo (fs) on default path (~/.ipfs)
  */
-const node = new IPFS(path.join(os.tmpDir() + '/' + new Date().toString()))
+const node = new IPFS({
+  repo: path.join(os.tmpdir() + '/' + new Date().toString()),
+  EXPERIMENTAL: {
+    pubsub: false
+  }
+})
 
 const fileToAdd = {
   path: 'hello.txt',

examples/bundle-browserify/package.json

@@ -4,18 +4,15 @@
   "description": "Bundle js-ipfs with Browserify",
   "main": "index.js",
   "scripts": {
-    "bundle": "browserify src/index.js > public/bundle.js",
+    "bundle": "browserify src/index.js --require browserify-zlib-next:zlib  > public/bundle.js",
     "serve": "http-server public -a 127.0.0.1 -p 8888",
     "start": "npm run bundle && npm run serve"
   },
-  "browser": {
-    "zlib": "browserify-zlib-next"
-  },
   "keywords": [],
   "license": "MIT",
   "devDependencies": {
-    "browserify": "^13.1.1",
-    "concat-stream": "^1.5.2",
+    "browserify": "^14.0.0",
+    "concat-stream": "^1.6.0",
     "http-server": "^0.9.0",
     "browserify-zlib-next": "^1.0.1"
   },

examples/bundle-browserify/src/index.js

@@ -1,14 +1,23 @@
 'use strict'
 
-var IPFS = require('../../../src/core') // replace this by line below
+const concat = require('concat-stream')
+const IPFS = require('../../../src/core') // replace this by line below
 // var IPFS = require('ipfs')
 
 // Create the IPFS node instance
 // for simplicity, we create a new repo everytime the node
 // is created, because you can't init already existing repos
 const repoPath = String(Math.random())
-const node = new IPFS(repoPath)
-const concat = require('concat-stream')
+
+const node = new IPFS({
+  repo: repoPath,
+  EXPERIMENTAL: {
+    pubsub: false
+  }
+})
+
+// expose the node to the window, for the fun!
+window.ipfs = node
 
 node.init({ emptyRepo: true, bits: 2048 }, function (err) {
   if (err) {

examples/bundle-webpack/src/components/app.js

@@ -29,7 +29,12 @@ class App extends React.Component {
       // for simplicity, we create a new repo everytime the node
       // is created, because you can't init already existing repos
       const repoPath = String(Math.random())
-      node = new IPFS(repoPath)
+      node = new IPFS({
+        repo: repoPath,
+        EXPERIMENTAL: {
+          pubsub: false
+        }
+      })
 
       node.init({ emptyRepo: true, bits: 2048 }, function (err) {
         if (err) {

examples/explore-ethereum/README.md

@@ -0,0 +1,45 @@
+# Resolve the ethereum blockchain through IPFS
+
+> This is a pre-example to a full Ethereum to IPFS bridge. It shows how to resolve Ethereum hashes through the IPFS DAG get API.
+
+## Set up
+
+Make sure to have the latest js-ipfs installed by doing
+
+```sh
+> npm install ipfs -g
+```
+
+If this is the first time you use js-ipfs, make sure to init your repo with
+
+```sh
+> jsipfs init
+```
+
+## Load ethereum chain data into ipfs
+
+We've some ethereum blocks available at [eth-stuffs](/eth-stuffs) folder, you can add them to ipfs by running:
+
+```sh
+> ./load-eth-stuffs.sh
+z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW
+z43AaGEywSDX5PUJcrn5GfZmb6FjisJyR7uahhWPk456f7k7LDA
+z43AaGF42R2DXsU65bNnHRCypLPr9sg6D7CUws5raiqATVaB1jj
+z45oqTS2AQ9SgyVa31LRGZgfibtdoPvP2miMNaXbDLLgD9MdAAr
+z45oqTS8wZaNGU2eepKHRbXvmV93cKQbiL241RB3bRtMYZP8hNm
+z45oqTS8wZaNGU2eepKHRbXvmV93cKQbiL241RB3bRtMYZP8hNm
+z45oqTS4E1GeJujnKVJG3xSVnS64A8mMCWhKSkCWACNCeD95mtQ
+z45oqTS4MnurEeEaanvFieeJDNHH3jGNk9NJEiyrwXwYQSWfxUB
+z45oqTRwExySeMeivsU1Y9UdzWDp2mx71TtQhmTGzRaXCcsNujj
+z45oqTRzb9a5xyvx5RbfSXH1K5jibyZ4AxnXyYReuLw7KU5veYw
+```
+
+## Explore these blocks using the DAG api
+
+Some examples
+
+```sh
+> jsipfs dag get z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW/
+> jsipfs dag get z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW/parentHash
+...
+```