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,3 +1,26 @@
+<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)
+
+
+### Chores
+
+* remove peer-info usage on topology ([#42](https://github.com/libp2p/js-interfaces/issues/42)) ([79a7843](https://github.com/libp2p/js-interfaces/commit/79a7843))
+* update content and peer routing interfaces removing peer-info ([#43](https://github.com/libp2p/js-interfaces/issues/43)) ([d2032e6](https://github.com/libp2p/js-interfaces/commit/d2032e6))
+
+
+### Features
+
+* peer-discovery not using peer-info ([5792b13](https://github.com/libp2p/js-interfaces/commit/5792b13))
+
+
+### 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.2.8"></a>
 ## [0.2.8](https://github.com/libp2p/js-interfaces/compare/v0.2.7...v0.2.8) (2020-04-21)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-interfaces",
-  "version": "0.2.8",
+  "version": "0.3.0",
   "description": "Interfaces for JS Libp2p",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -39,6 +39,7 @@
     "chai": "^4.2.0",
     "chai-checkmark": "^1.0.1",
     "class-is": "^1.1.0",
+    "delay": "^4.3.0",
     "detect-node": "^2.0.4",
     "dirty-chai": "^2.0.1",
     "err-code": "^2.0.0",
@@ -47,6 +48,7 @@
     "it-pipe": "^1.0.1",
     "libp2p-tcp": "^0.14.1",
     "multiaddr": "^7.4.3",
+    "p-defer": "^3.0.0",
     "p-limit": "^2.3.0",
     "p-wait-for": "^3.1.0",
     "peer-id": "^0.13.11",

src/content-routing/README.md

@@ -30,6 +30,32 @@ TBD
 
 A valid (read: that follows this abstraction) Content Routing module must implement the following API.
 
-### `.findProviders`
+### findProviders
 
-### `.provide`
+- `findProviders(cid)`
+
+Find peers in the network that can provide a specific value, given a key.
+
+**Parameters**
+- [CID](https://github.com/multiformats/js-cid)
+
+**Returns**
+
+It returns an `AsyncIterable` containing the identification and addresses of the peers providing the given key, as follows:
+
+`AsyncIterable<{ id: PeerId, addrs: Multiaddr[] }>`
+
+### provide
+
+- `provide(cid)`
+
+Announce to the network that we are providing the given value.
+
+**Parameters**
+- [CID](https://github.com/multiformats/js-cid)
+
+**Returns**
+
+It returns a promise that is resolved on the success of the operation.
+
+`Promise<void>`

src/peer-discovery/README.md

@@ -70,6 +70,9 @@ It returns a `Promise`
 
 ### discoverying peers
 
-- `discovery.on('peer', (peerInfo) => {})`
+- `discovery.on('peer', (peerData) => {})`
 
-Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info).
+Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties:
+
+- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
+- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`

src/peer-discovery/tests/index.js

@@ -1,17 +1,31 @@
 /* eslint-env mocha */
 'use strict'
 
+const chai = require('chai')
+const expect = chai.expect
+chai.use(require('dirty-chai'))
+
+const multiaddr = require('multiaddr')
+const PeerId = require('peer-id')
+
+const delay = require('delay')
+const pDefer = require('p-defer')
+
 module.exports = (common) => {
   describe('interface-peer-discovery', () => {
     let discovery
 
-    before(async () => {
+    beforeEach(async () => {
       discovery = await common.setup()
     })
 
-    after(() => common.teardown && common.teardown())
+    afterEach('ensure discovery was stopped', async () => {
+      await discovery.stop()
 
-    afterEach('ensure discovery was stopped', () => discovery.stop())
+      discovery.removeAllListeners()
+
+      common.teardown && common.teardown()
+    })
 
     it('can start the service', async () => {
       await discovery.start()
@@ -30,5 +44,49 @@ module.exports = (common) => {
       await discovery.start()
       await discovery.start()
     })
+
+    it('should emit a peer event after start', async () => {
+      const defer = pDefer()
+      await discovery.start()
+
+      discovery.on('peer', ({ id, multiaddrs }) => {
+        expect(id).to.exist()
+        expect(PeerId.isPeerId(id)).to.eql(true)
+        expect(multiaddrs).to.exist()
+
+        multiaddrs.forEach((m) => expect(multiaddr.isMultiaddr(m)).to.eql(true))
+
+        defer.resolve()
+      })
+
+      await defer.promise
+    })
+
+    it('should not receive a peer event before start', async () => {
+      discovery.on('peer', () => {
+        throw new Error('should not receive a peer event before start')
+      })
+
+      await delay(2000)
+    })
+
+    it('should not receive a peer event after stop', async () => {
+      const deferStart = pDefer()
+
+      await discovery.start()
+
+      discovery.on('peer', () => {
+        deferStart.resolve()
+      })
+
+      await deferStart.promise
+      await discovery.stop()
+
+      discovery.on('peer', () => {
+        throw new Error('should not receive a peer event after stop')
+      })
+
+      await delay(2000)
+    })
   })
 }

src/peer-routing/README.md

@@ -30,12 +30,17 @@ TBD
 
 A valid (read: that follows this abstraction) Peer Routing module must implement the following API.
 
-### `.findPeers` - Find peers 'responsible' or 'closest' to a given key
+### findPeer
 
-- `Node.js` peerRouting.findPeers(key, function (err, peersPriorityQueue) {})
+- `findPeer(peerId)`
 
-In a peer to peer context, the concept of 'responsability' or 'closeness' for a given key translates to having a way to find deterministically or that at least there is a significant overlap between searches, the same group of peers when searching for the same given key.
+Query the network for all multiaddresses associated with a `PeerId`.
 
-This method will query the network (route it) and return a Priority Queue datastructe with a list of PeerInfo objects, ordered by 'closeness'.
+**Parameters**
+- [peerId](https://github.com/libp2p/js-peer-id).
 
-key is a multihash
+**Returns**
+
+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, addrs: Multiaddr[] }>`

src/topology/README.md

@@ -56,8 +56,8 @@ const toplogy = new MulticodecTopology({
   max: 50,
   multicodecs: ['/echo/1.0.0'],
   handlers: {
-    onConnect: (peerInfo, conn) => {},
+    onConnect: (peerId, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -69,8 +69,8 @@ The `MulticodecTopology` extends the `Topology`, which makes the `Topology` API
 ###  Topology
 
 - `Topology`
-  - `peers<Map<string, PeerInfo>>`: A Map of peers belonging to the topology.
+  - `peers<Map<string, PeerId>>`: A Map of peers belonging to the topology.
-  - `disconnect<function(PeerInfo)>`: Called when a peer has been disconnected
+  - `disconnect<function(PeerId)>`: Called when a peer has been disconnected
 
 #### Constructor
 
@@ -79,8 +79,8 @@ const toplogy = new Topology({
   min: 0,
   max: 50,
   handlers: {
-    onConnect: (peerInfo, conn) => {},
+    onConnect: (peerId, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -95,27 +95,27 @@ const toplogy = new Topology({
 
 #### Set a peer
 
-- `topology.peers.set(id, peerInfo)`
+- `topology.peers.set(id, peerId)`
 
 Add a peer to the topology.
 
 **Parameters**
 - `id` is the `string` that identifies the peer to add.
-- `peerInfo` is the [PeerInfo][peer-info] of the peer to add.
+- `peerId` is the [PeerId][peer-id] of the peer to add.
 
 #### Notify about a peer disconnected event
 
-- `topology.disconnect(peerInfo)`
+- `topology.disconnect(peerId)`
 
 **Parameters**
-- `peerInfo` is the [PeerInfo][peer-info] of the peer disconnected.
+- `peerId` is the [PeerId][peer-id] of the peer disconnected.
 
 ###  Multicodec Topology
 
 - `MulticodecTopology`
   - `registrar<Registrar>`: The `Registrar` of the topology. This is set by the `Registrar` during registration.
-  - `peers<Map<string, PeerInfo>>`: The Map of peers that belong to the topology
+  - `peers<Map<string, PeerId>>`: The Map of peers that belong to the topology
-  - `disconnect<function(PeerInfo)>`: Disconnects a peer from the topology.
+  - `disconnect<function(PeerId)>`: Disconnects a peer from the topology.
 
 #### Constructor
 
@@ -125,8 +125,8 @@ const toplogy = new MulticodecTopology({
   max: 50,
   multicodecs: ['/echo/1.0.0'],
   handlers: {
-    onConnect: (peerInfo, conn) => {},
+    onConnect: (peerId, conn) => {},
-    onDisconnect: (peerInfo) => {}
+    onDisconnect: (peerId) => {}
   }
 })
 ```
@@ -139,3 +139,5 @@ const toplogy = new MulticodecTopology({
   - `handlers` is an optional `Object` containing the handler called when a peer is connected or disconnected.
     - `onConnect` is a `function` called everytime a peer is connected in the topology context.
     - `onDisconnect` is a `function` called everytime a peer is disconnected in the topology context.
+
+[peer-id]: https://github.com/libp2p/js-peer-id

src/topology/index.js

@@ -26,7 +26,11 @@ class Topology {
     this._onConnect = handlers.onConnect || noop
     this._onDisconnect = handlers.onDisconnect || noop
 
-    this.peers = new Map()
+    /**
+     * Set of peers that support the protocol.
+     * @type {Set<string>}
+     */
+    this.peers = new Set()
   }
 
   set registrar (registrar) {
@@ -35,11 +39,11 @@ class Topology {
 
   /**
    * Notify about peer disconnected event.
-   * @param {PeerInfo} peerInfo
+   * @param {PeerId} peerId
    * @returns {void}
    */
-  disconnect (peerInfo) {
+  disconnect (peerId) {
-    this._onDisconnect(peerInfo)
+    this._onDisconnect(peerId)
   }
 }
 

src/topology/multicodec-topology.js

@@ -55,20 +55,20 @@ class MulticodecTopology extends Topology {
 
   /**
    * Update topology.
-   * @param {Array<PeerInfo>} peerInfoIterable
+   * @param {Array<{id: PeerId, multiaddrs: Array<Multiaddr>, protocols: Array<string>}>} peerDataIterable
    * @returns {void}
    */
-  _updatePeers (peerInfoIterable) {
+  _updatePeers (peerDataIterable) {
-    for (const peerInfo of peerInfoIterable) {
+    for (const { id, protocols } of peerDataIterable) {
-      if (this.multicodecs.filter(multicodec => peerInfo.protocols.has(multicodec)).length) {
+      if (this.multicodecs.filter(multicodec => protocols.includes(multicodec)).length) {
         // Add the peer regardless of whether or not there is currently a connection
-        this.peers.set(peerInfo.id.toB58String(), peerInfo)
+        this.peers.add(id.toB58String())
         // If there is a connection, call _onConnect
-        const connection = this._registrar.getConnection(peerInfo)
+        const connection = this._registrar.getConnection(id)
-        connection && this._onConnect(peerInfo, connection)
+        connection && this._onConnect(id, connection)
       } else {
         // Remove any peers we might be tracking that are no longer of value to us
-        this.peers.delete(peerInfo.id.toB58String())
+        this.peers.delete(id.toB58String())
       }
     }
   }
@@ -76,22 +76,23 @@ class MulticodecTopology extends Topology {
   /**
    * Check if a new peer support the multicodecs for this topology.
    * @param {Object} props
-   * @param {PeerInfo} props.peerInfo
+   * @param {PeerId} props.peerId
    * @param {Array<string>} props.protocols
    */
-  _onProtocolChange ({ peerInfo, protocols }) {
+  _onProtocolChange ({ peerId, protocols }) {
-    const existingPeer = this.peers.get(peerInfo.id.toB58String())
+    const hadPeer = this.peers.has(peerId.toB58String())
     const hasProtocol = protocols.filter(protocol => this.multicodecs.includes(protocol))
 
     // Not supporting the protocol anymore?
-    if (existingPeer && hasProtocol.length === 0) {
+    if (hadPeer && hasProtocol.length === 0) {
-      this._onDisconnect(peerInfo)
+      this._onDisconnect(peerId)
     }
 
     // New to protocol support
     for (const protocol of protocols) {
       if (this.multicodecs.includes(protocol)) {
-        this._updatePeers([peerInfo])
+        const peerData = this._registrar.peerStore.get(peerId)
+        this._updatePeers([peerData])
         return
       }
     }

src/topology/tests/multicodec-topology.js

@@ -8,19 +8,18 @@ chai.use(require('dirty-chai'))
 const sinon = require('sinon')
 
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
+
 const peers = require('../../utils/peers')
 
 module.exports = (test) => {
   describe('multicodec topology', () => {
-    let topology, peer
+    let topology, id
 
     beforeEach(async () => {
       topology = await test.setup()
       if (!topology) throw new Error('missing multicodec topology')
 
-      const id = await PeerId.createFromJSON(peers[0])
+      id = await PeerId.createFromJSON(peers[0])
-      peer = await PeerInfo.create(id)
     })
 
     afterEach(async () => {
@@ -38,7 +37,7 @@ module.exports = (test) => {
 
     it('should trigger "onDisconnect" on peer disconnected', () => {
       sinon.spy(topology, '_onDisconnect')
-      topology.disconnect(peer)
+      topology.disconnect(id)
 
       expect(topology._onDisconnect.callCount).to.equal(1)
     })
@@ -47,13 +46,16 @@ module.exports = (test) => {
       sinon.spy(topology, '_updatePeers')
       expect(topology.peers.size).to.eql(0)
 
-      const id2 = await PeerId.createFromJSON(peers[1])
-      const peer2 = await PeerInfo.create(id2)
-      topology.multicodecs.forEach((m) => peer2.protocols.add(m))
-
       const peerStore = topology._registrar.peerStore
+
+      const id2 = await PeerId.createFromJSON(peers[1])
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: Array.from(topology.multicodecs)
+      })
+
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: Array.from(topology.multicodecs)
       })
 
@@ -65,28 +67,34 @@ module.exports = (test) => {
       sinon.spy(topology, '_onDisconnect')
       expect(topology.peers.size).to.eql(0)
 
-      const id2 = await PeerId.createFromJSON(peers[1])
-      const peer2 = await PeerInfo.create(id2)
-      topology.multicodecs.forEach((m) => peer2.protocols.add(m))
-
       const peerStore = topology._registrar.peerStore
+
+      const id2 = await PeerId.createFromJSON(peers[1])
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: Array.from(topology.multicodecs)
+      })
+
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: Array.from(topology.multicodecs)
       })
 
       expect(topology.peers.size).to.eql(1)
 
-      topology.multicodecs.forEach((m) => peer2.protocols.delete(m))
+      peerStore.peers.set(id2.toB58String(), {
+        id: id2,
+        protocols: []
+      })
       // Peer does not support the protocol anymore
       peerStore.emit('change:protocols', {
-        peerInfo: peer2,
+        peerId: id2,
         protocols: []
       })
 
       expect(topology.peers.size).to.eql(1)
       expect(topology._onDisconnect.callCount).to.equal(1)
-      expect(topology._onDisconnect.calledWith(peer2)).to.equal(true)
+      expect(topology._onDisconnect.calledWith(id2)).to.equal(true)
     })
   })
 }

src/topology/tests/topology.js

@@ -8,19 +8,17 @@ chai.use(require('dirty-chai'))
 const sinon = require('sinon')
 
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
 const peers = require('../../utils/peers')
 
 module.exports = (test) => {
   describe('topology', () => {
-    let topology, peer
+    let topology, id
 
     beforeEach(async () => {
       topology = await test.setup()
       if (!topology) throw new Error('missing multicodec topology')
 
-      const id = await PeerId.createFromJSON(peers[0])
+      id = await PeerId.createFromJSON(peers[0])
-      peer = await PeerInfo.create(id)
     })
 
     afterEach(async () => {
@@ -38,7 +36,7 @@ module.exports = (test) => {
 
     it('should trigger "onDisconnect" on peer disconnected', () => {
       sinon.spy(topology, '_onDisconnect')
-      topology.disconnect(peer)
+      topology.disconnect(id)
 
       expect(topology._onDisconnect.callCount).to.equal(1)
     })

test/peer-discovery/compliance.spec.js

@@ -5,13 +5,20 @@ const tests = require('../../src/peer-discovery/tests')
 const MockDiscovery = require('./mock-discovery')
 
 describe('compliance tests', () => {
+  let intervalId
+
   tests({
-    async setup () {
+    setup () {
-      await new Promise(resolve => setTimeout(resolve, 10))
+      const mockDiscovery = new MockDiscovery({
-      return new MockDiscovery()
+        discoveryDelay: 1
+      })
+
+      intervalId = setInterval(mockDiscovery._discoverPeer, 1000)
+
+      return mockDiscovery
     },
-    async teardown () {
+    teardown () {
-      await new Promise(resolve => setTimeout(resolve, 10))
+      clearInterval(intervalId)
     }
   })
 })

test/peer-discovery/mock-discovery.js

@@ -2,8 +2,8 @@
 
 const { EventEmitter } = require('events')
 
+const multiaddr = require('multiaddr')
 const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
 
 /**
  * Emits 'peer' events on discovery.
@@ -37,10 +37,12 @@ class MockDiscovery extends EventEmitter {
     if (!this._isRunning) return
 
     const peerId = await PeerId.create({ bits: 512 })
-    const peerInfo = new PeerInfo(peerId)
 
     this._timer = setTimeout(() => {
-      this.emit('peer', peerInfo)
+      this.emit('peer', {
+        id: peerId,
+        multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
+      })
     }, this.options.discoveryDelay || 1000)
   }
 }

test/topology/mock-peer-store.js

@@ -7,6 +7,10 @@ class MockPeerStore extends EventEmitter {
     super()
     this.peers = peers
   }
+
+  get (peerId) {
+    return this.peers.get(peerId.toB58String())
+  }
 }
 
 module.exports = MockPeerStore

test/topology/multicodec-topology.spec.js

@@ -21,7 +21,8 @@ describe('multicodec topology compliance tests', () => {
       })
 
       if (!registrar) {
-        const peerStore = new MockPeerStore([])
+        const peers = new Map()
+        const peerStore = new MockPeerStore(peers)
 
         registrar = {
           peerStore,