docs: update addressBook get and getMultiaddrsForPeer return values

CHANGELOG.md

@@ -1,23 +1,3 @@
-<a name="0.28.9"></a>
-## [0.28.9](https://github.com/libp2p/js-libp2p/compare/v0.28.8...v0.28.9) (2020-07-27)
-
-
-### Bug Fixes
-
-* ping multiaddr from peer not previously stored in peerstore ([#719](https://github.com/libp2p/js-libp2p/issues/719)) ([2440c87](https://github.com/libp2p/js-libp2p/commit/2440c87))
-
-
-
-<a name="0.28.8"></a>
-## [0.28.8](https://github.com/libp2p/js-libp2p/compare/v0.28.7...v0.28.8) (2020-07-20)
-
-
-### Bug Fixes
-
-* create dial target for peer with no known addrs ([#715](https://github.com/libp2p/js-libp2p/issues/715)) ([7da9ad4](https://github.com/libp2p/js-libp2p/commit/7da9ad4))
-
-
-
 <a name="0.28.7"></a>
 ## [0.28.7](https://github.com/libp2p/js-libp2p/compare/v0.28.6...v0.28.7) (2020-07-14)
 

README.md

@@ -23,8 +23,8 @@
   <a href="https://david-dm.org/libp2p/js-libp2p"><img src="https://david-dm.org/libp2p/js-libp2p.svg?style=flat-square" /></a>
   <a href="https://github.com/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
   <a href="https://github.com/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
-  <a href=""><img src="https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat-square" /></a>
-  <a href=""><img src="https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat-square" /></a>
+  <a href=""><img src="https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square" /></a>
+  <a href=""><img src="https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square" /></a>
   <br>
 </p>
 

examples/pubsub/message-filtering/1.js

@@ -1,82 +0,0 @@
-/* eslint-disable no-console */
-'use strict'
-
-const { Buffer } = require('buffer')
-const Libp2p = require('../../../')
-const TCP = require('libp2p-tcp')
-const Mplex = require('libp2p-mplex')
-const { NOISE } = require('libp2p-noise')
-const SECIO = require('libp2p-secio')
-const Gossipsub = require('libp2p-gossipsub')
-
-const createNode = async () => {
-  const node = await Libp2p.create({
-    addresses: {
-      listen: ['/ip4/0.0.0.0/tcp/0']
-    },
-    modules: {
-      transport: [TCP],
-      streamMuxer: [Mplex],
-      connEncryption: [NOISE, SECIO],
-      pubsub: Gossipsub
-    }
-  })
-
-  await node.start()
-  return node
-}
-
-(async () => {
-  const topic = 'fruit'
-
-  const [node1, node2, node3] = await Promise.all([
-    createNode(),
-    createNode(),
-    createNode(),
-  ])
-
-  // node1 conect to node2 and node2 conect to node3
-  node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
-  await node1.dial(node2.peerId)
-
-  node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
-  await node2.dial(node3.peerId)
-
-  //subscribe
-  await node1.pubsub.subscribe(topic, (msg) => {
-    console.log(`node1 received: ${msg.data.toString()}`)
-  })
-
-  await node2.pubsub.subscribe(topic, (msg) => {
-    console.log(`node2 received: ${msg.data.toString()}`)
-  })
-
-  await node3.pubsub.subscribe(topic, (msg) => {
-    console.log(`node3 received: ${msg.data.toString()}`)
-  })
-
-  const validateFruit = (msgTopic, peer, msg) => {
-    const fruit = msg.data.toString();
-    const validFruit = ['banana', 'apple', 'orange']
-    const valid = validFruit.includes(fruit);
-    return valid;
-  }
-
-  //validate fruit
-  node1.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-  node2.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-  node3.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-
-  // node1 publishes "fruits" every five seconds
-  var count = 0;
-  const myFruits = ['banana', 'apple', 'car', 'orange'];
-  // car is not a fruit !
-  setInterval(() => {
-    console.log('############## fruit ' + myFruits[count] + ' ##############')
-    node1.pubsub.publish(topic, Buffer.from(myFruits[count]))
-    count++
-    if (count == myFruits.length) {
-      count = 0
-    }
-  }, 5000)
-})()

examples/pubsub/message-filtering/README.md

@@ -1,108 +0,0 @@
-# Filter Messages
-
-To prevent undesired data from being propagated on the network, we can apply a filter to Gossipsub. Messages that fail validation in the filter will not be re-shared.
-
-## 1. Setting up a PubSub network with three nodes
-
-First, let's update our libp2p configuration with a pubsub implementation.
-
-```JavaScript
-const Libp2p = require('libp2p')
-const Gossipsub = require('libp2p-gossipsub')
-
-const node = await Libp2p.create({
-  addresses: {
-    listen: ['/ip4/0.0.0.0/tcp/0']
-  },
-  modules: {
-    transport: [ TCP ],
-    streamMuxer: [ Mplex ],
-    connEncryption: [ NOISE, SECIO ],
-    pubsub: Gossipsub
-  }
-})
-```
-
-Then, create three nodes and connect them together. In this example, we will connect the nodes in series. Node 1 connected with node 2 and node 2 connected with node 3.
-
-```JavaScript
-const [node1, node2, node3] = await Promise.all([
-  createNode(),
-  createNode(),
-  createNode(),
-])
-
-node1.peerStore.addressBook.set(node2.peerId, node2.multiaddrs)
-await node1.dial(node2.peerId)
-
-node2.peerStore.addressBook.set(node3.peerId, node3.multiaddrs)
-await node2.dial(node3.peerId)
-```
-
-Now we' can subscribe to the fruit topic and log incoming messages.
-
-```JavaScript
-const topic = 'fruit'
-
-await node1.pubsub.subscribe(topic, (msg) => {
-  console.log(`node1 received: ${msg.data.toString()}`)
-})
-
-await node2.pubsub.subscribe(topic, (msg) => {
-  console.log(`node2 received: ${msg.data.toString()}`)
-})
-
-await node3.pubsub.subscribe(topic, (msg) => {
-  console.log(`node3 received: ${msg.data.toString()}`)
-})
-```
-Finally, let's define the additional filter in the fruit topic.
-
-```JavaScript
-const validateFruit = (msgTopic, peer, msg) => {
-  const fruit = msg.data.toString();
-  const validFruit = ['banana', 'apple', 'orange']
-  const valid = validFruit.includes(fruit);
-  return valid;
-}
-
-node1.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-node2.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-node3.pubsub._pubsub.topicValidators.set(topic, validateFruit);
-```
-
-In this example, node one has an outdated version of the system, or is a malicious node. When it tries to publish fruit, the messages are re-shared and all the nodes share the message. However, when it tries to publish a vehicle the message is not re-shared.
-
-```JavaScript
-var count = 0;
-const myFruits = ['banana', 'apple', 'car', 'orange'];
-
-setInterval(() => {
-  console.log('############## fruit ' + myFruits[count] + ' ##############')
-  node1.pubsub.publish(topic, Buffer.from(myFruits[count]))
-  count++
-  if (count == myFruits.length) {
-    count = 0
-  }
-}, 5000)
-```
-
-Result
-
-```
-> node 1.js
-############## fruit banana ##############
-node1 received: banana
-node2 received: banana
-node3 received: banana
-############## fruit apple ##############
-node1 received: apple
-node2 received: apple
-node3 received: apple
-############## fruit car ##############
-node1 received: car
-############## fruit orange ##############
-node1 received: orange
-node2 received: orange
-node3 received: orange
-```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.28.9",
+  "version": "0.28.7",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -58,7 +58,7 @@
     "it-length-prefixed": "^3.0.1",
     "it-pipe": "^1.1.0",
     "it-protocol-buffers": "^0.2.0",
-    "libp2p-crypto": "^0.17.8",
+    "libp2p-crypto": "^0.17.6",
     "libp2p-interfaces": "^0.3.1",
     "libp2p-utils": "^0.1.2",
     "mafmt": "^7.0.0",

src/identify/consts.js

@@ -1,8 +1,6 @@
 'use strict'
 
-const libp2pVersion = require('../../package.json').version
-
 module.exports.PROTOCOL_VERSION = 'ipfs/0.1.0'
-module.exports.AGENT_VERSION = `js-libp2p/${libp2pVersion}`
+module.exports.AGENT_VERSION = 'js-libp2p/0.1.0'
 module.exports.MULTICODEC_IDENTIFY = '/ipfs/id/1.0.0'
 module.exports.MULTICODEC_IDENTIFY_PUSH = '/ipfs/id/push/1.0.0'

src/identify/index.js

@@ -175,7 +175,6 @@ class IdentifyService {
     // Update peers data in PeerStore
     this.peerStore.addressBook.set(id, listenAddrs.map((addr) => multiaddr(addr)))
     this.peerStore.protoBook.set(id, protocols)
-    this.peerStore.metadataBook.set(id, 'AgentVersion', Buffer.from(message.agentVersion))
 
     // TODO: Track our observed address so that we can score it
     log('received observed address of %s', observedAddr)

src/index.js

@@ -324,7 +324,7 @@ class Libp2p extends EventEmitter {
    * @returns {Promise<Connection|*>}
    */
   async dialProtocol (peer, protocols, options) {
-    const { id, multiaddrs } = getPeer(peer)
+    const { id, multiaddrs } = getPeer(peer, this.peerStore)
     let connection = this.connectionManager.get(id)
 
     if (!connection) {
@@ -396,12 +396,7 @@ class Libp2p extends EventEmitter {
    * @returns {Promise<number>}
    */
   ping (peer) {
-    const { id, multiaddrs } = getPeer(peer)
-
-    // If received multiaddr, ping it
-    if (multiaddrs) {
-      return ping(this, multiaddrs[0])
-    }
+    const { id } = getPeer(peer)
 
     return ping(this, id)
   }

src/ping/index.js

@@ -15,11 +15,11 @@ const { PROTOCOL, PING_LENGTH } = require('./constants')
 /**
  * Ping a given peer and wait for its response, getting the operation latency.
  * @param {Libp2p} node
- * @param {PeerId|multiaddr} peer
+ * @param {PeerId} peer
  * @returns {Promise<Number>}
  */
 async function ping (node, peer) {
-  log('dialing %s to %s', PROTOCOL, peer.toB58String ? peer.toB58String() : peer)
+  log('dialing %s to %s', PROTOCOL, peer.toB58String())
 
   const { stream } = await node.dialProtocol(peer, PROTOCOL)
 

test/core/ping.node.js

@@ -17,7 +17,7 @@ describe('ping', () => {
 
   beforeEach(async () => {
     nodes = await peerUtils.createPeer({
-      number: 3,
+      number: 2,
       config: baseOptions
     })
 
@@ -25,14 +25,7 @@ describe('ping', () => {
     nodes[1].peerStore.addressBook.set(nodes[0].peerId, nodes[0].multiaddrs)
   })
 
-  it('ping once from peer0 to peer1 using a multiaddr', async () => {
-    const ma = `${nodes[2].multiaddrs[0]}/p2p/${nodes[2].peerId.toB58String()}`
-    const latency = await nodes[0].ping(ma)
-
-    expect(latency).to.be.a('Number')
-  })
-
-  it('ping once from peer0 to peer1 using a peerId', async () => {
+  it('ping once from peer0 to peer1', async () => {
     const latency = await nodes[0].ping(nodes[1].peerId)
 
     expect(latency).to.be.a('Number')

test/identify/index.spec.js

@@ -19,7 +19,6 @@ const { IdentifyService, multicodecs } = require('../../src/identify')
 const Peers = require('../fixtures/peers')
 const Libp2p = require('../../src')
 const baseOptions = require('../utils/base-options.browser')
-const pkg = require('../../package.json')
 
 const { MULTIADDRS_WEBSOCKETS } = require('../fixtures/browser')
 const remoteAddr = MULTIADDRS_WEBSOCKETS[0]
@@ -54,9 +53,6 @@ describe('Identify', () => {
           },
           protoBook: {
             set: () => { }
-          },
-          metadataBook: {
-            set: () => { }
           }
         },
         multiaddrs: []
@@ -81,7 +77,6 @@ describe('Identify', () => {
 
     sinon.spy(localIdentify.peerStore.addressBook, 'set')
     sinon.spy(localIdentify.peerStore.protoBook, 'set')
-    sinon.spy(localIdentify.peerStore.metadataBook, 'set')
 
     // Run identify
     await Promise.all([
@@ -95,12 +90,6 @@ describe('Identify', () => {
 
     expect(localIdentify.peerStore.addressBook.set.callCount).to.equal(1)
     expect(localIdentify.peerStore.protoBook.set.callCount).to.equal(1)
-
-    const metadataArgs = localIdentify.peerStore.metadataBook.set.firstCall.args
-    expect(metadataArgs[0].id.bytes).to.equal(remotePeer.bytes)
-    expect(metadataArgs[1]).to.equal('AgentVersion')
-    expect(metadataArgs[2].toString()).to.equal(`js-libp2p/${pkg.version}`)
-
     // Validate the remote peer gets updated in the peer store
     const call = localIdentify.peerStore.addressBook.set.firstCall
     expect(call.args[0].id.bytes).to.equal(remotePeer.bytes)