fix: support multiaddr 7 (#115)

License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>

.travis.yml

@@ -1,32 +1,35 @@
-# 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.
-sudo: false
 language: node_js
+cache: npm
+sudo: false
 
-matrix:
+stages:
-  include:
+  - check
-  - node_js: 6
+  - test
-    env: CXX=g++-4.8
+  - cov
-  - node_js: 8
-    env: CXX=g++-4.8
-    #  - node_js: stable
-    #    env: CXX=g++-4.8
 
-script:
+node_js:
-  - npm run lint
+  - '10'
-  - npm run test
+  - '12'
-  - npm run coverage
+
+os:
+  - linux
+  - osx
+  - windows
 
 before_script:
-  - export DISPLAY=:99.0
+  - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'; fi
-  - sh -e /etc/init.d/xvfb start
+script: npx nyc -s npm run test:node -- --bail
+after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
 
-after_success:
+jobs:
-  - npm run coverage-publish
+  include:
+    - stage: check
+      os: linux
+      script:
+        - npx aegir build --bundlesize
+        - npx aegir commitlint --travis
+        - npx aegir dep-check
+        - npm run lint
 
-addons:
+notifications:
-  firefox: 'latest'
+  email: false
-  apt:
-    sources:
-      - ubuntu-toolchain-r-test
-    packages:
-      - g++-4.8

CHANGELOG.md

@@ -1,3 +1,18 @@
+<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://ipn.io)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp)
+[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![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)
+[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
+[![](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

@@ -1,29 +0,0 @@
-# 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

@@ -1,2 +0,0 @@
-// 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

@@ -1,15 +0,0 @@
-# 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,12 +1,13 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.12.1",
+  "version": "0.13.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 -f test/**/*.js",
+    "test": "aegir test -t node",
+    "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",
@@ -34,24 +35,24 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^15.1.0",
+    "aegir": "^20.0.0",
-    "chai": "^4.1.2",
+    "chai": "^4.2.0",
     "dirty-chai": "^2.0.1",
     "interface-transport": "~0.3.6",
-    "lodash.isfunction": "^3.0.9",
+    "pull-stream": "^3.6.14",
-    "pull-stream": "^3.6.7"
+    "multiaddr7": "npm:multiaddr@^7.0.0"
   },
   "dependencies": {
     "class-is": "^1.1.0",
-    "debug": "^3.1.0",
+    "debug": "^4.1.1",
-    "interface-connection": "~0.3.2",
+    "interface-connection": "~0.3.3",
-    "ip-address": "^5.8.9",
+    "ip-address": "^6.1.0",
     "lodash.includes": "^4.3.0",
     "lodash.isfunction": "^3.0.9",
-    "mafmt": "^6.0.0",
+    "mafmt": "^6.0.7",
-    "multiaddr": "^4.0.0",
+    "multiaddr": "^6.1.0",
     "once": "^1.4.0",
-    "stream-to-pull-stream": "^1.7.2"
+    "stream-to-pull-stream": "^1.7.3"
   },
   "contributors": [
     "Alan Shaw <alan@tableflip.io>",
@@ -65,10 +66,12 @@
     "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

@@ -73,7 +73,9 @@ class TCP {
         return false
       }
 
-      if (includes(ma.protoNames(), 'ipfs')) {
+      if (typeof ma.decapsulateCode === 'function') {
+        ma = ma.decapsulateCode(421) // multiaddr 7
+      } else if (includes(ma.protoNames(), 'ipfs')) {
         ma = ma.decapsulate('ipfs')
       }
 

src/listener.js

@@ -84,7 +84,10 @@ module.exports = (handler) => {
 
   listener.listen = (ma, callback) => {
     listeningAddr = ma
-    if (includes(ma.protoNames(), 'ipfs')) {
+    if (typeof ma.decapsulateCode === 'function') {
+      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,11 +8,12 @@ const TCP = require('../src')
 describe('interface-transport compliance', () => {
   tests({
     setup (cb) {
-      let tcp = new TCP()
+      const 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,6 +7,7 @@ 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'
@@ -25,11 +26,15 @@ 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])
+    const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8, ma9])
-    expect(valid.length).to.equal(2)
+    expect(valid.length).to.equal(5)
     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.spec.js

@@ -9,6 +9,7 @@ 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', () => {
@@ -126,6 +127,19 @@ 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', () => {
@@ -256,4 +270,19 @@ 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()
+      })
+    )
+  })
 })