Socket
Book a DemoInstallSign in
Socket

@dao-xyz/ipfs-pubsub-direct-channel

Package Overview
Dependencies
Maintainers
1
Versions
31
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@dao-xyz/ipfs-pubsub-direct-channel

1-to-1 communication channel over IPFS Pubsub between two peers

latest
npmnpm
Version
0.0.40
Version published
Weekly downloads
7
600%
Maintainers
1
Weekly downloads
 
Created
Source

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

Keywords

ipfs

FAQs

Package last updated on 08 Dec 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts