js-libp2p-gossipsub

Lead Maintainer

Specs
Install
Usage
API
Contribute
License

Specs

Gossipsub is an implementation of pubsub based on meshsub and floodsub. You can read the specification here.

Install

npm install libp2p-gossipsub

Usage

const Gossipsub = require('libp2p-gossipsub')

const registrar = {
  handle: (multicodecs, handle) => {
    // register multicodec to libp2p
    // handle function is called everytime a remote peer opens a stream to the peer.
  },
  register: (multicodecs, handlers) => {
    // handlers will be used to notify pubsub of peer connection establishment or closing
  },
  unregister: (id) => {

  }
}

const gsub = new Gossipsub(peerInfo, registrar, options)

await gsub.start()

gsub.on('fruit', (data) => {
  console.log(data)
})
gsub.subscribe('fruit')

gsub.publish('fruit', new Buffer('banana'))

API

Create a gossipsub implementation

const options = {…}
const gossipsub = new Gossipsub(peerInfo, registrar, options)

Options is an optional object with the following key-value pairs:

fallbackToFloodsub: boolean identifying whether the node should fallback to the floodsub protocol, if another connecting peer does not support gossipsub (defaults to true).
emitSelf: boolean identifying whether the node should emit to self on publish, in the event of the topic being subscribed (defaults to false).

For the remaining API, see https://github.com/libp2p/js-libp2p-pubsub

Contribute

This module is actively under development. Please check out the issues and submit PRs!

js-libp2p-gossipsub

Lead Maintainer

Table of Contents

Specs

Install

Usage

API

Create a gossipsub implementation

Contribute

License

Current Tags

50 Versions