docs: updated examples to new api

.aegir.js

@@ -3,10 +3,12 @@
 const IPFSFactory = require('ipfsd-ctl')
 const MockPreloadNode = require('./test/utils/mock-preload-node')
 const EchoServer = require('interface-ipfs-core/src/utils/echo-http-server')
+const webRTCStarSigServer = require('libp2p-webrtc-star/src/sig-server')
 
 const ipfsdServer = IPFSFactory.createServer()
 const preloadNode = MockPreloadNode.createNode()
 const echoServer = EchoServer.createServer()
+let sigServer
 
 module.exports = {
   bundlesize: { maxSize: '652kB' },
@@ -42,11 +44,16 @@ module.exports = {
           await ipfsdServer.start()
           await preloadNode.start()
           await echoServer.start()
+          sigServer = await webRTCStarSigServer.start({
+            host: '127.0.0.1',
+            port: 14579
+          })
       },
       post: async () => {
           await ipfsdServer.stop()
           await preloadNode.stop()
           await echoServer.stop()
+          await sigServer.stop()
       }
     }
   }

.travis.yml

@@ -76,44 +76,24 @@ jobs:
     - stage: test
       name: interop - node
       script:
-        - mkdir -p node_modules/ipfs-interop/node_modules
-        - ln -s `pwd` node_modules/ipfs-interop/node_modules/ipfs
-        - export IPFS_JS_EXEC=`pwd`/src/cli/bin.js
-        - export IPFS_REUSEPORT=false
-        - cd node_modules/ipfs-interop
-        - npx aegir test -t node --bail
+        - npm run test:interop:node -- --bail
 
     - stage: test
       name: interop - browser
       script:
-        - mkdir -p node_modules/ipfs-interop/node_modules
-        - ln -s `pwd` node_modules/ipfs-interop/node_modules/ipfs
-        - export IPFS_JS_EXEC=`pwd`/src/cli/bin.js
-        - export IPFS_REUSEPORT=false
-        - cd node_modules/ipfs-interop
-        - npx aegir test -t browser --bail
+        - npm run test:interop:browser -- --bail
 
     - stage: test
       name: interop - electron-main
       os: osx
       script:
-        - mkdir -p node_modules/ipfs-interop/node_modules
-        - ln -s `pwd` node_modules/ipfs-interop/node_modules/ipfs
-        - export IPFS_JS_EXEC=`pwd`/src/cli/bin.js
-        - export IPFS_REUSEPORT=false
-        - cd node_modules/ipfs-interop
-        - npx aegir test -t electron-main -f ./test/node.js --bail --timeout 10000
+        - npm run test:interop:electron-main -- --bail --timeout 10000
 
     - stage: test
       name: interop - electron-renderer
       os: osx
       script:
-        - mkdir -p node_modules/ipfs-interop/node_modules
-        - ln -s `pwd` node_modules/ipfs-interop/node_modules/ipfs
-        - export IPFS_JS_EXEC=`pwd`/src/cli/bin.js
-        - export IPFS_REUSEPORT=false
-        - cd node_modules/ipfs-interop
-        - npx aegir test -t electron-renderer -f ./test/browser.js --bail --timeout 10000
+        - npm run test:interop:electron-renderer -- --bail --timeout 10000
 
     - stage: test
       name: external - ipfs-companion
@@ -128,7 +108,7 @@ jobs:
     - stage: test
       name: external - ipfs-pubsub-room
       script:
-        - npm run test:external -- ipfs-pubsub-room https://github.com/ipfs-shipyard/ipfs-pubsub-room.git --branch upgrade-to-latest-js-ipfs-rc
+        - npm run test:external -- ipfs-pubsub-room https://github.com/ipfs-shipyard/ipfs-pubsub-room.git
 
     - stage: test
       name: external - peer-base

README.md

@@ -30,7 +30,7 @@
   <br>
 </p>
 
-### Project status - `Alpha`
+### Project status - `Alpha` <!-- omit in toc -->
 
 We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..
 
