Merge branch 'release/v0.38.x'

CHANGELOG.md

@@ -1,3 +1,61 @@
+<a name="0.38.0"></a>
+# [0.38.0](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.6...v0.38.0) (2019-09-30)
+
+
+
+<a name="0.38.0-rc.6"></a>
+# [0.38.0-rc.6](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.5...v0.38.0-rc.6) (2019-09-25)
+
+
+
+<a name="0.38.0-rc.5"></a>
+# [0.38.0-rc.5](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.4...v0.38.0-rc.5) (2019-09-18)
+
+
+
+<a name="0.38.0-rc.4"></a>
+# [0.38.0-rc.4](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.3...v0.38.0-rc.4) (2019-09-17)
+
+
+
+<a name="0.38.0-rc.3"></a>
+# [0.38.0-rc.3](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.2...v0.38.0-rc.3) (2019-09-17)
+
+
+
+<a name="0.38.0-rc.2"></a>
+# [0.38.0-rc.2](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.1...v0.38.0-rc.2) (2019-09-16)
+
+
+
+# [0.38.0-rc.1](https://github.com/ipfs/js-ipfs/compare/v0.38.0-rc.0...v0.38.0-rc.1) (2019-09-13)
+
+
+
+<a name="0.38.0-rc.0"></a>
+# [0.38.0-rc.0](https://github.com/ipfs/js-ipfs/compare/v0.38.0-pre.1...v0.38.0-rc.0) (2019-09-09)
+
+
+### Bug Fixes
+
+* **tests:** remove Math.random from  tests ([#2431](https://github.com/ipfs/js-ipfs/issues/2431)) ([60bf020](https://github.com/ipfs/js-ipfs/commit/60bf020))
+
+
+### Features
+
+* add support for ipns and recursive to ipfs resolve ([#2297](https://github.com/ipfs/js-ipfs/issues/2297)) ([039675e](https://github.com/ipfs/js-ipfs/commit/039675e))
+* enable pubsub via config file and enabled by default ([#2427](https://github.com/ipfs/js-ipfs/issues/2427)) ([27751cf](https://github.com/ipfs/js-ipfs/commit/27751cf)), closes [ipfs/js-ipfsd-ctl#366](https://github.com/ipfs/js-ipfsd-ctl/issues/366) [ipfs/go-ipfs#6621](https://github.com/ipfs/go-ipfs/issues/6621)
+* support adding async iterators ([#2379](https://github.com/ipfs/js-ipfs/issues/2379)) ([3878f0f](https://github.com/ipfs/js-ipfs/commit/3878f0f))
+* web ui 2.5.1 ([#2434](https://github.com/ipfs/js-ipfs/issues/2434)) ([39ef553](https://github.com/ipfs/js-ipfs/commit/39ef553))
+
+
+### BREAKING CHANGES
+
+* pubsub is now enabled by default and the experimental flag was removed
+* `recursive` is now `true` by default in `ipfs resolve`
+
+
+
 <a name="0.38.0-pre.1"></a>
 # [0.38.0-pre.1](https://github.com/ipfs/js-ipfs/compare/v0.38.0-pre.0...v0.38.0-pre.1) (2019-09-02)
 

README.md

@@ -48,6 +48,9 @@ We've come a long way, but this project is still in Alpha, lots of development i
 
 ## Table of Contents
 
+- [Tech Lead](#tech-lead)
+- [Lead Maintainer](#lead-maintainer)
+- [Table of Contents](#table-of-contents)
 - [Install](#install)
   - [npm](#npm)
   - [Use in Node.js](#use-in-nodejs)
@@ -56,30 +59,58 @@ We've come a long way, but this project is still in Alpha, lots of development i
 - [Usage](#usage)
   - [IPFS CLI](#ipfs-cli)
   - [IPFS Daemon](#ipfs-daemon)
-  - [IPFS Module (use IPFS as a module in Node.js or in the Browser)](#ipfs-module)
+  - [IPFS Module](#ipfs-module)
   - [Tutorials and Examples](#tutorials-and-examples)
-  - [API Docs](#api)
-    - [Constructor](#ipfs-constructor)
+  - [API](#api)
+    - [IPFS Constructor](#ipfs-constructor)
+      - [`options.repo`](#optionsrepo)
+      - [`options.init`](#optionsinit)
+      - [`options.start`](#optionsstart)
+      - [`options.pass`](#optionspass)
+      - [`options.silent`](#optionssilent)
+      - [`options.relay`](#optionsrelay)
+      - [`options.preload`](#optionspreload)
+      - [`options.EXPERIMENTAL`](#optionsexperimental)
+      - [`options.config`](#optionsconfig)
+        - [Configuring Delegate Routers](#configuring-delegate-routers)
+      - [`options.ipld`](#optionsipld)
+      - [`options.libp2p`](#optionslibp2p)
+      - [`options.connectionManager`](#optionsconnectionmanager)
     - [Events](#events)
-    - [ready](#nodeready)
-    - [start](#nodestart)
-    - [stop](#nodestop)
+    - [`node.ready`](#nodeready)
+    - [`node.start()`](#nodestart)
+    - [`node.stop()`](#nodestop)
     - [Core API](#core-api)
-      - [Files](#files)
-      - [Graph](#graph)
-      - [Name](#name)
-      - [Crypto and Key Management](#crypto-and-key-management)
-      - [Network](#network)
-      - [Node Management](#node-management)
+    - [Files](#files)
+    - [Graph](#graph)
+    - [Block](#block)
+    - [Name](#name)
+    - [Crypto and Key Management](#crypto-and-key-management)
+    - [Network](#network)
+    - [Node Management](#node-management)
     - [Static types and utils](#static-types-and-utils)
 - [FAQ](#faq)
+    - [How to enable WebRTC support for js-ipfs in the Browser](#how-to-enable-webrtc-support-for-js-ipfs-in-the-browser)
+    - [Is there WebRTC support for js-ipfs with Node.js?](#is-there-webrtc-support-for-js-ipfs-with-nodejs)
+    - [How can I configure an IPFS node to use a custom `signaling endpoint` for my WebRTC transport?](#how-can-i-configure-an-ipfs-node-to-use-a-custom-signaling-endpoint-for-my-webrtc-transport)
+    - [Is there a more stable alternative to webrtc-star that offers a similar functionality?](#is-there-a-more-stable-alternative-to-webrtc-star-that-offers-a-similar-functionality)
+    - [I see some slowness when hopping between tabs Chrome with IPFS nodes, is there a reason why?](#i-see-some-slowness-when-hopping-between-tabs-chrome-with-ipfs-nodes-is-there-a-reason-why)
+    - [Can I use IPFS in my Electron App?](#can-i-use-ipfs-in-my-electron-app)
+    - [Have more questions?](#have-more-questions)
 - [Running js-ipfs with Docker](#running-js-ipfs-with-docker)
 - [Packages](#packages)
 - [Development](#development)
   - [Clone and install dependencies](#clone-and-install-dependencies)
-  - [Run Tests](#run-tests)
+  - [Run tests](#run-tests)
+  - [Run interop tests](#run-interop-tests)
+  - [Run benchmark tests](#run-benchmark-tests)
   - [Lint](#lint)
   - [Build a dist version](#build-a-dist-version)
+  - [Runtime Support](#runtime-support)
+  - [Code Architecture and folder Structure](#code-architecture-and-folder-structure)
+      - [Source code](#source-code)
+  - [Monitoring](#monitoring)
+  - [IPFS Architecture](#ipfs-architecture)
 - [Contribute](#contribute)
   - [Want to hack on IPFS?](#want-to-hack-on-ipfs)
 - [License](#license)
@@ -827,7 +858,7 @@ The core API is grouped into several areas:
   - `ipfs.repo.init`
   - [`ipfs.repo.stat([options])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#repostat)
   - [`ipfs.repo.version()`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/REPO.md#repoversion)
-  - `ipfs.repo.gc([options])` (not implemented yet)
+  - [`ipfs.repo.gc([options])`](https://github.com/ipfs/interface-js-ipfs-core/blob/master/SPEC/REPO.md#repogc)
 
 - [stats](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md)
   - [`ipfs.stats.bitswap()`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/STATS.md#statsbitswap)
@@ -1125,7 +1156,14 @@ Listing of the main packages used in the IPFS ecosystem. There are also three sp
 
 ### Run interop tests
 
-Run the interop tests with https://github.com/ipfs/interop
+
+```sh
+# run the interop tests with the default go-IPFS
+> npm run test:interop
+
+# run the interop tests with a different go-IPFS
+> IPFS_EXEC_GO=/path/to/ipfs npm run test:interop
+```
 
 ### Run benchmark tests
 

examples/browser-add-readable-stream/index.js

@@ -3,8 +3,6 @@
 /* global Ipfs */
 /* eslint-env browser */
 
-const { Buffer } = Ipfs
-
 const main = async () => {
   const repoPath = `ipfs-${Math.random()}`
   const ipfs = await Ipfs.create({ repo: repoPath })
@@ -29,14 +27,14 @@ const createFiles = (directory) => {
   return [{
     path: `${directory}/file1.txt`,
 
-    // content could be a stream, a url etc
-    content: Buffer.from('one', 'utf8')
+    // content could be a stream, a url, a Buffer, a File etc
+    content: 'one'
   }, {
     path: `${directory}/file2.txt`,
-    content: Buffer.from('two', 'utf8')
+    content: 'two'
   }, {
     path: `${directory}/file3.txt`,
-    content: Buffer.from('three', 'utf8')
+    content: 'three'
   }]
 }
 

examples/browser-browserify/src/index.js

@@ -10,7 +10,7 @@ document.addEventListener('DOMContentLoaded', async () => {
   async function store () {
     const toStore = document.getElementById('source').value
 
-    const res = await node.add(Buffer.from(toStore))
+    const res = await node.add(toStore)
 
     res.forEach((file) => {
       if (file && file.hash) {

examples/browser-create-react-app/package.json

@@ -8,7 +8,7 @@
     "ipfs-css": "^0.13.1",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
-    "react-scripts": "3.0.1",
+    "react-scripts": "3.1.1",
     "tachyons": "^4.11.1"
   },
   "scripts": {

examples/browser-create-react-app/src/hooks/use-ipfs-factory.js

@@ -29,7 +29,7 @@ export default function useIpfsFactory ({ commands }) {
         setIpfsReady(false)
       }
     }
-  }, [])
+  })
 
   async function startIpfs () {
     if (ipfs) {

examples/browser-parceljs/public/index.js

@@ -24,7 +24,7 @@ document.addEventListener('DOMContentLoaded', async () => {
 
   const filesAdded = await node.add({
     path: 'hello-parcel.txt',
-    content: Buffer.from('Hello from parcel.js bundled ipfs example')
+    content: 'Hello from parcel.js bundled ipfs example'
   })
 
   log(`This page deployed ${filesAdded[0].path} to IPFS and its hash is ${filesAdded[0].hash}`)

examples/browser-script-tag/index.html

@@ -30,10 +30,8 @@ <h2>Some suggestions</h2>
   <p>Try adding a new file:</p>
 
   <code style="display:block; white-space:pre-wrap; background-color:#d7d6d6">
-    const { Buffer } = Ipfs
-
     async function addFile () {
-      const filesAdded = await node.add(Buffer.from('Hello world!'))
+      const filesAdded = await node.add('Hello world!')
       filesAdded.forEach((file) => console.log('successfully stored', file.hash))
     }
 

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

@@ -30,7 +30,7 @@ class App extends React.Component {
 
     this.setState({ id, agentVersion, protocolVersion })
 
-    const [{ hash }] = await node.add(Buffer.from(stringToUse))
+    const [{ hash }] = await node.add(stringToUse)
     this.setState({ addedFileHash: hash })
 
     const data = await node.cat(hash)

examples/exchange-files-in-browser/public/app.js

@@ -44,9 +44,6 @@ let info
 async function start () {
   if (!node) {
     const options = {
-      pubsub: {
-        enabled: true
-      },
       repo: 'ipfs-' + Math.random(),
       config: {
         Addresses: {

examples/explore-ethereum-blockchain/README.md

@@ -22,16 +22,16 @@ We've some ethereum blocks available at [eth-stuffs](./eth-stuffs) folder, you c
 
 ```sh
 > ./load-eth-stuffs.sh
-z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW
-z43AaGEywSDX5PUJcrn5GfZmb6FjisJyR7uahhWPk456f7k7LDA
-z43AaGF42R2DXsU65bNnHRCypLPr9sg6D7CUws5raiqATVaB1jj
-z45oqTS2AQ9SgyVa31LRGZgfibtdoPvP2miMNaXbDLLgD9MdAAr
-z45oqTS8wZaNGU2eepKHRbXvmV93cKQbiL241RB3bRtMYZP8hNm
-z45oqTS8wZaNGU2eepKHRbXvmV93cKQbiL241RB3bRtMYZP8hNm
-z45oqTS4E1GeJujnKVJG3xSVnS64A8mMCWhKSkCWACNCeD95mtQ
-z45oqTS4MnurEeEaanvFieeJDNHH3jGNk9NJEiyrwXwYQSWfxUB
-z45oqTRwExySeMeivsU1Y9UdzWDp2mx71TtQhmTGzRaXCcsNujj
-z45oqTRzb9a5xyvx5RbfSXH1K5jibyZ4AxnXyYReuLw7KU5veYw
+bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq
+bagiacgzanm7fiqpp7zcfehhd7apxpo4stdxx7wxn7eqrsgolj76t22dintgq
+bagiacgzau7z2cpinv6u3rnsa73ssc46cpongn7zh6ztjwo7hh7ao42cj4lha
+baglacgzaoc2jzhhxe6psrvq4ixlykpky2a23e3ltnhqpjrji3uyg6rnulxpq
+baglacgza2vwiqlrqgkz5jdpkzmkqznntozcnnoycn4swddtxi7njcjsmfpda
+baglacgza2vwiqlrqgkz5jdpkzmkqznntozcnnoycn4swddtxi7njcjsmfpda
+baglacgzar5mhc23wfjccxfkpf23kbufqqjsqg4t7btaocaraycwlxbaerq2q
+baglacgzasflr3hpssk5fpdheemyogi4df2zatql5z3pp7izau7d37ryijgca
+baglacgzae6kz4xubhfygknh7yqk2fbk4xztmnvwkwm36knjwukmyfepjveda
+baglacgzalfkeokwk7nvwenmr2k3e3f6khvch2bw54nhr25vjmjy2lshmx5mas
 ```
 
 ## Explore these blocks using the DAG API
@@ -41,7 +41,7 @@ NOTE: Currently your js-ipfs daemon must NOT be running for the following exampl
 Some examples
 
 ```sh
-> jsipfs dag get z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW/
-> jsipfs dag get z43AaGEvwdfzjrCZ3Sq7DKxdDHrwoaPQDtqF4jfdkNEVTiqGVFW/parentHash
+> jsipfs dag get bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq/
+> jsipfs dag get bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq/parentHash
 ...
 ```

examples/ipfs-101/README.md

@@ -57,7 +57,7 @@ async function main () {
 
   const filesAdded = await node.add({
     path: 'hello.txt',
-    content: Buffer.from('Hello World 101')
+    content: 'Hello World 101'
   })
 
   console.log('Added file:', filesAdded[0].path, filesAdded[0].hash)
@@ -91,7 +91,7 @@ async function main () {
 
   const filesAdded = await node.add({
     path: 'hello.txt',
-    content: Buffer.from('Hello World 101')
+    content: 'Hello World 101'
   })
 
   console.log('Added file:', filesAdded[0].path, filesAdded[0].hash)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs",
-  "version": "0.38.0-pre.1",
+  "version": "0.38.0",
   "description": "JavaScript implementation of the IPFS specification",
   "keywords": [
     "IPFS"
@@ -230,7 +230,6 @@
     "Alan Shaw <[email protected]>",
     "Alan Shaw <[email protected]>",
     "Alex North <[email protected]>",
-    "Alex Potsides <[email protected]>",
     "Andrew Nesbitt <[email protected]>",
     "Andrew de Andrade <[email protected]>",
     "André Cruz <[email protected]>",
@@ -332,6 +331,7 @@
     "Xiao Liang <[email protected]>",
     "Yahya <[email protected]>",
     "Yole <[email protected]>",
+    "achingbrain <[email protected]>",
     "bitspill <[email protected]>",
     "datafatmunger <[email protected]>",
     "dirkmc <[email protected]>",