docs(api): first pass

.npmignore

@@ -27,3 +27,4 @@ build/Release
 node_modules
 
 test
+docs

.travis.yml

@@ -1,35 +1,32 @@
-language: node_js
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
-cache: npm
 sudo: false
+language: node_js
 
-stages:
+matrix:
-  - check
+  include:
-  - test
+  - node_js: 6
-  - cov
+    env: CXX=g++-4.8
+  - node_js: 8
+    env: CXX=g++-4.8
+    #  - node_js: stable
+    #    env: CXX=g++-4.8
 
-node_js:
+script:
-  - '10'
+  - npm run lint
-  - '12'
+  - npm run test
-
+  - npm run coverage
-os:
-  - linux
-  - osx
-  - windows
 
 before_script:
-  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'; fi
+  - export DISPLAY=:99.0
-script: npx nyc -s npm run test:node -- --bail
+  - sh -e /etc/init.d/xvfb start
-after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
 
-jobs:
+after_success:
-  include:
+  - npm run coverage-publish
-    - stage: check
-      os: linux
-      script:
-        - npx aegir build --bundlesize
-        - npx aegir commitlint --travis
-        - npx aegir dep-check
-        - npm run lint
 
-notifications:
+addons:
-  email: false
+  firefox: 'latest'
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8

CHANGELOG.md

