@dao-xyz/libp2p-pubsub-direct-channel
TypeScript icon, indicating that this package has built-in type declarations

0.0.45 • Public • Published

ipfs-pubsub-direct-channel

Communication channel between two peers over IPFS Pubsub

Work in progress!

ipfs-pubsub-direct-channel 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
const Channel = require('ipfs-pubsub-direct-channel')
// 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

Readme

Keywords

Package Sidebar

Install

npm i @dao-xyz/libp2p-pubsub-direct-channel

Weekly Downloads

24

Version

0.0.45

License

MIT

Unpacked Size

42.7 kB

Total Files

20

Last publish

Collaborators

  • marcus.pousette