0.1.0 • Published 1 year ago

ipfs-pubsub-1on1 v0.1.0

Weekly downloads
848
License
MIT
Repository
-
Last release
1 year ago

ipfs-pubsub-1on1

Communication channel between two peers over IPFS Pubsub

Work in progress!

ipfs-pubsub-1on1 is a 1-to-1 communication channel over IPFS Pubsub. It enables two peers to exchange messages between each other. Note that the channel is currently not authenticated nor encrypted!

Usage

// Include as lib
import Channel from 'ipfs-pubsub-1on1'
// Create IPFS instance somehow
const ipfs = new IPFS()
// IPFS peer ID of the peer to connect to
const friendId = 'QmP9TWCAsHLs6a3hcCbqE6WZs3VhQF6QsmkFPAFmmcuMa6'
// Open a channel with the other peer
const channel = await Channel.open(ipfs, friendId)
// Explicitly wait for peers to connect
await channel.connect()
// Send message on the channel
await channel.send('Hello World!')
// Process messages from the other peer
channel.on('message', (message) => {
  console.log('Message from', message.from, message)
})

For more usage examples, see the tests