docs(api): first pass

.npmignore

@@ -26,4 +26,5 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
 
-test
+test
+docs

CHANGELOG.md

@@ -1,13 +1,3 @@
-<a name="0.13.0"></a>
-# [0.13.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.1...v0.13.0) (2018-09-12)
-
-
-### Features
-
-* add support for dialing over dns ([eba0b48](https://github.com/libp2p/js-libp2p-tcp/commit/eba0b48))
-
-
-
 <a name="0.12.1"></a>
 ## [0.12.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.0...v0.12.1) (2018-07-31)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.13.0",
+  "version": "0.12.1",
   "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -34,22 +34,22 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^17.1.1",
-    "chai": "^4.2.0",
+    "aegir": "^15.1.0",
+    "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
     "interface-transport": "~0.3.6",
     "lodash.isfunction": "^3.0.9",
-    "pull-stream": "^3.6.9"
+    "pull-stream": "^3.6.7"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^4.1.0",
+    "debug": "^3.1.0",
     "interface-connection": "~0.3.2",
     "ip-address": "^5.8.9",
     "lodash.includes": "^4.3.0",
     "lodash.isfunction": "^3.0.9",
-    "mafmt": "^6.0.3",
-    "multiaddr": "^6.0.1",
+    "mafmt": "^6.0.0",
+    "multiaddr": "^4.0.0",
     "once": "^1.4.0",
     "stream-to-pull-stream": "^1.7.2"
   },

src/index.js

@@ -15,7 +15,18 @@ const createListener = require('./listener')
 
 function noop () {}
 
+/**
+ *
+ */
 class TCP {
+  /**
+   * Dial to another peer.
+   *
+   * @param {Multiaddr} ma - The address of the peer we want to dial to.
+   * @param {Object} [options={}]
+   * @param {function(Error?, Array<Multiaddr>?)} [callback]
+   * @returns {Connection}
+   */
   dial (ma, options, callback) {
     if (isFunction(options)) {
       callback = options
@@ -52,6 +63,13 @@ class TCP {
     return conn
   }
 
+  /**
+   * Listen for incoming `TCP` connetions.
+   *
+   * @param {Object} [options={}]
+   * @param {function(Connection)} [handler] - Called with newly incomin connections.
+   * @returns {Listener}
+   */
   createListener (options, handler) {
     if (isFunction(options)) {
       handler = options
@@ -63,6 +81,13 @@ class TCP {
     return createListener(handler)
   }
 
+  /**
+   * Filter a list of multiaddrs for those which contain
+   * valid `TCP` addresses.
+   *
+   * @param {Multiaddr|Array<Multiaddr>} multiaddrs
+   * @returns {Array<Multiaddr>}
+   */
   filter (multiaddrs) {
     if (!Array.isArray(multiaddrs)) {
       multiaddrs = [multiaddrs]
@@ -73,8 +98,8 @@ class TCP {
         return false
       }
 
-      if (ma.protoNames().includes('p2p')) {
-        ma = ma.decapsulate('p2p')
+      if (includes(ma.protoNames(), 'ipfs')) {
+        ma = ma.decapsulate('ipfs')
       }
 
       return mafmt.TCP.matches(ma)

src/listener.js

@@ -12,12 +12,54 @@ const log = debug('libp2p:tcp:listen')
 
 const getMultiaddr = require('./get-multiaddr')
 
-const P2P_CODE = 421
+const IPFS_CODE = 421
 const CLOSE_TIMEOUT = 2000
 
 function noop () {}
 
+/**
+ * Listening for incoming connections.
+ *
+ * @event listening
+ * @instance
+ * @memberof Listener
+ */
+
+/**
+ * The server closes.
+ *
+ * @event close
+ * @instance
+ * @memberof Listener
+ */
+
+/**
+ * New connection established.
+ *
+ * @event connection
+ * @instance
+ * @type {Connection}
+ * @memberof Listener
+ */
+
+/**
+ * The underlying server encountered an error.
+ *
+ * @event error
+ * @instance
+ * @type {Error}
+ * @memberof Listener
+ */
+
 module.exports = (handler) => {
+  /**
+   * @alias Listener
+   * @type {Eventemitter}
+   * @fires Listener#listening
+   * @fires Listener#close
+   * @fires Listener#connection
+   * @fires Listener#error
+   */
   const listener = new EventEmitter()
 
   const server = net.createServer((socket) => {
@@ -79,14 +121,14 @@ module.exports = (handler) => {
     })
   }
 
-  let p2pId
+  let ipfsId
   let listeningAddr
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
-    if (includes(ma.protoNames(), 'p2p')) {
-      p2pId = getp2pId(ma)
-      listeningAddr = ma.decapsulate('p2p')
+    if (includes(ma.protoNames(), 'ipfs')) {
+      ipfsId = getIpfsId(ma)
+      listeningAddr = ma.decapsulate('ipfs')
     }
 
     const lOpts = listeningAddr.toOptions()
@@ -107,8 +149,8 @@ module.exports = (handler) => {
     if (listeningAddr.toString().indexOf('ip4') !== -1) {
       let m = listeningAddr.decapsulate('tcp')
       m = m.encapsulate('/tcp/' + address.port)
-      if (p2pId) {
-        m = m.encapsulate('/p2p/' + p2pId)
+      if (ipfsId) {
+        m = m.encapsulate('/ipfs/' + ipfsId)
       }
 
       if (m.toString().indexOf('0.0.0.0') !== -1) {
@@ -127,8 +169,8 @@ module.exports = (handler) => {
 
     if (address.family === 'IPv6') {
       let ma = multiaddr('/ip6/' + address.address + '/tcp/' + address.port)
-      if (p2pId) {
-        ma = ma.encapsulate('/p2p/' + p2pId)
+      if (ipfsId) {
+        ma = ma.encapsulate('/ipfs/' + ipfsId)
       }
 
       multiaddrs.push(ma)
@@ -140,9 +182,9 @@ module.exports = (handler) => {
   return listener
 }
 
-function getp2pId (ma) {
+function getIpfsId (ma) {
   return ma.stringTuples().filter((tuple) => {
-    return tuple[0] === P2P_CODE
+    return tuple[0] === IPFS_CODE
   })[0][1]
 }
 

test/compliance.spec.js

@@ -8,12 +8,11 @@ const TCP = require('../src')
 describe('interface-transport compliance', () => {
   tests({
     setup (cb) {
-      const tcp = new TCP()
+      let tcp = new TCP()
       const addrs = [
         multiaddr('/ip4/127.0.0.1/tcp/9091'),
         multiaddr('/ip4/127.0.0.1/tcp/9092'),
-        multiaddr('/ip4/127.0.0.1/tcp/9093'),
-        multiaddr('/dns4/ipfs.io')
+        multiaddr('/ip4/127.0.0.1/tcp/9093')
       ]
       cb(null, tcp, addrs)
     },

test/filter.spec.js

@@ -25,11 +25,9 @@ describe('filter addrs', () => {
     const ma4 = multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
     const ma5 = multiaddr(base + '/tcp/9090/http' + ipfs)
     const ma6 = multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs)
-    const ma7 = multiaddr('/dns4/libp2p.io/tcp/9090')
-    const ma8 = multiaddr('/dnsaddr/libp2p.io/tcp/9090')
 
-    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8])
-    expect(valid.length).to.equal(4)
+    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6])
+    expect(valid.length).to.equal(2)
     expect(valid[0]).to.deep.equal(ma1)
     expect(valid[1]).to.deep.equal(ma4)
   })