Release v0.5.0.

switch from throw to send err to callback

README.md

@@ -1,11 +1,96 @@
-node-libp2p-tcp
+js-libp2p-tcp
 ===============
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) ![Build Status](https://travis-ci.org/diasdavid/node-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/diasdavid/node-libp2p-tcp) ![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square) [![Dependency Status](https://david-dm.org/diasdavid/node-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/diasdavid/node-libp2p-tcp) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![Build Status](https://travis-ci.org/diasdavid/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/diasdavid/js-libp2p-tcp)
+![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square)
+[![Dependency Status](https://david-dm.org/diasdavid/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/diasdavid/js-libp2p-tcp)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 
 ![](https://raw.githubusercontent.com/diasdavid/abstract-connection/master/img/badge.png)
 ![](https://raw.githubusercontent.com/diasdavid/abstract-transport/master/img/badge.png)
 
-> Node.js implementation of the TCP module that libp2p uses, which implements the [abstract-connection]() interface for dial/listen.
+> Node.js implementation of the TCP module that libp2p uses, which implements
+> the [interface-connection](https://github.com/diasdavid/interface-connection)
+> interface for dial/listen.
 
-note: libp2p-tcp in Node.js is a very thin shim that adds the support to dial to a `multiaddr`. This small shim will enable libp2p to use other different transports.
+## Description
+
+`libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a
+`multiaddr`. This small shim will enable libp2p to use other different
+transports.
+
+## Example
+
+```js
+const Tcp = require('libp2p-tcp')
+const multiaddr = require('multiaddr')
+
+const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
+const mh2 = multiaddr('/ip6/::/tcp/9092')
+
+const tcp = new Tcp()
+
+tcp.createListener([mh1, mh2], function handler (socket) {
+  console.log('connection')
+  socket.end('bye')
+}, function ready () {
+  console.log('ready')
+
+  const client = tcp.dial(mh1)
+  client.pipe(process.stdout)
+  client.on('end', () => {
+    tcp.close()
+  })
+})
+
+```
+
+outputs
+
+```
+ready
+connection
+bye
+```
+
+## Installation
+
+### npm
+
+```sh
+> npm i libp2p-tcp
+```
+
+## API
+
+```js
+const Tcp = require('libp2p-tcp')
+```
+
+### var tcp = new Tcp()
+
+Creates a new TCP object. This does nothing on its own, but provides access to
+`dial` and `createListener`.
+
+### tcp.createListener(multiaddrs, handler, ready)
+
+Creates TCP servers that listen on the addresses described in the array
+`multiaddrs`. Each connection will call `handler` with a connection stream.
+`ready` is called once all servers are listening.
+
+### tcp.dial(multiaddr, options={})
+
+Connects to the multiaddress `multiaddr` using TCP, returning the socket stream.
+If `options.ready` is set to a function, it is called when a connection is
+established.
+
+### tcp.close(callback)
+
+Closes all the listening TCP servers, calling `callback` once all of them have
+been shut down.
+
+## License
+
+MIT

circle.yml

@@ -0,0 +1,8 @@
+dependencies:
+  pre:
+    # setup ipv6
+    - sudo sysctl -w net.ipv6.conf.lo.disable_ipv6=0 net.ipv6.conf.default.disable_ipv6=0 net.ipv6.conf.all.disable_ipv6=0
+
+machine:
+  node:
+    version: stable

package.json

@@ -1,15 +1,23 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.1.1",
-  "description": "Node.js implementation of the TCP module that libp2p uses, which implements the abstract-connection interface",
+  "version": "0.5.0",
+  "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
   "main": "src/index.js",
   "scripts": {
-    "test": "node tests/test-ac.js"
+    "test:compliance:connection": "node tests/connection.js",
+    "test:compliance:transport": "node tests/transport.js",
+    "test:specific": "mocha tests/*-test.js",
+    "test": "npm run test:specific",
+    "test-2": "npm run test:specific && npm run test:compliance:transport && npm run test:compliance:connection",
+    "lint": "standard"
   },
-  "pre-commit": [],
+  "pre-commit": [
+    "lint",
+    "test"
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/diasdavid/node-libp2p-tcp.git"
+    "url": "https://github.com/diasdavid/js-libp2p-tcp.git"
   },
   "keywords": [
     "IPFS"
@@ -17,17 +25,22 @@
   "author": "David Dias <daviddias@ipfs.io>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/diasdavid/node-libp2p-tcp/issues"
+    "url": "https://github.com/diasdavid/js-libp2p-tcp/issues"
   },
-  "homepage": "https://github.com/diasdavid/node-libp2p-tcp",
+  "homepage": "https://github.com/diasdavid/js-libp2p-tcp",
   "devDependencies": {
-    "abstract-connection": "0.0.1",
-    "abstract-transport": "^0.1.0",
-    "pre-commit": "^1.1.1",
-    "standard": "^5.2.2",
+    "chai": "^3.5.0",
+    "interface-connection": "0.0.3",
+    "interface-transport": "^0.1.1",
+    "istanbul": "^0.4.2",
+    "mocha": "^2.4.5",
+    "pre-commit": "^1.1.2",
+    "standard": "^6.0.7",
     "tape": "^4.2.0"
   },
   "dependencies": {
-    "multiaddr": "^1.0.0"
+    "ip-address": "^5.8.0",
+    "mafmt": "^1.0.1",
+    "multiaddr": "^1.1.1"
   }
 }

src/index.js

@@ -1,10 +1,104 @@
-var tcp = require('net')
+// const debug = require('debug')
+// const log = debug('libp2p:tcp')
+const tcp = require('net')
+const multiaddr = require('multiaddr')
+const Address6 = require('ip-address').Address6
+const mafmt = require('mafmt')
 
-exports = module.exports
+exports = module.exports = TCP
 
-exports.dial = function (multiaddr, options) {
-  options.ready = options.ready || function noop () {}
-  return tcp.connect(multiaddr.toOptions(), options.ready)
+function TCP () {
+  if (!(this instanceof TCP)) {
+    return new TCP()
+  }
+
+  const listeners = []
+
+  this.dial = function (multiaddr, options) {
+    if (!options) {
+      options = {}
+    }
+    options.ready = options.ready || function noop () {}
+    const conn = tcp.connect(multiaddr.toOptions(), options.ready)
+    conn.getObservedAddrs = () => {
+      return [multiaddr]
+    }
+    return conn
+  }
+
+  this.createListener = (multiaddrs, handler, callback) => {
+    if (!Array.isArray(multiaddrs)) {
+      multiaddrs = [multiaddrs]
+    }
+
+    var count = 0
+    const freshMultiaddrs = []
+
+    multiaddrs.forEach((m) => {
+      const listener = tcp.createServer((conn) => {
+        conn.getObservedAddrs = () => {
+          return [getMultiaddr(conn)]
+        }
+        handler(conn)
+      })
+      listener.listen(m.toOptions(), () => {
+        // Node.js likes to convert addr to IPv6 (when 0.0.0.0 for e.g)
+        const address = listener.address()
+        if (m.toString().indexOf('ip4')) {
+          m = m.decapsulate('tcp')
+          m = m.encapsulate('/tcp/' + address.port)
+          freshMultiaddrs.push(m)
+        }
+        if (address.family === 'IPv6') {
+          freshMultiaddrs.push(multiaddr('/ip6/' + address.address + '/tcp/' + address.port))
+        }
+
+        if (++count === multiaddrs.length) {
+          callback(null, freshMultiaddrs)
+        }
+      })
+      listeners.push(listener)
+    })
+  }
+
+  this.close = (callback) => {
+    if (listeners.length === 0) {
+      callback(new Error('there are no listeners'))
+    }
+    var count = 0
+    listeners.forEach((listener) => {
+      listener.close(() => {
+        if (++count === listeners.length && callback) {
+          callback()
+        }
+      })
+    })
+  }
+
+  this.filter = (multiaddrs) => {
+    if (!Array.isArray(multiaddrs)) {
+      multiaddrs = [multiaddrs]
+    }
+    return multiaddrs.filter((ma) => {
+      return mafmt.TCP.matches(ma)
+    })
+  }
 }
 
-exports.createListener = tcp.createServer
+function getMultiaddr (conn) {
+  var mh
+
+  if (conn.remoteFamily === 'IPv6') {
+    var addr = new Address6(conn.remoteAddress)
+    if (addr.v4) {
+      var ip4 = addr.to4().correctForm()
+      mh = multiaddr('/ip4/' + ip4 + '/tcp/' + conn.remotePort)
+    } else {
+      mh = multiaddr('/ip6/' + conn.remoteAddress + '/tcp/' + conn.remotePort)
+    }
+  } else {
+    mh = multiaddr('/ip4/' + conn.remoteAddress + '/tcp/' + conn.remotePort)
+  }
+
+  return mh
+}

tests/libp2p-tcp-test.js

@@ -0,0 +1,131 @@
+/* eslint-env mocha */
+
+const expect = require('chai').expect
+const TCPlibp2p = require('../src')
+const net = require('net')
+const multiaddr = require('multiaddr')
+
+describe('libp2p-tcp', function () {
+  this.timeout(10000)
+  var tcp
+
+  it('create', (done) => {
+    tcp = new TCPlibp2p()
+    expect(tcp).to.exist
+    done()
+  })
+
+  it('create without new', (done) => {
+    tcp = TCPlibp2p()
+    expect(tcp).to.exist
+    done()
+  })
+
+  it('close /wo listeners', (done) => {
+    tcp = new TCPlibp2p()
+    expect(tcp).to.exist
+    expect(function () { tcp.close() }).to.throw(Error)
+    done()
+  })
+
+  it('listen', (done) => {
+    const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
+    tcp.createListener(mh, (socket) => {
+      expect(socket).to.exist
+      socket.end()
+      tcp.close(() => {
+        done()
+      })
+    }, () => {
+      const socket = net.connect({ host: '127.0.0.1', port: 9090 })
+      socket.end()
+    })
+  })
+
+  it('dial', (done) => {
+    const server = net.createServer((socket) => {
+      expect(socket).to.exist
+      socket.end()
+      server.close(done)
+    })
+
+    server.listen(9090, () => {
+      const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
+      const socket = tcp.dial(mh)
+      socket.end()
+    })
+  })
+
+  it('listen on several', (done) => {
+    const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
+    const mh2 = multiaddr('/ip4/127.0.0.1/tcp/9091')
+    const mh3 = multiaddr('/ip6/::/tcp/9092')
+    const tcp = new TCPlibp2p()
+
+    tcp.createListener([mh1, mh2, mh3], (socket) => {}, () => {
+      tcp.close(done)
+    })
+  })
+
+  it('dial ipv6', (done) => {
+    const mh = multiaddr('/ip6/::/tcp/9091')
+    var dialerObsAddrs
+
+    tcp.createListener(mh, (conn) => {
+      expect(conn).to.exist
+      dialerObsAddrs = conn.getObservedAddrs()
+      conn.end()
+    }, () => {
+      const conn = tcp.dial(mh)
+      conn.on('end', () => {
+        expect(dialerObsAddrs.length).to.equal(1)
+        tcp.close()
+        done()
+      })
+    })
+  })
+
+  it('get observed addrs', (done) => {
+    const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
+    var dialerObsAddrs
+    var listenerObsAddrs
+
+    tcp.createListener(mh, (conn) => {
+      expect(conn).to.exist
+      dialerObsAddrs = conn.getObservedAddrs()
+      conn.end()
+    }, () => {
+      const conn = tcp.dial(mh)
+      conn.on('end', () => {
+        listenerObsAddrs = conn.getObservedAddrs()
+        conn.end()
+
+        tcp.close(() => {
+          expect(listenerObsAddrs[0]).to.deep.equal(mh)
+          expect(dialerObsAddrs.length).to.equal(1)
+          done()
+        })
+      })
+    })
+  })
+
+  it('filter valid addrs for this transport', (done) => {
+    const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
+    const mh2 = multiaddr('/ip4/127.0.0.1/udp/9090')
+    const mh3 = multiaddr('/ip4/127.0.0.1/tcp/9090/http')
+
+    const valid = tcp.filter([mh1, mh2, mh3])
+    expect(valid.length).to.equal(1)
+    expect(valid[0]).to.deep.equal(mh1)
+    done()
+  })
+
+  it('filter a valid addr for this transport', (done) => {
+    const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
+
+    const valid = tcp.filter(mh1)
+    expect(valid.length).to.equal(1)
+    expect(valid[0]).to.deep.equal(mh1)
+    done()
+  })
+})

tests/transport.js

@@ -1,5 +1,5 @@
 var tape = require('tape')
-var tests = require('abstract-transport/tests')
+var tests = require('interface-transport/tests')
 var conn = require('../src')
 
 var common = {