@@ -1,28 +1,3 @@
-<a name="0.13.2"></a>
-## [0.13.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.1...v0.13.2) (2019-09-24)
-
-
-### Bug Fixes
-
-* support multiaddr 7 ([#115](https://github.com/libp2p/js-libp2p-tcp/issues/115)) ([37cea53](https://github.com/libp2p/js-libp2p-tcp/commit/37cea53))
-
-
-
-<a name="0.13.1"></a>
-## [0.13.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.0...v0.13.1) (2019-08-08)
-
-
-
-<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)
 

README.md

@@ -1,13 +1,13 @@
 # js-libp2p-tcp
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp)
-[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-tcp/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-tcp?branch=master)
-[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp)
-[![](https://img.shields.io/travis/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-tcp)
 [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/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://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
 
 [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)

appveyor.yml

@@ -0,0 +1,29 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+version: "{build}"
+
+environment:
+  matrix:
+    - nodejs_version: "6"
+    - nodejs_version: "8"
+
+matrix:
+  fast_finish: true
+
+install:
+  # Install Node.js
+  - ps: Install-Product node $env:nodejs_version
+
+  # Upgrade npm
+  - npm install -g npm
+
+  # Output our current versions for debugging
+  - node --version
+  - npm --version
+
+  # Install our package dependencies
+  - npm install
+
+test_script:
+  - npm run test:node
+
+build: off

ci/Jenkinsfile

@@ -0,0 +1,2 @@
+// Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+javascript()

circle.yml

@@ -0,0 +1,15 @@
+# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
+machine:
+  node:
+    version: stable
+
+dependencies:
+  pre:
+    - google-chrome --version
+    - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+    - sudo dpkg -i google-chrome.deb || true
+    - sudo apt-get update
+    - sudo apt-get install -f
+    - sudo apt-get install --only-upgrade lsb-base
+    - sudo dpkg -i google-chrome.deb
+    - google-chrome --version

package.json

@@ -1,13 +1,12 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.13.2",
+  "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",
   "scripts": {
     "lint": "aegir lint",
-    "test": "aegir test -t node",
+    "test": "aegir test -t node -f test/**/*.js",
-    "test:node": "aegir test -t node",
     "release": "aegir release -t node --no-build",
     "release-minor": "aegir release -t node --type minor --no-build",
     "release-major": "aegir-release -t node --type major --no-build",
@@ -35,24 +34,24 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^20.0.0",
+    "aegir": "^15.1.0",
-    "chai": "^4.2.0",
+    "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
     "interface-transport": "~0.3.6",
-    "pull-stream": "^3.6.14",
+    "lodash.isfunction": "^3.0.9",
-    "multiaddr7": "npm:multiaddr@^7.0.0"
+    "pull-stream": "^3.6.7"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^4.1.1",
+    "debug": "^3.1.0",
-    "interface-connection": "~0.3.3",
+    "interface-connection": "~0.3.2",
-    "ip-address": "^6.1.0",
+    "ip-address": "^5.8.9",
     "lodash.includes": "^4.3.0",
     "lodash.isfunction": "^3.0.9",
-    "mafmt": "^6.0.7",
+    "mafmt": "^6.0.0",
-    "multiaddr": "^6.1.0",
+    "multiaddr": "^4.0.0",
     "once": "^1.4.0",
-    "stream-to-pull-stream": "^1.7.3"
+    "stream-to-pull-stream": "^1.7.2"
   },
   "contributors": [
     "Alan Shaw <alan@tableflip.io>",
@@ -66,12 +65,10 @@
     "Jacob Heun <jacobheun@gmail.com>",
     "Jacob Heun <jake@andyet.net>",
     "João Antunes <j.goncalo.antunes@gmail.com>",
-    "Linus Unnebäck <linus@folkdatorn.se>",
     "Pedro Teixeira <i@pgte.me>",
     "Prashanth Chandra <coolshanth94@gmail.com>",
     "Richard Littauer <richard.littauer@gmail.com>",
     "Stephen Whitmore <stephen.whitmore@gmail.com>",
-    "TomCoded <tomtinkerer@gmail.com>",
+    "TomCoded <tomtinkerer@gmail.com>"
-    "Vasco Santos <vasco.santos@moxy.studio>"
   ]
 }

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,9 +98,7 @@ class TCP {
         return false
       }
 
-      if (typeof ma.decapsulateCode === 'function') {
+      if (includes(ma.protoNames(), 'ipfs')) {
-        ma = ma.decapsulateCode(421) // multiaddr 7
-      } else if (includes(ma.protoNames(), 'ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
 

src/listener.js

@@ -17,7 +17,49 @@ 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) => {
@@ -84,10 +126,7 @@ module.exports = (handler) => {
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
-    if (typeof ma.decapsulateCode === 'function') {
+    if (includes(ma.protoNames(), 'ipfs')) {
-      ipfsId = getIpfsId(ma)
-      listeningAddr = ma.decapsulateCode(IPFS_CODE)
-    } else if (includes(ma.protoNames(), 'ipfs')) {
       ipfsId = getIpfsId(ma)
       listeningAddr = ma.decapsulate('ipfs')
     }

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('/ip4/127.0.0.1/tcp/9093')
-        multiaddr('/dns4/ipfs.io')
       ]
       cb(null, tcp, addrs)
     },

test/filter.spec.js

@@ -7,7 +7,6 @@ const expect = chai.expect
 chai.use(dirtyChai)
 const TCP = require('../src')
 const multiaddr = require('multiaddr')
-const multiaddr7 = require('multiaddr7')
 
 describe('filter addrs', () => {
   const base = '/ip4/127.0.0.1'
@@ -26,15 +25,11 @@ 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 ma9 = multiaddr7(base + '/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
 
-    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8, ma9])
+    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6])
-    expect(valid.length).to.equal(5)
+    expect(valid.length).to.equal(2)
     expect(valid[0]).to.deep.equal(ma1)
     expect(valid[1]).to.deep.equal(ma4)
-    expect(valid[4]).to.deep.equal(ma9)
   })
 
   it('filter a single addr for this transport', () => {

test/listen-dial.js

@@ -9,7 +9,6 @@ chai.use(dirtyChai)
 const TCP = require('../src')
 const net = require('net')
 const multiaddr = require('multiaddr')
-const multiaddr7 = require('multiaddr7')
 const isCI = process.env.CI
 
 describe('listen', () => {
@@ -127,19 +126,6 @@ describe('listen', () => {
       })
     })
   })
-
-  it('getAddrs preserves IPFS Id (multiaddr 7)', (done) => {
-    const mh = multiaddr7('/ip4/127.0.0.1/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
-    const listener = tcp.createListener((conn) => {})
-    listener.listen(mh, () => {
-      listener.getAddrs((err, multiaddrs) => {
-        expect(err).to.not.exist()
-        expect(multiaddrs.length).to.equal(1)
-        expect(multiaddrs[0]).to.deep.equal(mh)
-        listener.close(done)
-      })
-    })
-  })
 })
 
 describe('dial', () => {
@@ -270,19 +256,4 @@ describe('dial', () => {
       })
     )
   })
-
-  it('dial on IPv4 with IPFS Id multiaddr7', (done) => {
-    const ma = multiaddr7('/ip4/127.0.0.1/tcp/9090/p2p/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
-    const conn = tcp.dial(ma)
-
-    pull(
-      pull.values(['hey']),
-      conn,
-      pull.collect((err, res) => {
-        expect(err).to.not.exist()
-        expect(res).to.be.eql([Buffer.from('hey!')])
-        done()
-      })
-    )
-  })
 })