@libp2p/floodsub

libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network).

About

Don't use this module

This module is a naive implementation of pubsub. It broadcasts all messages to all network peers, cannot provide older messages and has no protection against bad actors.

It exists for academic purposes only, you should not use it in production.

Instead please use gossipsub - a more complete implementation which is also compatible with floodsub.

Example - Configuring libp2p to use floodsub

import { createLibp2p } from 'libp2p'
import { floodsub } from '@libp2p/floodsub'

const node = await createLibp2p({
  services: {
    pubsub: floodsub()
  }
  //... other options
})
await node.start()

node.services.pubsub.subscribe('fruit')
node.services.pubsub.addEventListener('message', (evt) => {
  console.log(evt)
})

node.services.pubsub.publish('fruit', new TextEncoder().encode('banana'))
Copy

Install

$ npm i @libp2p/floodsub
Copy

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pFloodsub in the global namespace.

<script src="https://unpkg.com/@libp2p/floodsub/dist/index.min.js"></script>
Copy

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_floodsub.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.