@libp2p/pubsub

libp2p pubsub base class

Usage no npm install needed!

<script type="module">
  import libp2pPubsub from 'https://cdn.skypack.dev/@libp2p/pubsub';
</script>

README

libp2p-pubsub

Contains an implementation of the Pubsub interface

Table of contents

Usage

npm i libp2p-pubsub
import { PubsubBaseProtocol } from '@libp2p/pubsub'

class MyPubsubImplementation extends PubsubBaseProtocol {
  // .. extra methods here
}

Contribute

The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:

  • Go through the modules and check out existing issues. This would be especially useful for modules in active development. Some knowledge of IPFS/libp2p may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
  • Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
  • Add tests. There can never be enough tests.

License

Apache-2.0 or MIT © Protocol Labs