@@ -40,19 +40,16 @@ We've come a long way, but this project is still in Alpha, lots of development i
 
 [**`Weekly Core Implementations Call`**](https://github.com/ipfs/team-mgmt/issues/992)
 
-## Tech Lead
+## Tech Lead <!-- omit in toc -->
 
 [David Dias](https://github.com/daviddias)
 
-## Lead Maintainer
+## Lead Maintainer <!-- omit in toc -->
 
 [Alan Shaw](https://github.com/alanshaw)
 
-## Table of Contents
+## Table of Contents <!-- omit in toc -->
 
-- [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)
@@ -66,6 +63,7 @@ We've come a long way, but this project is still in Alpha, lots of development i
   - [API](#api)
     - [IPFS Constructor](#ipfs-constructor)
       - [`options.repo`](#optionsrepo)
+      - [`options.repoAutoMigrate`](#optionsrepoautomigrate)
       - [`options.init`](#optionsinit)
       - [`options.start`](#optionsstart)
       - [`options.pass`](#optionspass)
@@ -1106,7 +1104,7 @@ Listing of the main packages used in the IPFS ecosystem. There are also three sp
 | [`ipfs-mfs`](//github.com/ipfs/js-ipfs-mfs) | [![npm](https://img.shields.io/npm/v/ipfs-mfs.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-mfs/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-mfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-mfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-mfs.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-mfs) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-mfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-mfs) | [Alex Potsides](mailto:alex.potsides@protocol.ai) |
 | [`ipfs-unixfs`](//github.com/ipfs/js-ipfs-unixfs) | [![npm](https://img.shields.io/npm/v/ipfs-unixfs.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-unixfs/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-unixfs) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-unixfs) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs) | [Alex Potsides](mailto:alex.potsides@protocol.ai) |
 | **Repo** |
-| [`ipfs-repo`](//github.com/ipfs/js-ipfs-repo) | [![npm](https://img.shields.io/npm/v/ipfs-repo.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-repo/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-repo.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-repo) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-repo) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-repo) | [Jacob Heun](mailto:jacobheun@gmail.com) |
+| [`ipfs-repo`](//github.com/ipfs/js-ipfs-repo) | [![npm](https://img.shields.io/npm/v/ipfs-repo.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-repo/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-repo.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-repo) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-repo.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-repo) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-repo/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-repo) | [Alex Potsides](mailto:alex.potsides@protocol.ai) |
 | **Exchange** |
 | [`ipfs-block-service`](//github.com/ipfs/js-ipfs-block-service) | [![npm](https://img.shields.io/npm/v/ipfs-block-service.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-block-service/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-block-service.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block-service) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block-service.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-block-service) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-block-service/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-block-service) | [Volker Mische](mailto:volker.mische@gmail.com) |
 | [`ipfs-block`](//github.com/ipfs/js-ipfs-block) | [![npm](https://img.shields.io/npm/v/ipfs-block.svg?maxAge=86400&style=flat-square)](//github.com/ipfs/js-ipfs-block/releases) | [![Deps](https://david-dm.org/ipfs/js-ipfs-block.svg?style=flat-square)](https://david-dm.org/ipfs/js-ipfs-block) | [![Travis CI](https://flat.badgen.net/travis/ipfs/js-ipfs-block.svg?branch=master)](https://travis-ci.com/ipfs/js-ipfs-block) | [![codecov](https://codecov.io/gh/ipfs/js-ipfs-block/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-block) | [Volker Mische](mailto:volker.mische@gmail.com) |

examples/browser-video-streaming/index.html

@@ -2,7 +2,11 @@
   <body>
     <video id="video" controls></video>
     <script src="../../dist/index.js"></script>
+    <!--
+      TODO: uncomment once https://github.com/ipfs/js-ipfs/pull/2683 and
+      https://github.com/moshisushi/hlsjs-ipfs-loader/pull/16 are released
     <script src="https://unpkg.com/hlsjs-ipfs-loader@0.1.4/dist/index.js"></script>
+    -->
     <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
     <script src="streaming.js"></script>
   </body>

examples/browser-video-streaming/streaming.js

@@ -2,7 +2,6 @@
 
 /* global Hls Ipfs HlsjsIpfsLoader */
 /* eslint-env browser */
-
 document.addEventListener('DOMContentLoaded', async () => {
   const testHash = 'QmdpAidwAsBGptFB3b6A9Pyi5coEbgjHrL3K2Qrsutmj9K'
   const repoPath = 'ipfs-' + Math.random()
@@ -20,3 +19,145 @@ document.addEventListener('DOMContentLoaded', async () => {
     hls.on(Hls.Events.MANIFEST_PARSED, () => video.play())
   }
 })
+
+// TODO: remove everything below here once https://github.com/ipfs/js-ipfs/pull/2683
+// and https://github.com/moshisushi/hlsjs-ipfs-loader/pull/16 are released
+
+class HlsjsIpfsLoader {
+  constructor(config) {
+    this.ipfs = config.ipfs
+    this.hash = config.ipfsHash
+    if (config.debug === false) {
+      this.debug = function() {}
+    } else if (config.debug === true) {
+      this.debug = console.log
+    } else {
+      this.debug = config.debug
+    }
+    if(config.m3u8provider) {
+      this.m3u8provider = config.m3u8provider;
+    } else {
+      this.m3u8provider = null;
+    }
+    if(config.tsListProvider) {
+      this.tsListProvider = config.tsListProvider;
+    } else {
+      this.tsListProvider = null;
+    }
+  }
+
+  destroy() {
+  }
+
+  abort() {
+  }
+
+  load(context, config, callbacks) {
+    this.context = context
+    this.config = config
+    this.callbacks = callbacks
+    this.stats = { trequest: performance.now(), retry: 0 }
+    this.retryDelay = config.retryDelay
+    this.loadInternal()
+  }
+  /**
+   * Call this by getting the HLSIPFSLoader instance from hls.js hls.coreComponents[0].loaders.manifest.setM3U8Provider()
+   * @param {function} provider
+   */
+  setM3U8Provider(provider) {
+    this.m3u8provider = provider;
+  }
+  /**
+   *
+   * @param {function} provider
+   */
+  setTsListProvider(provider) {
+    this.tsListProvider = provider;
+  }
+
+  loadInternal() {
+    const { stats, context, callbacks } = this
+
+    stats.tfirst = Math.max(performance.now(), stats.trequest)
+    stats.loaded = 0
+
+    const urlParts = context.url.split("/")
+    const filename = urlParts[urlParts.length - 1]
+
+    if(filename.split(".")[1] === "m3u8" && this.m3u8provider !== null) {
+      const res = this.m3u8provider();
+      let data;
+      if(Buffer.isBuffer(res)) {
+        data = buf2str(res)
+      } else {
+        data = res;
+      }
+      const response = { url: context.url, data: data }
+      callbacks.onSuccess(response, stats, context)
+      return;
+    }
+    if(filename.split(".")[1] === "m3u8" && this.tsListProvider !== null) {
+      var tslist = this.tsListProvider();
+      var hash = tslist[filename];
+      if(hash) {
+        this.cat(hash).then(res => {
+          let data;
+          if(Buffer.isBuffer(res)) {
+            data = buf2str(res)
+          } else {
+            data = res;
+          }
+          stats.loaded = stats.total = data.length
+          stats.tload = Math.max(stats.tfirst, performance.now())
+          const response = { url: context.url, data: data }
+          callbacks.onSuccess(response, stats, context)
+        });
+      }
+      return;
+    }
+    getFile(this.ipfs, this.hash, filename, this.debug).then(res => {
+      const data = (context.responseType === 'arraybuffer') ? res : buf2str(res)
+      stats.loaded = stats.total = data.length
+      stats.tload = Math.max(stats.tfirst, performance.now())
+      const response = { url: context.url, data: data }
+      callbacks.onSuccess(response, stats, context)
+    }, console.error)
+  }
+}
+
+async function getFile(ipfs, rootHash, filename, debug) {
+  debug(`Fetching hash for '${rootHash}/${filename}'`)
+  if(filename === null) {
+    return cat(rootHash, ipfs, debug)
+  }
+
+  for await (const link of ipfs.ls(rootHash)) {
+    if (link.name !== filename) {
+      continue
+    }
+
+    debug(`Requesting '${link.path}'`)
+
+    return cat(link.cid, ipfs, debug)
+  }
+
+  throw new Error(`File not found: ${rootHash}/${filename}`)
+}
+
+function buf2str(buf) {
+  return String.fromCharCode.apply(null, new Uint8Array(buf))
+}
+
+async function cat (cid, ipfs, debug) {
+  let value = new Uint8Array(0)
+
+  for await (const buf of ipfs.cat(cid)) {
+    const newBuf = new Uint8Array(value.length + buf.length)
+    newBuf.set(value)
+    newBuf.set(buf, value.length)
+    value = newBuf
+  }
+
+  debug(`Received data for file '${cid}' size: ${value.length}`)
+  return value
+}

examples/circuit-relaying/package.json

@@ -15,7 +15,7 @@
   "license": "MIT",
   "dependencies": {
     "ipfs": "file:../../",
-    "ipfs-pubsub-room": "^1.4.0"
+    "ipfs-pubsub-room": "^2.0.1"
   },
   "devDependencies": {
     "aegir": "^20.0.0",

examples/circuit-relaying/src/helpers.js

@@ -15,7 +15,7 @@ const mkRoomName = (name) => {
 
 module.exports = (ipfs, peersSet) => {
   const createRoom = (name) => {
-    const room = Room(ipfs, mkRoomName(name))
+    const room = new Room(ipfs, mkRoomName(name))
 
     room.on('peer joined', (peer) => {
       console.log('peer ' + peer + ' joined')

examples/circuit-relaying/test.js

@@ -66,7 +66,9 @@ async function runTest () {
 
   try {
     const id = await ipfsd.api.id()
-    const address = id.addresses.filter(addr => addr.includes('/ws/ipfs/Qm')).pop()
+    const address = id.addresses
+      .map(ma => ma.toString())
+      .find(addr => addr.includes('/ws/p2p/Qm'))
 
     if (!address) {
       throw new Error(`Could not find web socket address in ${id.addresses}`)

examples/custom-ipfs-repo/index.js

@@ -3,6 +3,7 @@
 const IPFS = require('ipfs')
 const Repo = require('ipfs-repo')
 const fsLock = require('ipfs-repo/src/lock')
+const all = require('it-all')
 
 // Create our custom options
 const customRepositoryOptions = {
@@ -79,19 +80,19 @@ async function main () {
   console.log('Version:', version)
 
   // Once we have the version, let's add a file to IPFS
-  const filesAdded = await node.add({
+  for await (const file of node.add({
     path: 'test-data.txt',
     content: Buffer.from('We are using a customized repo!')
-  })
-
-  // Log out the added files metadata and cat the file from IPFS
-  console.log('\nAdded file:', filesAdded[0].path, filesAdded[0].hash)
+  })) {
+    // Log out the added files metadata and cat the file from IPFS
+    console.log('\nAdded file:', file.path, file.cid)
 
-  const data = await node.cat(filesAdded[0].hash)
+    const data = Buffer.concat(await all(node.cat(file.cid)))
 
-  // Print out the files contents to console
-  console.log('\nFetched file content:')
-  process.stdout.write(data)
+    // Print out the files contents to console
+    console.log('\nFetched file content:')
+    process.stdout.write(data)
+  }
 
   // After everything is done, shut the node down
   console.log('\n\nStopping the node')

examples/custom-ipfs-repo/package.json

@@ -11,7 +11,8 @@
   "dependencies": {
     "datastore-fs": "^0.9.1",
     "ipfs": "file:../../",
-    "ipfs-repo": "^0.28.0"
+    "ipfs-repo": "^0.28.0",
+    "it-all": "^1.0.1"
   },
   "devDependencies": {
     "execa": "^3.2.0"