@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, DirectChat, createLibP2P, Message, MessageDirect } 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}: Message) => {
  console.log('New message from ', peer, ' content ', data)
})

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

const directChat = DirectChat.getDirectChat(libp2p)

directChat.on('message', ({from, to, data}: MessageDirect) => {
  console.log('New direct message from ', peer, ' to ', to, ' content ', data)
})

API

const libp2p = await createLibP2P()

const room = createRoom(libp2p, topic) // Creates room with specific topic

// Methods
room.leave() // Leave the room
async room.broadcast(message: string | buffer) // Send message to the room

// Getters
room.peerId
room.peers
room.hasPeer(peerId: string)
room.libp2p

// Listeners
room.on('peer:joined', (peerId: string) => {})
room.on('peer:left', (peerId: string) => {})
room.on('message', (message: Message) => {})
room.on('unsubscribed', () => {})
room.on('error', (error: Error) => {})

const directChat = DirectChat.getDirectChat(libp2p)

// Methods
directChat.sendTo('somePeerId', {level: 'info', msg: 'hello world with custom object'})

// Listeners
directChat.on('message', (message: MessageDirect) => {})
directChat.on('error', (error: Error) => {})

License

MIT

Changelog

0.1.0-dev.9 (2020-09-22)

Chores

• export directmessage type (#40) (e166a51)

BREAKING CHANGES

• Rename of MessageDirect interface to DirectMessage

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