docs: update chat example and add info to its readme

docs: update echo example
docs: update libp2p in browser example
docs: update pubsub example
docs: update peer and content routing examples
docs: update discovery mechanisms example
docs: update encrypted comms example
docs: update protocol and stream muxing example

Author: jacobheun

examples/chat/README.md

@@ -1 +1,13 @@
 # Chat example with libp2p
+
+This example creates a simple chat app in your terminal.
+
+## Setup
+1. Install the modules, `npm install`.
+2. Open 2 terminal windows in the `./src` directory.
+
+## Running
+1. Run the listener in window 1, `node listener.js`
+2. Run the dialer in window 2, `node dialer.js`
+3. Type a message in either window and hit _enter_
+4. Tell youself secrets to your hearts content!

examples/chat/src/dialer.js

@@ -31,7 +31,9 @@ async.parallel([
   if (err) throw err
   const peerDialer = new PeerInfo(ids[0])
   peerDialer.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-  const nodeDialer = new Node(peerDialer)
+  const nodeDialer = new Node({
+    peerInfo: peerDialer
+  })
 
   const peerListener = new PeerInfo(ids[1])
   idListener = ids[1]

examples/chat/src/libp2p-bundle.js

@@ -3,11 +3,12 @@
 const TCP = require('libp2p-tcp')
 const MulticastDNS = require('libp2p-mdns')
 const WS = require('libp2p-websockets')
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-railing')
 const spdy = require('libp2p-spdy')
 const KadDHT = require('libp2p-kad-dht')
 const mplex = require('libp2p-mplex')
 const secio = require('libp2p-secio')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 const libp2p = require('../../..')
 
 function mapMuxers (list) {
@@ -36,44 +37,40 @@ function getMuxers (muxers) {
 }
 
 class Node extends libp2p {
-  constructor (peerInfo, peerBook, options) {
-    options = options || {}
-
-    const modules = {
-      transport: [
-        new TCP(),
-        new WS()
-      ],
-      connection: {
-        muxer: getMuxers(options.muxer),
-        crypto: [ secio ]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [
+          TCP,
+          WS
+        ],
+        streamMuxer: getMuxers(_options.muxer),
+        connEncryption: [ secio ],
+        peerDiscovery: [
+          MulticastDNS,
+          Bootstrap
+        ],
+        dht: KadDHT
       },
-      discovery: []
-    }
-
-    if (options.dht) {
-      modules.DHT = KadDHT
-    }
-
-    if (options.mdns) {
-      const mdns = new MulticastDNS(peerInfo, 'ipfs.local')
-      modules.discovery.push(mdns)
-    }
-
-    if (options.bootstrap) {
-      const r = new Railing(options.bootstrap)
-      modules.discovery.push(r)
-    }
-
-    if (options.modules && options.modules.transport) {
-      options.modules.transport.forEach((t) => modules.transport.push(t))
-    }
-
-    if (options.modules && options.modules.discovery) {
-      options.modules.discovery.forEach((d) => modules.discovery.push(d))
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 10000,
+            enabled: false
+          },
+          bootstrap: {
+            interval: 10000,
+            enabled: false,
+            list: _options.bootstrapList
+          }
+        },
+        dht: {
+          kBucketSize: 20
+        }
+      }
     }
 
-    super(modules, peerInfo, peerBook, options)
+    super(defaultsDeep(_options, defaults))
   }
 }
 

examples/chat/src/listener.js

