chore: release version v0.3.0

* chore: remove peer-info usage on topology

BREAKING CHANGE: topology api now uses peer-id instead of peer-info

CHANGELOG.md

@@ -1,65 +1,3 @@
-<a name="0.4.1"></a>
-## [0.4.1](https://github.com/libp2p/js-interfaces/compare/v0.4.0...v0.4.1) (2020-08-11)
-
-
-
-<a name="0.4.0"></a>
-# [0.4.0](https://github.com/libp2p/js-interfaces/compare/v0.3.2...v0.4.0) (2020-08-10)
-
-
-### Chores
-
-* update deps ([#57](https://github.com/libp2p/js-interfaces/issues/57)) ([75f6777](https://github.com/libp2p/js-interfaces/commit/75f6777))
-
-
-### BREAKING CHANGES
-
-* - The peer id dep of this module has replaced node Buffers with Uint8Arrays
-
-* chore: update gh deps
-
-
-
-<a name="0.3.2"></a>
-## [0.3.2](https://github.com/libp2p/js-interfaces/compare/v0.3.1...v0.3.2) (2020-07-15)
-
-
-### Features
-
-* record interface ([#52](https://github.com/libp2p/js-interfaces/issues/52)) ([1cc943e](https://github.com/libp2p/js-interfaces/commit/1cc943e))
-
-
-
-<a name="0.3.1"></a>
-## [0.3.1](https://github.com/libp2p/js-interfaces/compare/v0.2.8...v0.3.1) (2020-07-03)
-
-
-### Bug Fixes
-
-* content and peer routing multiaddrs property ([#49](https://github.com/libp2p/js-interfaces/issues/49)) ([9fbf9d0](https://github.com/libp2p/js-interfaces/commit/9fbf9d0))
-* peer-routing typo ([#47](https://github.com/libp2p/js-interfaces/issues/47)) ([9a8f375](https://github.com/libp2p/js-interfaces/commit/9a8f375))
-* reconnect should trigger topology on connect if protocol stored ([#54](https://github.com/libp2p/js-interfaces/issues/54)) ([e10a154](https://github.com/libp2p/js-interfaces/commit/e10a154))
-
-
-### Chores
-
-* remove peer-info usage on topology ([#42](https://github.com/libp2p/js-interfaces/issues/42)) ([a55c7c4](https://github.com/libp2p/js-interfaces/commit/a55c7c4))
-* update content and peer routing interfaces removing peer-info ([#43](https://github.com/libp2p/js-interfaces/issues/43)) ([87e2e89](https://github.com/libp2p/js-interfaces/commit/87e2e89))
-
-
-### Features
-
-* peer-discovery not using peer-info ([bdd2502](https://github.com/libp2p/js-interfaces/commit/bdd2502))
-
-
-### BREAKING CHANGES
-
-* topology api now uses peer-id instead of peer-info
-* content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
-* peer-discovery emits object with id and multiaddrs properties
-
-
-
 <a name="0.3.0"></a>
 # [0.3.0](https://github.com/libp2p/js-interfaces/compare/v0.2.8...v0.3.0) (2020-04-21)
 

README.md

@@ -18,7 +18,6 @@
 - [Crypto](./src/crypto)
 - [Peer Discovery](./src/peer-discovery)
 - [Peer Routing](./src/peer-routing)
-- [Record](./src/record)
 - [Stream Muxer](./src/stream-muxer)
 - [Topology](./src/topology)
 - [Transport](./src/transport)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-interfaces",
-  "version": "0.4.1",
+  "version": "0.3.0",
   "description": "Interfaces for JS Libp2p",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -45,18 +45,19 @@
     "err-code": "^2.0.0",
     "it-goodbye": "^2.0.1",
     "it-pair": "^1.0.0",
-    "it-pipe": "^1.1.0",
+    "it-pipe": "^1.0.1",
-    "libp2p-tcp": "^0.15.0",
+    "libp2p-tcp": "^0.14.1",
-    "multiaddr": "^8.0.0",
+    "multiaddr": "^7.4.3",
     "p-defer": "^3.0.0",
     "p-limit": "^2.3.0",
     "p-wait-for": "^3.1.0",
-    "peer-id": "^0.14.0",
+    "peer-id": "^0.13.11",
+    "peer-info": "^0.17.0",
     "sinon": "^9.0.2",
-    "streaming-iterables": "^5.0.2"
+    "streaming-iterables": "^4.1.0"
   },
   "devDependencies": {
-    "aegir": "^25.0.0",
+    "aegir": "^21.9.0",
     "it-handshake": "^1.0.1"
   },
   "contributors": [

src/content-routing/README.md

@@ -43,7 +43,7 @@ Find peers in the network that can provide a specific value, given a key.
 
 It returns an `AsyncIterable` containing the identification and addresses of the peers providing the given key, as follows:
 
-`AsyncIterable<{ id: PeerId, multiaddrs: Multiaddr[] }>`
+`AsyncIterable<{ id: PeerId, addrs: Multiaddr[] }>`
 
 ### provide
 

src/peer-routing/README.md

@@ -43,4 +43,4 @@ Query the network for all multiaddresses associated with a `PeerId`.
 
 It returns the [peerId](https://github.com/libp2p/js-peer-id) together with the known peers [multiaddrs](https://github.com/multiformats/js-multiaddr), as follows:
 
-`Promise<{ id: PeerId, multiaddrs: Multiaddr[] }>`
+`Promise<{ id: PeerId, addrs: Multiaddr[] }>`

src/record/README.md

@@ -1,75 +0,0 @@
-interface-record
-==================
-
-A libp2p node needs to store data in a public location (e.g. a DHT), or rely on potentially untrustworthy intermediaries to relay information. Libp2p provides an all-purpose data container called **envelope**, which includes a signature of the data, so that it its authenticity can be verified.
-
-The record represents the data that will be stored inside the **envelope** when distributing records across the network. The `interface-record` aims to guarantee that any type of record created is compliant with the libp2p **envelope**.
-
-Taking into account that a record might be used in different contexts, an **envelope** signature made for a specific purpose **must not** be considered valid for a different purpose. Accordingly, each record has a short and descriptive string representing the record use case, known as **domain**. The data to be signed will be prepended with the domain string, in order to create a domain signature.
-
-A record can also contain a Buffer codec (ideally registered as a [multicodec](https://github.com/multiformats/multicodec)). This codec will prefix the record data in the **envelope** , so that it can be deserialized deterministically.
-
-## Usage
-
-```js
-const tests = require('libp2p-interfaces/src/record/tests')
-describe('your record', () => {
-  tests({
-    async setup () {
-      return YourRecord
-    },
-    async teardown () {
-      // cleanup resources created by setup()
-    }
-  })
-})
-```
-
-## Create Record
-
-```js
-const multicodec = require('multicodec')
-const Record = require('libp2p-interfaces/src/record')
-// const Protobuf = require('./record.proto')
-
-const ENVELOPE_DOMAIN_PEER_RECORD = 'libp2p-peer-record'
-const ENVELOPE_PAYLOAD_TYPE_PEER_RECORD = Buffer.from('0301', 'hex')
-
-class PeerRecord extends Record {
-  constructor (peerId, multiaddrs, seqNumber) {
-    super (ENVELOPE_DOMAIN_PEER_RECORD, ENVELOPE_PAYLOAD_TYPE_PEER_RECORD)
-  }
-
-  marshal () {
-    // Implement and return using Protobuf
-  }
-
-  equals (other) {
-    // Verify
-  }
-}
-```
-
-## API
-
-### marshal
-
-- `record.marshal()`
-
-Marshal a record to be used in a libp2p envelope.
-
-**Returns**
-
-It returns a `Protobuf` containing the record data.
-
-### equals
-
-- `record.equals(other)`
-
-Verifies if the other Record is identical to this one.
-
-**Parameters**
-- other is a `Record` to compare with the current instance.
-
-**Returns**
-- `boolean`

src/record/index.js

@@ -1,35 +0,0 @@
-'use strict'
-
-const errcode = require('err-code')
-
-/**
- * Record is the base implementation of a record that can be used as the payload of a libp2p envelope.
- */
-class Record {
-  /**
-   * @constructor
-   * @param {String} domain signature domain
-   * @param {Buffer} codec identifier of the type of record
-   */
-  constructor (domain, codec) {
-    this.domain = domain
-    this.codec = codec
-  }
-
-  /**
-   * Marshal a record to be used in an envelope.
-   */
-  marshal () {
-    throw errcode(new Error('marshal must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
-  }
-
-  /**
-   * Verifies if the other provided Record is identical to this one.
-   * @param {Record} other
-   */
-  equals (other) {
-    throw errcode(new Error('equals must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
-  }
-}
-
-module.exports = Record

src/record/tests/index.js

@@ -1,35 +0,0 @@
-/* eslint-env mocha */
-
-'use strict'
-
-const chai = require('chai')
-const expect = chai.expect
-chai.use(require('dirty-chai'))
-
-module.exports = (test) => {
-  describe('record', () => {
-    let record
-
-    beforeEach(async () => {
-      record = await test.setup()
-      if (!record) throw new Error('missing record')
-    })
-
-    afterEach(() => test.teardown())
-
-    it('has domain and codec', () => {
-      expect(record.domain).to.exist()
-      expect(record.codec).to.exist()
-    })
-
-    it('is able to marshal', () => {
-      const rawData = record.marshal()
-      expect(Buffer.isBuffer(rawData)).to.eql(true)
-    })
-
-    it('is able to compare two records', () => {
-      const equals = record.equals(record)
-      expect(equals).to.eql(true)
-    })
-  })
-}

src/topology/multicodec-topology.js

@@ -43,13 +43,11 @@ class MulticodecTopology extends Topology {
     this._registrar = undefined
 
     this._onProtocolChange = this._onProtocolChange.bind(this)
-    this._onPeerConnect = this._onPeerConnect.bind(this)
   }
 
   set registrar (registrar) {
     this._registrar = registrar
     this._registrar.peerStore.on('change:protocols', this._onProtocolChange)
-    this._registrar.connectionManager.on('peer:connect', this._onPeerConnect)
 
     // Update topology peers
     this._updatePeers(this._registrar.peerStore.peers.values())
@@ -99,25 +97,6 @@ class MulticodecTopology extends Topology {
       }
     }
   }
-
-  /**
-   * Verify if a new connected peer has a topology multicodec and call _onConnect.
-   * @param {Connection} connection
-   * @returns {void}
-   */
-  _onPeerConnect (connection) {
-    const peerId = connection.remotePeer
-    const protocols = this._registrar.peerStore.protoBook.get(peerId)
-
-    if (!protocols) {
-      return
-    }
-
-    if (this.multicodecs.find(multicodec => protocols.includes(multicodec))) {
-      this.peers.add(peerId.toB58String())
-      this._onConnect(peerId, connection)
-    }
-  }
 }
 
 module.exports = withIs(MulticodecTopology, { className: 'MulticodecTopology', symbolName: '@libp2p/js-interfaces/topology/multicodec-topology' })

src/topology/tests/multicodec-topology.js

@@ -96,38 +96,5 @@ module.exports = (test) => {
       expect(topology._onDisconnect.callCount).to.equal(1)
       expect(topology._onDisconnect.calledWith(id2)).to.equal(true)
     })
-
-    it('should trigger "onConnect" when a peer connects and has one of the topology multicodecs in its known protocols', () => {
-      sinon.spy(topology, '_onConnect')
-      sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns(topology.multicodecs)
-
-      topology._registrar.connectionManager.emit('peer:connect', {
-        remotePeer: id
-      })
-
-      expect(topology._onConnect.callCount).to.equal(1)
-    })
-
-    it('should not trigger "onConnect" when a peer connects and has none of the topology multicodecs in its known protocols', () => {
-      sinon.spy(topology, '_onConnect')
-      sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns([])
-
-      topology._registrar.connectionManager.emit('peer:connect', {
-        remotePeer: id
-      })
-
-      expect(topology._onConnect.callCount).to.equal(0)
-    })
-
-    it('should not trigger "onConnect" when a peer connects and its protocols are not known', () => {
-      sinon.spy(topology, '_onConnect')
-      sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns(undefined)
-
-      topology._registrar.connectionManager.emit('peer:connect', {
-        remotePeer: id
-      })
-
-      expect(topology._onConnect.callCount).to.equal(0)
-    })
   })
 }

test/topology/mock-peer-store.js

@@ -6,9 +6,6 @@ class MockPeerStore extends EventEmitter {
   constructor (peers) {
     super()
     this.peers = peers
-    this.protoBook = {
-      get: () => {}
-    }
   }
 
   get (peerId) {

test/topology/multicodec-topology.spec.js

@@ -1,8 +1,6 @@
 /* eslint-env mocha */
 'use strict'
 
-const { EventEmitter } = require('events')
-
 const tests = require('../../src/topology/tests/multicodec-topology')
 const MulticodecTopology = require('../../src/topology/multicodec-topology')
 const MockPeerStore = require('./mock-peer-store')
@@ -25,11 +23,9 @@ describe('multicodec topology compliance tests', () => {
       if (!registrar) {
         const peers = new Map()
         const peerStore = new MockPeerStore(peers)
-        const connectionManager = new EventEmitter()
 
         registrar = {
           peerStore,
-          connectionManager,
           getConnection: () => { }
         }
       }