@rsksmart/rif-communications-pubsub

RIF Communications PubSub

Library for creating a PubSub room with libp2p

This project extends the ipfs-pubsub-room, rewriting it in typescript and adding libp2p node.

Table of Contents

• Install
• Usage
• API
• License

Install

npm

> npm install @rsksmart/rif-communications-pubsub

WARNING: This package still have not been released!

Usage

Example of usage:

import { Room, createLibP2P } from '@rsksmart/rif-communications-pubsub'

const libp2p = await createLibP2P()
const room = createRoom(libp2p, 'my_topic')

room.on('peer:joined', (peer: string) => {
  console.log('Peer joined the room ', peer)
})

room.on('peer:left', (peer: string) => {
  console.log('Peer left the room', peer)
})

room.on('message', ({from, data}: {from: string, data: Buffer}) => {
  console.log('New message from ', peer, ' content ', data)
})

room.on('unsubscribed', () => {
  console.log('Unsubscribed from the room room')
})

API

const libp2p = await createLibP2P()

const room = createRoom(libp2p, topic) // Creates room with specific topic
room.leave() // Leave the room, stop libp2p
async room.broadcast(message: string | buffer) // Send message to the room

room.peerId
room.peers
room.hasPeer(cid: string)

room.on('peer:joined', (cid: string) => {})
room.on('peer:left', (cid: string) => {})
room.on('message', (message: {from: string, data: Buffer, to?: string}) => {})
room.on('unsubscribed', () => {})

License

MIT

Changelog

0.1.0-dev.6 (2020-08-19)

Features

• ignore self message option (f539aae)
• jsonseriazable messages (0b3ee3b)

<a name="0.1.0-dev.5"></a>