moose-team / friends-swarm Goto Github PK

View Code? Open in Web Editor NEW

32.0 10.0 6.0 21 KB

:bee: a webrtc-swarm with friends

License: MIT License

JavaScript 100.00%

friends-swarm's Introduction

friends-swarm

🐝 webrtc-swarm with friends

Install

npm install friends-swarm

Usage

var friendsSwarm = require('friends-swarm')

Contributing

Contributions welcome! Please read the contributing guidelines first.

License

ISC

friends-swarm's People

Contributors

Stargazers

Watchers

Forkers

rtc-alex l3dlp-sandbox guijun noclouds boymechanicus tungluu18

friends-swarm's Issues

Swap out hyperlog for hypercore: selective replication

This is a non-trivial change, but eventually it'd be great to see Friends using hypercore.

It offers one particular "killer feature" that'd be of great use to Friends, which is selective replication. Hyperlog forces complete replication of a data set, which, for chat, is almost never desirable: you don't want to download 100% of a channel's chat history when you join; you want just the last N messages. Hypercore provides this while still keeping the crypto guarantees on data integrity.

The big caveat is that hypercore doesn't handle many cross-referencing append-only logs like hyperlog does. A great module for someone to build out would be hyperlog-hypercore or hyperlog2: a module that provides hyperlog's API, but is powered by hypercore underneath.

Write some kind of tests

This could be tricky! how can this be tested?

Peer network

Hey!

I've been thinking about how to solve the problem of a peer-to-peer group chat between a significant number of users without overloading the network: if I'm in a room with 1000 people, I don't want my browser to open 999 connections.

If I'm understanding the code correctly, does friends just open a connection to every other peer like I just described?

friends-swarm/swarm.js

Lines 100 to 120 in 02bc0e1

 sw.on('peer', function (p, id) { 

 var stream = log.replicate({live: true}) 

 log.peers.push(p) 

 p.on('close', function () { 

 var i = log.peers.indexOf(p) 

 if (i > -1) log.peers.splice(i, 1) 

 }) 

 swarm.emit('peer', p, name, id, stream) 

 stream.on('push', function () { 

 swarm.emit('push', name) 

 }) 

 stream.on('pull', function () { 

 swarm.emit('pull', name) 

 }) 

 p.pipe(stream).pipe(p) 

 })

This feels like it's going to be a super interesting problem to solve: have any of you thought about it before or know anything about the topic?

Pass in signalhub URLs as an option

We should add an option when creating a friends-swarm to override the official friends signalhubs.

Should we remove the hardcoded signalhubs altogether and modify friends to pass in its hubs?

friends-swarm -> friends-db + friends-swarm

It'd be helpful to see the core p2p database part of this module broken out into its own module, with friends-swarm layered on top. friends-db then could just expose db ops and generic replication streams that would allow for additional, non-webrtc transports too.

have a demo?

the code :
"var friendsSwarm = require('friends-swarm')" is
too simple, please show us full example so that we can understand it .

Thanks

	sw.on('peer', function (p, id) {
	var stream = log.replicate({live: true})

	log.peers.push(p)
	p.on('close', function () {
	var i = log.peers.indexOf(p)
	if (i > -1) log.peers.splice(i, 1)
	})

	swarm.emit('peer', p, name, id, stream)

	stream.on('push', function () {
	swarm.emit('push', name)
	})

	stream.on('pull', function () {
	swarm.emit('pull', name)
	})

	p.pipe(stream).pipe(p)
	})