@@ -14,14 +14,16 @@ PeerId.createFromJSON(require('./peer-id-listener'), (err, idListener) => {
   }
   const peerListener = new PeerInfo(idListener)
   peerListener.multiaddrs.add('/ip4/0.0.0.0/tcp/10333')
-  const nodeListener = new Node(peerListener)
+  const nodeListener = new Node({
+    peerInfo: peerListener
+  })
 
   nodeListener.start((err) => {
     if (err) {
       throw err
     }
 
-    nodeListener.switch.on('peer-mux-established', (peerInfo) => {
+    nodeListener.on('peer:connect', (peerInfo) => {
       console.log(peerInfo.id.toB58String())
     })
 

examples/discovery-mechanisms/1.js

@@ -1,12 +1,13 @@
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
-const Railing = require('libp2p-railing')
+const Bootstrap = require('libp2p-railing')
 const waterfall = require('async/waterfall')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 // Find this list at: https://github.com/ipfs/js-ipfs/blob/master/src/core/runtime/config-nodejs.json
 const bootstrapers = [
@@ -22,16 +23,26 @@ const bootstrapers = [
 ]
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Mplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ Bootstrap ]
       },
-      discovery: [new Railing(bootstrapers)]
+      config: {
+        peerDiscovery: {
+          bootstrap: {
+            interval: 2000,
+            enabled: true,
+            list: bootstrapers
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -41,7 +52,9 @@ waterfall([
   (cb) => PeerInfo.create(cb),
   (peerInfo, cb) => {
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({
+      peerInfo
+    })
     node.start(cb)
   }
 ], (err) => {

examples/discovery-mechanisms/2.js

@@ -1,25 +1,35 @@
 'use strict'
 
-const libp2p = require('libp2p')
+const libp2p = require('../../')
 const TCP = require('libp2p-tcp')
 const Mplex = require('libp2p-mplex')
 const SECIO = require('libp2p-secio')
 const PeerInfo = require('peer-info')
 const MulticastDNS = require('libp2p-mdns')
 const waterfall = require('async/waterfall')
 const parallel = require('async/parallel')
+const defaultsDeep = require('@nodeutils/defaults-deep')
 
 class MyBundle extends libp2p {
-  constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Mplex],
-        crypto: [SECIO]
+  constructor (_options) {
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ MulticastDNS ]
       },
-      discovery: [new MulticastDNS(peerInfo, { interval: 1000 })]
+      config: {
+        peerDiscovery: {
+          mdns: {
+            interval: 1000,
+            enabled: true
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 
@@ -30,7 +40,9 @@ function createNode (callback) {
     (cb) => PeerInfo.create(cb),
     (peerInfo, cb) => {
       peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-      node = new MyBundle(peerInfo)
+      node = new MyBundle({
+        peerInfo
+      })
       node.start(cb)
     }
   ], (err) => callback(err, node))

examples/discovery-mechanisms/README.md

@@ -13,17 +13,28 @@ For this demo, we will connect to IPFS default bootstrapper nodes and so, we wil
 First, we create our libp2p bundle.
 
 ```JavaScript
+const Bootstrap = require('libp2p-railing')
 class MyBundle extends libp2p {
   constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Mplex],
-        crypto: [SECIO]
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ Bootstrap ]
       },
-      discovery: [new Railing(bootstrapers)]
+      config: {
+        peerDiscovery: {
+          bootstrap: {
+            interval: 2000,
+            enabled: true,
+            list: bootstrapers
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```
@@ -53,7 +64,9 @@ waterfall([
   (cb) => PeerInfo.create(cb),
   (peerInfo, cb) => {
     peerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-    node = new MyBundle(peerInfo)
+    node = new MyBundle({
+      peerInfo
+    })
     node.start(cb)
   }
 ], (err) => {
@@ -108,17 +121,25 @@ Update your libp2p bundle to include MulticastDNS.
 ```JavaScript
 class MyBundle extends libp2p {
   constructor (peerInfo) {
-    const modules = {
-      transport: [new TCP()],
-      connection: {
-        muxer: [Mplex],
-        crypto: [SECIO]
+    const defaults = {
+      modules: {
+        transport: [ TCP ],
+        streamMuxer: [ Mplex ],
+        connEncryption: [ SECIO ],
+        peerDiscovery: [ MulticastDNS ]
       },
-      // We set the interval here to 1 second so that is faster to observe. The
-      // default is 10 seconds.
-      discovery: [new MulticastDNS(peerInfo, { interval: 1000 })]
+      config: {
+        peerDiscovery: {
+          mdns: {
+            // Run at 1s so we can observe more quickly, default is 10s
+            interval: 1000,
+            enabled: true
+          }
+        }
+      }
     }
-    super(modules, peerInfo)
+
+    super(defaultsDeep(_options, defaults))
   }
 }
 ```

examples/echo/README.md

@@ -1 +1,13 @@
 # Echo example with libp2p
+
+This example performs a simple echo from the listener to the dialer.
+
+## Setup
+1. Install the modules, `npm install`.
+2. Open 2 terminal windows in the `./src` directory.
+
+## Running
+1. Run the listener in window 1, `node listener.js`
+2. Run the dialer in window 2, `node dialer.js`
+3. You should see console logs showing the dial, and the received echo of _hey_
+4. If you look at the listener window, you will see it receiving the dial

examples/echo/src/dialer.js

@@ -21,7 +21,9 @@ async.parallel([
   const dialerId = ids[0]
   const dialerPeerInfo = new PeerInfo(dialerId)
   dialerPeerInfo.multiaddrs.add('/ip4/0.0.0.0/tcp/0')
-  const dialerNode = new Node(dialerPeerInfo)
+  const dialerNode = new Node({
+    peerInfo: dialerPeerInfo
+  })
 
   // Peer to Dial
   const listenerPeerInfo = new PeerInfo(ids[1])