chore: release version v0.2.4

* fix: dependencies for tests should not be needed by who requires the tests

* chore: address review

CHANGELOG.md

@@ -1,3 +1,43 @@
+<a name="0.2.4"></a>
+## [0.2.4](https://github.com/libp2p/js-interfaces/compare/v0.2.3...v0.2.4) (2020-02-04)
+
+
+### Bug Fixes
+
+* dependencies for tests should not be needed by who requires the tests ([#18](https://github.com/libp2p/js-interfaces/issues/18)) ([c5b724a](https://github.com/libp2p/js-interfaces/commit/c5b724a))
+
+
+
+<a name="0.2.3"></a>
+## [0.2.3](https://github.com/libp2p/js-interfaces/compare/v0.2.2...v0.2.3) (2020-01-21)
+
+
+### Bug Fixes
+
+* **transport:** make close listener test more resilient ([#21](https://github.com/libp2p/js-interfaces/issues/21)) ([2de533e](https://github.com/libp2p/js-interfaces/commit/2de533e))
+
+
+
+<a name="0.2.2"></a>
+## [0.2.2](https://github.com/libp2p/js-interfaces/compare/v0.2.1...v0.2.2) (2020-01-17)
+
+
+### Bug Fixes
+
+* **connection:** dont require remoteAddr on creation ([#20](https://github.com/libp2p/js-interfaces/issues/20)) ([5967834](https://github.com/libp2p/js-interfaces/commit/5967834))
+
+
+
+<a name="0.2.1"></a>
+## [0.2.1](https://github.com/libp2p/js-interfaces/compare/v0.2.0...v0.2.1) (2019-12-28)
+
+
+### Features
+
+* add crypto transmission error ([#17](https://github.com/libp2p/js-interfaces/issues/17)) ([d98bb23](https://github.com/libp2p/js-interfaces/commit/d98bb23))
+
+
+
 <a name="0.2.0"></a>
 # [0.2.0](https://github.com/libp2p/js-interfaces/compare/v0.1.7...v0.2.0) (2019-12-20)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-interfaces",
-  "version": "0.2.0",
+  "version": "0.2.4",
   "description": "Interfaces for JS Libp2p",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -35,7 +35,6 @@
   "dependencies": {
     "abort-controller": "^3.0.0",
     "abortable-iterator": "^2.1.0",
-    "async-iterator-to-pull-stream": "^1.3.0",
     "chai": "^4.2.0",
     "chai-checkmark": "^1.0.1",
     "class-is": "^1.1.0",
@@ -43,20 +42,20 @@
     "dirty-chai": "^2.0.1",
     "err-code": "^2.0.0",
     "it-goodbye": "^2.0.1",
+    "it-pair": "^1.0.0",
+    "it-pipe": "^1.0.1",
     "libp2p-tcp": "^0.14.1",
     "multiaddr": "^7.1.0",
-    "p-limit": "^2.2.1",
+    "p-limit": "^2.2.2",
     "p-wait-for": "^3.1.0",
     "peer-id": "^0.13.3",
+    "peer-info": "^0.17.0",
     "sinon": "^7.5.0",
     "streaming-iterables": "^4.1.0"
   },
   "devDependencies": {
-    "aegir": "^20.4.1",
+    "aegir": "^20.5.0",
-    "it-handshake": "^1.0.0",
+    "it-handshake": "^1.0.1"
-    "it-pair": "^1.0.0",
-    "it-pipe": "^1.0.1",
-    "peer-info": "^0.17.0"
   },
   "contributors": [
     "Alan Shaw <alan.shaw@protocol.ai>",
@@ -66,6 +65,7 @@
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Greg Zuro <gregzuro@users.noreply.github.com>",
     "Jacob Heun <jacobheun@gmail.com>",
+    "Jacob Heun <jacobheun@Jacobs-MacBook-Pro.local>",
     "James Ray <16969914+jamesray1@users.noreply.github.com>",
     "Jeffrey Hulten <jhulten@gmail.com>",
     "João Santos <joaosantos15@users.noreply.github.com>",

src/connection/README.md

@@ -110,7 +110,7 @@ const conn = new Connection({
 Creates a new Connection instance.
 
 `localAddr` is the optional [multiaddr](https://github.com/multiformats/multiaddr) address used by the local peer to reach the remote.
-`remoteAddr` is the [multiaddr](https://github.com/multiformats/multiaddr) address used to communicate with the remote peer.
+`remoteAddr` is the optional [multiaddr](https://github.com/multiformats/multiaddr) address used to communicate with the remote peer.
 `localPeer` is the [PeerId](https://github.com/libp2p/js-peer-id) of the local peer.
 `remotePeer` is the [PeerId](https://github.com/libp2p/js-peer-id) of the remote peer.
 `newStream` is the `function` responsible for getting a new muxed+multistream-selected stream.

src/connection/connection.js

@@ -18,7 +18,7 @@ class Connection {
    * Creates an instance of Connection.
    * @param {object} properties properties of the connection.
    * @param {multiaddr} [properties.localAddr] local multiaddr of the connection if known.
-   * @param {multiaddr} properties.remoteAddr remote multiaddr of the connection.
+   * @param {multiaddr} [properties.remoteAddr] remote multiaddr of the connection.
    * @param {PeerId} properties.localPeer local peer-id.
    * @param {PeerId} properties.remotePeer remote peer-id.
    * @param {function} properties.newStream new stream muxer function.
@@ -34,7 +34,6 @@ class Connection {
    */
   constructor ({ localAddr, remoteAddr, localPeer, remotePeer, newStream, close, getStreams, stat }) {
     localAddr && assert(multiaddr.isMultiaddr(localAddr), 'localAddr must be an instance of multiaddr')
-    assert(multiaddr.isMultiaddr(remoteAddr), 'remoteAddr must be an instance of multiaddr')
     assert(PeerId.isPeerId(localPeer), 'localPeer must be an instance of peer-id')
     assert(PeerId.isPeerId(remotePeer), 'remotePeer must be an instance of peer-id')
     assert(typeof newStream === 'function', 'new stream must be a function')

src/crypto/README.md

@@ -85,6 +85,7 @@ Common crypto errors come with the interface, and can be imported directly. All
 ```js
 const {
   InvalidCryptoExchangeError,
+  InvalidCryptoTransmissionError,
   UnexpectedPeerError
 } = require('libp2p-interfaces/src/crypto/errors')
 
@@ -95,4 +96,5 @@ console.log(error.code === UnexpectedPeerError.code) // true
 ### Error Types
 
 - `InvalidCryptoExchangeError` - Should be thrown when a peer provides data that is insufficient to finish the crypto exchange.
+- `InvalidCryptoTransmissionError` - Should be thrown when an error occurs during encryption/decryption.
 - `UnexpectedPeerError` - Should be thrown when the expected peer id does not match the peer id determined via the crypto exchange.

src/crypto/errors.js

@@ -22,7 +22,19 @@ class InvalidCryptoExchangeError extends Error {
   }
 }
 
+class InvalidCryptoTransmissionError extends Error {
+  constructor (message = 'Invalid crypto transmission') {
+    super(message)
+    this.code = InvalidCryptoTransmissionError.code
+  }
+
+  static get code () {
+    return 'ERR_INVALID_CRYPTO_TRANSMISSION'
+  }
+}
+
 module.exports = {
   UnexpectedPeerError,
-  InvalidCryptoExchangeError
+  InvalidCryptoExchangeError,
+  InvalidCryptoTransmissionError
 }

src/transport/tests/listen-test.js

@@ -70,7 +70,7 @@ module.exports = (common) => {
       ])
 
       // Give the listener a chance to finish its upgrade
-      await new Promise(resolve => setTimeout(resolve, 0))
+      await pWaitFor(() => listenerConns.length === 2)
 
       // Wait for the data send and close to finish
       await Promise.all([

test/connection/index.spec.js

@@ -0,0 +1,48 @@
+/* eslint-env mocha */
+'use strict'
+
+const { Connection } = require('../../src/connection')
+const peers = require('../../src/utils/peers')
+const PeerId = require('peer-id')
+const pair = require('it-pair')
+
+describe('connection tests', () => {
+  it('should not require local or remote addrs', async () => {
+    const [localPeer, remotePeer] = await Promise.all([
+      PeerId.createFromJSON(peers[0]),
+      PeerId.createFromJSON(peers[1])
+    ])
+    const openStreams = []
+    let streamId = 0
+
+    return new Connection({
+      localPeer,
+      remotePeer,
+      stat: {
+        timeline: {
+          open: Date.now() - 10,
+          upgraded: Date.now()
+        },
+        direction: 'outbound',
+        encryption: '/secio/1.0.0',
+        multiplexer: '/mplex/6.7.0'
+      },
+      newStream: (protocols) => {
+        const id = streamId++
+        const stream = pair()
+
+        stream.close = () => stream.sink([])
+        stream.id = id
+
+        openStreams.push(stream)
+
+        return {
+          stream,
+          protocol: protocols[0]
+        }
+      },
+      close: () => {},
+      getStreams: () => openStreams
+    })
+  })
+})