@libp2p/pubsub

libp2p pubsub base class

About

A set of components to be extended in order to create a pubsub implementation.

Example

import { PubSubBaseProtocol } from '@libp2p/pubsub'
import type { PubSubRPC, PublishResult, PubSubRPCMessage, PeerId, Message } from '@libp2p/interface'
import type { Uint8ArrayList } from 'uint8arraylist'

class MyPubsubImplementation extends PubSubBaseProtocol {
  decodeRpc (bytes: Uint8Array | Uint8ArrayList): PubSubRPC {
    throw new Error('Not implemented')
  }

  encodeRpc (rpc: PubSubRPC): Uint8Array {
    throw new Error('Not implemented')
  }

  encodeMessage (rpc: PubSubRPCMessage): Uint8Array {
    throw new Error('Not implemented')
  }

  async publishMessage (sender: PeerId, message: Message): Promise<PublishResult> {
    throw new Error('Not implemented')
  }
}
Copy

Install

$ npm i @libp2p/pubsub
Copy

Browser <script> tag

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

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

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_pubsub.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.