A flooding 'pubsub' system.
Latest commit 7560d63 Sep 17, 2018

README.md

go-floodsub

A flooding pubsub system.

PubSub is a work in progress, with floodsub as an initial protocol, followed by gossipsub, which is an alpha release as of May 2018.

Table of Contents

Install

go get github.com/libp2p/go-floodsub

Usage

TODO

Implementations

See this issue for an introduction to pubsub, gossipsub and floodsub, which is in the repo for go-floodsub. A PR for gossipsub with Go is here; see gerbil-simsub for a high-level literate specification, as well as the libp2p spec for gossipsub.

The rust-libp2p implementation of floodsub is here. Work is in progress on a gossipsub implementation for Rust with @jamesray1 from Drops of Diamond (which is developing sharding for Ethereum).

Here is a Javascript implementation of floodsub.

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Jeromy Johnson