libp2p/js-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).

📁 Archived - this module has been merged into js-libp2p

@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).

Table of contents

• Install
  • Browser <script> tag
• Don't use this module
• Usage
• License
• Contribution

Install

$ npm i @libp2p/floodsub

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>

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.

Usage

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

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

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

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

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.