Merge pull request #126 from ipfs/feat/use-base-libp2p

Use the base class

Author: daviddias

README.md

@@ -14,7 +14,7 @@
 
 [![Sauce Test Status](https://saucelabs.com/browser-matrix/libp2p-ipfs-browser.svg)](https://saucelabs.com/u/libp2p-ipfs-browser)
 
-> libp2p build (module) used in js-ipfs when running it on the browser.
+> libp2p build (module) used in js-ipfs when running it on the browser. If you are looking for the version to be used in Node.js, see [libp2p-ipfs-nodejs](https://github.com/ipfs/js-libp2p-ipfs-nodejs).
 
 This libp2p build has support for:
 

gulpfile.js

@@ -2,7 +2,7 @@
 
 const gulp = require('gulp')
 const multiaddr = require('multiaddr')
-const Node = require('libp2p-ipfs').Node
+const Node = require('libp2p-ipfs-nodejs')
 const PeerInfo = require('peer-info')
 const PeerId = require('peer-id')
 const pull = require('pull-stream')

package.json

@@ -31,10 +31,10 @@
   "homepage": "https://github.com/ipfs/js-libp2p-ipfs-browser#readme",
   "devDependencies": {
     "aegir": "^9.1.2",
-    "async": "^2.1.2",
+    "async": "^2.1.4",
     "chai": "^3.5.0",
     "gulp": "^3.9.1",
-    "libp2p-ipfs": "^0.15.0",
+    "libp2p-ipfs-nodejs": "^0.16.0",
     "peer-id": "^0.8.0",
     "pre-commit": "^1.1.3",
     "pull-goodbye": "0.0.1",
@@ -45,19 +45,19 @@
   "dependencies": {
     "libp2p-secio": "^0.6.3",
     "libp2p-spdy": "^0.10.0",
-    "libp2p-swarm": "^0.26.1",
+    "libp2p-swarm": "^0.26.3",
     "libp2p-webrtc-star": "^0.6.0",
     "libp2p-websockets": "^0.9.1",
     "mafmt": "^2.1.2",
-    "multiaddr": "^2.0.3",
+    "multiaddr": "^2.1.1",
     "peer-book": "^0.3.0",
     "peer-id": "^0.8.0",
-    "peer-info": "^0.8.0"
+    "peer-info": "^0.8.1"
   },
   "contributors": [
     "David Dias <daviddias.p@gmail.com>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "greenkeeperio-bot <support@greenkeeper.io>"
   ]
-}
+}

src/index.js

@@ -1,206 +1,34 @@
 'use strict'
 
-const Swarm = require('libp2p-swarm')
 const WS = require('libp2p-websockets')
 const WebRTCStar = require('libp2p-webrtc-star')
 const spdy = require('libp2p-spdy')
 const secio = require('libp2p-secio')
-const PeerInfo = require('peer-info')
-const PeerId = require('peer-id')
-const EE = require('events').EventEmitter
-const multiaddr = require('multiaddr')
-const PeerBook = require('peer-book')
-const mafmt = require('mafmt')
-
-exports = module.exports
-
-const OFFLINE_ERROR_MESSAGE = 'The libp2p node is not started yet'
-const IPFS_CODE = 421
-
-exports.Node = function Node (pInfo, pBook) {
-  if (!(this instanceof Node)) {
-    return new Node(pInfo, pBook)
-  }
-
-  if (!pInfo) {
-    throw new Error('missing peer info')
-  }
-
-  if (!pBook) {
-    pBook = new PeerBook()
-  }
-
-  this.peerInfo = pInfo
-  this.peerBook = pBook
-
-  // Swarm
-  this.swarm = new Swarm(pInfo)
-  this.swarm.connection.addStreamMuxer(spdy)
-  this.swarm.connection.reuse()
-  this.swarm.connection.crypto(secio.tag, secio.encrypt)
-
-  this.swarm.on('peer-mux-established', (peerInfo) => {
-    this.peerBook.put(peerInfo)
-  })
-
-  this.swarm.on('peer-mux-closed', (peerInfo) => {
-    this.peerBook.removeByB58String(peerInfo.id.toB58String())
-  })
-
-  let isOnline = false
-
-  this.start = (callback) => {
-    // if we have `webrtc-star` addrs, then add
-    // the WebRTCStar transport
-    const wstar = new WebRTCStar()
-
-    if (wstar.filter(this.peerInfo.multiaddrs).length > 0) {
-      this.swarm.transport.add('wstar', wstar)
-      wstar.discovery.on('peer', (peerInfo) => {
-        this.discovery.emit('peer', peerInfo)
-      })
-      this.swarm.listen((err) => {
-        if (err) {
-          return callback(err)
-        }
-        // WebSockets needs to be added after because
-        // it can't have a listener on the browser
-        this.swarm.transport.add('ws', new WS())
-        isOnline = true
-        callback()
-      })
-    } else {
-      // if just WebSockets, no thing to listen
-      this.swarm.transport.add('ws', new WS())
-      isOnline = true
-      callback()
-    }
+const libp2p = require('libp2p')
+
+class Node extends libp2p {
+  constructor (peerInfo, peerBook) {
+    const webRTCStar = new WebRTCStar()
+
+    const modules = {
+      transport: [
+        new WS(),
+        webRTCStar
+      ],
+      connection: {
+        muxer: [
+          spdy
+        ],
+        crypto: [
+          secio
+        ]
+      },
+      discovery: [
+        webRTCStar.discovery
+      ]
+    }
+    super(modules, peerInfo, peerBook)
   }
-
-  this.stop = (callback) => {
-    isOnline = false
-    this.swarm.close(callback)
-  }
-
-  this.dialById = (id, protocol, callback) => {
-    if (typeof protocol === 'function') {
-      callback = protocol
-      protocol = undefined
-    }
-
-    if (!isOnline) {
-      return callback(new Error(OFFLINE_ERROR_MESSAGE))
-    }
-    // NOTE, these dialById only works if a previous dial
-    // was made until we have PeerRouting
-    // TODO support PeerRouting when it is Ready
-    callback(new Error('not implemented yet'))
-  }
-
-  this.dialByMultiaddr = (maddr, protocol, callback) => {
-    if (typeof protocol === 'function') {
-      callback = protocol
-      protocol = undefined
-    }
-
-    if (!isOnline) {
-      return callback(new Error(OFFLINE_ERROR_MESSAGE))
-    }
-
-    if (typeof maddr === 'string') {
-      maddr = multiaddr(maddr)
-    }
-
-    if (!mafmt.IPFS.matches(maddr.toString())) {
-      return callback(new Error('multiaddr not valid'))
-    }
-
-    const ipfsIdB58String = maddr.stringTuples().filter((tuple) => {
-      if (tuple[0] === IPFS_CODE) {
-        return true
-      }
-    })[0][1]
-
-    let peer
-    try {
-      peer = this.peerBook.getByB58String(ipfsIdB58String)
-    } catch (err) {
-      peer = new PeerInfo(PeerId.createFromB58String(ipfsIdB58String))
-    }
-
-    peer.multiaddr.add(maddr)
-    this.dialByPeerInfo(peer, protocol, callback)
-  }
-
-  this.dialByPeerInfo = (peer, protocol, callback) => {
-    if (typeof protocol === 'function') {
-      callback = protocol
-      protocol = undefined
-    }
-    if (!isOnline) {
-      return callback(new Error(OFFLINE_ERROR_MESSAGE))
-    }
-
-    this.swarm.dial(peer, protocol, (err, conn) => {
-      if (err) {
-        return callback(err)
-      }
-      this.peerBook.put(peer)
-      callback(null, conn)
-    })
-  }
-
-  this.hangUpById = (id, callback) => {
-    callback(new Error('not implemented yet'))
-    // TODO
-  }
-
-  this.hangUpByMultiaddr = (maddr, callback) => {
-    if (!isOnline) {
-      return callback(new Error(OFFLINE_ERROR_MESSAGE))
-    }
-
-    if (typeof maddr === 'string') {
-      maddr = multiaddr(maddr)
-    }
-
-    if (!mafmt.IPFS.matches(maddr.toString())) {
-      return callback(new Error('multiaddr not valid'))
-    }
-
-    const ipfsIdB58String = maddr.stringTuples().filter((tuple) => {
-      if (tuple[0] === IPFS_CODE) {
-        return true
-      }
-    })[0][1]
-
-    try {
-      const pi = this.peerBook.getByB58String(ipfsIdB58String)
-      this.hangUpByPeerInfo(pi, callback)
-    } catch (err) {
-      // already disconnected
-      callback()
-    }
-  }
-
-  this.hangUpByPeerInfo = (peer, callback) => {
-    if (!isOnline) {
-      return callback(new Error(OFFLINE_ERROR_MESSAGE))
-    }
-
-    this.peerBook.removeByB58String(peer.id.toB58String())
-    this.swarm.hangUp(peer, callback)
-  }
-
-  this.handle = (protocol, handlerFunc, matchFunc) => {
-    return this.swarm.handle(protocol, handlerFunc, matchFunc)
-  }
-
-  this.unhandle = (protocol) => {
-    return this.swarm.unhandle(protocol)
-  }
-
-  this.discovery = new EE()
-  this.routing = null
-  this.records = null
 }
+
+module.exports = Node

test/webrtc-star-only.js

@@ -8,7 +8,7 @@ const PeerId = require('peer-id')
 const parallel = require('async/parallel')
 const pull = require('pull-stream')
 
-const libp2p = require('../src')
+const Node = require('../src')
 
 describe('libp2p-ipfs-browser (webrtc only)', function () {
   this.timeout(15 * 1000)
@@ -38,15 +38,19 @@ describe('libp2p-ipfs-browser (webrtc only)', function () {
   })
 
   it('create two libp2p nodes with those peers', (done) => {
-    node1 = new libp2p.Node(peer1)
-    node2 = new libp2p.Node(peer2)
+    node1 = new Node(peer1)
+    node2 = new Node(peer2)
     done()
   })
 
   it('listen on the two libp2p nodes', (done) => {
     parallel([
-      node1.start,
-      node2.start
+      (cb) => {
+        node1.start(cb)
+      },
+      (cb) => {
+        node2.start(cb)
+      }
     ], done)
   })
 
@@ -114,7 +118,7 @@ describe('libp2p-ipfs-browser (webrtc only)', function () {
         node2.dialByPeerInfo(peerInfo, () => {})
       })
 
-      const node3 = new libp2p.Node(peer3)
+      const node3 = new Node(peer3)
       node3.start(() => {
         setTimeout(() => {
           expect(Object.keys(node1.swarm.muxedConns).length).to.equal(1)

test/websockets-only.js

@@ -10,7 +10,7 @@ const pull = require('pull-stream')
 const goodbye = require('pull-goodbye')
 const serializer = require('pull-serializer')
 
-const libp2p = require('../src')
+const Node = require('../src')
 const rawPeer = require('./peer.json')
 
 describe('libp2p-ipfs-browser (websockets only)', () => {
@@ -39,7 +39,7 @@ describe('libp2p-ipfs-browser (websockets only)', () => {
     PeerInfo.create((err, info) => {
       expect(err).to.not.exist
       info.multiaddr.add(multiaddr('/ip4/0.0.0.0/tcp/0'))
-      nodeA = new libp2p.Node(info)
+      nodeA = new Node(info)
       done()
     })
   })