jacobheun feat: make libp2p a state machine (#257)
* docs: add events to readme
Latest commit 0b75f99 Oct 19, 2018
Permalink
..
Failed to load latest commit information.
1.js feat: make libp2p a state machine (#257) Oct 19, 2018
README.md docs: fix pubsub example, solves #167 Feb 22, 2018

README.md

Publish Subscribe

Publish Subscribe is also included on the stack. Currently, we have on PubSub implementation which we ship by default libp2p-floodsub, with many more being researched at research-pubsub.

We've seen many interesting use cases appear with this, here are some highlights:

1. Setting up a simple PubSub network on top of libp2p

For this example, we will use MulticastDNS for automatic Peer Discovery. This example is based the previous examples found in Discovery Mechanisms. You can find the complete version at 1.js.

Using PubSub is super simple, all you have to do is start a libp2p node, PubSub will be enabled by default.

series([
  (cb) => node1.once('peer:discovery', (peer) => node1.dial(peer, cb)),
  (cb) => setTimeout(cb, 500)
], (err) => {
  if (err) { throw err }

  // Subscribe to the topic 'news'
  node1.pubsub.subscribe('news',
    (msg) => console.log(msg.from, msg.data.toString()),
    () => {
      setInterval(() => {
        // Publish the message on topic 'news'
        node2.pubsub.publish(
          'news',
          Buffer.from('Bird bird bird, bird is the word!'),
          () => {}
        )
      }, 1000)
    }
  )
})

The output of the program should look like:

> node 1.js
QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!
QmWpvkKm6qHLhoxpWrTswY6UMNWDyn8hN265Qp9ZYvgS82 Bird bird bird, bird is the word!

2. Future work

libp2p/IPFS PubSub is enabling a whole set of Distributed Real Time applications using CRDT (Conflict-Free Replicated Data Types). It is still going through heavy research (and hacking) and we invite you to join the conversation at research-CRDT. Here is a list of some of the exciting examples: