1.0.0 • Published 4 years ago

superzone v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Superzone

A modular distributed networking stack for Peer to Peer (P2P) communication

Note: :exclamation::alembic: This is the next branch of superzone, meaning unstable features breaking changes and more will be pushed to this branch!

This is a modular networking stack for cummincating with distributed peers without a central server ( Peer to Peer ). The projects aims to make fast, decentral and secure commmunication possible.

Install it with yarn

yarn add superzone

Or if you want to use npm

npm install superzone

Usage

Typescript / es6

import { Server } from 'superzone'

const server = new Server()

server.on('peer', peer => {
  // we connected to a peer
})
server.on('disconnection', peer => {
  // a peer disconnected
})

await server.join('My super awesome topic') // Join the topic to find other peers

You can see more examples in the examples folder

TODO:

This is the list of features we have already completed and features we need to work on

  • Message encoding ( uses messagePack )
  • Deduplication and Handshake
  • Multiple topics
  • Complete modularity
  • Compression
  • Encryption
  • Banning peers
  • Pubsub
  • Query peers for information
  • MAYBE: Data replication between peers